JavaSteam/in.dragonbra.javasteam.types/KeyValue

KeyValue

class KeyValue @JvmOverloads constructor(var name: String? = null, var value: String? = null)

Represents a recursive string key to arbitrary value container.

Parameters

name

The optional name of the root key.

value

The optional value assigned to the root key.

Constructors

KeyValue

@JvmOverloads

constructor(name: String? = null, value: String? = null)

Initializes a new instance of the class.

Types

Companion

object Companion

Properties

children

var children: MutableList<KeyValue>

Gets the children of this instance.

name

var name: String?

Gets or sets the name of this instance.

value

var value: String?

Gets or sets the value of this instance.

Functions

asBoolean

@JvmOverloads

fun asBoolean(defaultValue: Boolean = false): Boolean

Attempts to convert and return the value of this instance as a boolean. If the conversion is invalid, the default value is returned.

asByte

@JvmOverloads

fun asByte(defaultValue: Byte = 0): Byte

Attempts to convert and return the value of this instance as a byte. If the conversion is invalid, the default value is returned.

asEnum

fun <T : Enum<T>> asEnum(enumClass: Class<T>, defaultValue: T): EnumSet<T>

fun <T : Enum<T>> asEnum(enumClass: Class<T>, defaultValue: EnumSet<T>): EnumSet<T>

Attempts to convert and return the value of this instance as an enum. If the conversion is invalid, the default value is returned.

asFloat

@JvmOverloads

fun asFloat(defaultValue: Float = 0.0f): Float

Attempts to convert and return the value of this instance as a float. If the conversion is invalid, the default value is returned.

asInteger

@JvmOverloads

fun asInteger(defaultValue: Int = 0): Int

Attempts to convert and return the value of this instance as an integer. If the conversion is invalid, the default value is returned.

asLong

@JvmOverloads

fun asLong(defaultValue: Long = 0): Long

Attempts to convert and return the value of this instance as a long. If the conversion is invalid, the default value is returned.

asShort

@JvmOverloads

fun asShort(defaultValue: Short = 0): Short

Attempts to convert and return the value of this instance as a short. If the conversion is invalid, the default value is returned.

asString

fun asString(): String?

Returns the value of this instance as a string.

asUnsignedByte

@JvmOverloads

fun asUnsignedByte(defaultValue: UByte): UByte

Attempts to convert and return the value of this instance as an unsigned byte. If the conversion is invalid, the default value is returned.

asUnsignedInteger

@JvmOverloads

fun asUnsignedInteger(defaultValue: UInt): UInt

Attempts to convert and return the value of this instance as an unsigned integer. If the conversion is invalid, the default value is returned.

asUnsignedLong

@JvmOverloads

fun asUnsignedLong(defaultValue: ULong): ULong

Attempts to convert and return the value of this instance as an unsigned long. If the conversion is invalid, the default value is returned.

asUnsignedShort

@JvmOverloads

fun asUnsignedShort(defaultValue: UShort): UShort

Attempts to convert and return the value of this instance as an unsigned short. If the conversion is invalid, the default value is returned.

get

operator fun get(key: String): KeyValue

Gets the child KeyValue with the specified key. If no child with the given key exists, KeyValue.INVALID is returned.

readAsText

fun readAsText(input: InputStream): Boolean

Populate this instance from the given InputStream as a text KeyValue.

readFileAsText

fun readFileAsText(filename: String): Boolean

Opens and reads the given filename as text.

saveToFile

fun saveToFile(file: File, asBinary: Boolean)

fun saveToFile(path: String, asBinary: Boolean)

Saves this instance to file.

saveToStream

fun saveToStream(stream: OutputStream, asBinary: Boolean)

Saves this instance to a given OutputStream

set

operator fun set(key: String, value: KeyValue)

toString

open override fun toString(): String

Returns a String that represents this instance.

tryReadAsBinary

fun tryReadAsBinary(input: InputStream): Boolean

Populate this instance from the given InputStream as a binary KeyValue.