uk.co.thomasc.steamkit.types.keyvalue

Class KeyValue

java.lang.Object

uk.co.thomasc.steamkit.types.keyvalue.KeyValue

public class KeyValue
extends Object

Represents a recursive string key to arbitrary value container.

Field Summary

Fields

Modifier and Type	Field and Description
private List<KeyValue>	children Gets the children of this instance.
static KeyValue	Invalid Represents an invalid KeyValue given when a searched for child does not exist.
String	name Gets or sets the name of this instance.
String	value Gets or sets the value of this instance.

Constructor Summary

Constructors

Constructor and Description
KeyValue()
KeyValue(String name)
KeyValue(String name, String value) Initializes a new instance of the KeyValue class.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	asBoolean() Attempts to convert and return the value of this instance as a boolean.
float	asFloat()
float	asFloat(float defaultValue) Attempts to convert and return the value of this instance as a float.
int	asInteger()
int	asInteger(int defaultValue) Attempts to convert and return the value of this instance as an integer.
long	asLong()
long	asLong(long defaultValue) Attempts to convert and return the value of this instance as a long.
String	asString() Returns the value of this instance as a string.
KeyValue	get(String key) Gets the child KeyValue with the specified key.
static KeyValue	loadAsBinary(String path) Attempts to load the given filename as a binary KeyValue.
static KeyValue	loadAsText(String path) Attempts to load the given filename as a text KeyValue.
(package private) static KeyValue	loadFromFile(String path, boolean asBinary)
static KeyValue	loadFromString(String input) Attempts to create an instance of KeyValue from the given input text.
boolean	readAsBinary(BinaryReader input) Populate this instance from the given BinaryReader as a binary KeyValue.
boolean	readAsText(InputStream input) Populate this instance from the given InputStream as a text KeyValue.
boolean	readFileAsText(String filename) Opens and reads the given filename as text.
static String	readNullTermString(InputStream in)
void	recursiveLoadFromBuffer(KVTextReader kvr)
private void	recursiveSaveToFile(FileOutputStream f)
private void	recursiveSaveToFile(FileOutputStream f, int indentLevel)
void	saveToFile(String path, boolean asBinary) Saves this instance to file.
String	toString() Returns a String that represents this instance.
private void	writeIndents(FileOutputStream f, int indentLevel)
private static void	writeString(FileOutputStream f, String str)
private static void	writeString(FileOutputStream f, String str, boolean quote)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

Invalid

public static final KeyValue Invalid

Represents an invalid KeyValue given when a searched for child does not exist.

name

public String name

Gets or sets the name of this instance.

value

public String value

Gets or sets the value of this instance.

children

private List<KeyValue> children

Gets the children of this instance.

Constructor Detail

KeyValue

public KeyValue(String name,
        String value)

Initializes a new instance of the KeyValue class.

Parameters:

name - The optional name of the root key.

value - The optional value assigned to the root key.

KeyValue

public KeyValue(String name)

KeyValue

public KeyValue()

Method Detail

get

public KeyValue get(String key)

Gets the child KeyValue with the specified key. If no child with this key exists, Invalid is returned.

asString

public String asString()

Returns the value of this instance as a string.

Returns:

The value of this instance as a string.

asInteger

public int asInteger(int defaultValue)

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

Parameters:

defaultValue - The default value to return if the conversion is invalid.

Returns:

The value of this instance as an integer.

asInteger

public int asInteger()

asLong

public long asLong(long defaultValue)

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

Parameters:

defaultValue - The default value to return if the conversion is invalid.

Returns:

The value of this instance as an long.

asLong

public long asLong()

asFloat

public float asFloat(float defaultValue)

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

Parameters:

defaultValue - The default value to return if the conversion is invalid.

Returns:

The value of this instance as an float.

asFloat

public float asFloat()

asBoolean

public boolean asBoolean()

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

Returns:

The value of this instance as an boolean.

toString

public String toString()

Returns a String that represents this instance.

Overrides:

toString in class Object

loadAsText

public static KeyValue loadAsText(String path)

Attempts to load the given filename as a text KeyValue. This method will swallow any exceptions that occur when reading, use readFileAsText(String) if you wish to handle exceptions.

Parameters:

path - The path to the file to load.

Returns:

a KeyValue instance if the load was successful, or null on failure.

loadAsBinary

public static KeyValue loadAsBinary(String path)

Attempts to load the given filename as a binary KeyValue. This method will swallow any exceptions that occur when reading, use readAsBinary(BinaryReader) if you wish to handle exceptions.

Parameters:

path - The path to the file to load.

Returns:

a KeyValue instance if the load was successful, or null on failure.

loadFromFile

static KeyValue loadFromFile(String path,
                    boolean asBinary)

loadFromString

public static KeyValue loadFromString(String input)

Attempts to create an instance of KeyValue from the given input text. This method will swallow any exceptions that occur when reading, use readAsText(InputStream) if you wish to handle exceptions.

Parameters:

input - The input text to load.

Returns:

a KeyValue instance if the load was successful, or null on failure.

readAsText

public boolean readAsText(InputStream input)
                   throws IOException

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

Parameters:

input - The input InputStream to read from.

Returns:

true if the read was successful; otherwise, false.

Throws:

IOException

readFileAsText

public boolean readFileAsText(String filename)
                       throws FileNotFoundException,
                              IOException

Opens and reads the given filename as text.

Parameters:

filename - The file to open and read.

Returns:

true if the read was successful; otherwise, false.

Throws:

{@link - FileNotFoundException} , IOException

FileNotFoundException

IOException

recursiveLoadFromBuffer

public void recursiveLoadFromBuffer(KVTextReader kvr)
                             throws IOException

Throws:

IOException

saveToFile

public void saveToFile(String path,
              boolean asBinary)

Saves this instance to file.

Parameters:

path - The file path to save to.

asBinary - If set to true, saves this instance as binary.

recursiveSaveToFile

private void recursiveSaveToFile(FileOutputStream f)
                          throws IOException

Throws:

IOException

recursiveSaveToFile

private void recursiveSaveToFile(FileOutputStream f,
                       int indentLevel)
                          throws IOException

Throws:

IOException

writeIndents

private void writeIndents(FileOutputStream f,
                int indentLevel)
                   throws IOException

Throws:

IOException

writeString

private static void writeString(FileOutputStream f,
               String str,
               boolean quote)
                         throws IOException

Throws:

IOException

writeString

private static void writeString(FileOutputStream f,
               String str)
                         throws IOException

Throws:

IOException

readNullTermString

public static String readNullTermString(InputStream in)
                                 throws IOException

Throws:

IOException

readAsBinary

public boolean readAsBinary(BinaryReader input)
                     throws IOException

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

Parameters:

input - The input BinaryReader to read from.

Returns:

true if the read was successful; otherwise, false.

Throws:

IOException