ru.abstractmenus.hocon.api

Interface ConfigNode

public interface ConfigNode

Method Summary

Modifier and Type	Method and Description
ConfigNode	child(java.lang.String key) Get child node by key
java.util.List<ConfigNode>	childrenList() Get list of children if node is list
java.util.Map<java.lang.String,ConfigNode>	childrenMap() Get map of children if node is map
default boolean	getBoolean() Get boolean value or false as default
boolean	getBoolean(boolean def) Get boolean value
default double	getDouble() Get double value or 0 as default
double	getDouble(double def) Get double value
default float	getFloat() Get float value or 0 as default
float	getFloat(float def) Get float value
default int	getInt() Get int value or 0 as default
int	getInt(int def) Get int value
<T> java.util.List<T>	getList(java.lang.Class<T> type) Get deserialized list of values
default long	getLong() Get long value or 0 as default
long	getLong(long def) Get long value
default java.lang.String	getString() Get String value or null as default
java.lang.String	getString(java.lang.String def) Get String value
default <T> T	getValue(java.lang.Class<T> type) Get deserialized value
<T> T	getValue(java.lang.Class<T> type, T def) Get deserialized value
boolean	hasChildren() Is ths node has children.
boolean	isList() Is this node a list
boolean	isMap() Is this node a map
boolean	isNull() Is this node a null
boolean	isPrimitive() Is this node a primitive (boolean, number, string)
java.lang.String	key() Get node key
ConfigNode	node(java.lang.String... path) Get child node by path
ConfigNode	parent() Get parent of this node
java.lang.String[]	path() Get path to this node
java.lang.Object	rawValue() Get raw native Java value
ru.abstractmenus.hocon.ConfigValue	wrapped() Get wrapped config value

Method Detail

wrapped

ru.abstractmenus.hocon.ConfigValue wrapped()

Get wrapped config value

Returns:

Wrapped value

key

java.lang.String key()

Get node key

Returns:

Node nke

path

java.lang.String[] path()

Get path to this node

Returns:

Path to this node

parent

ConfigNode parent()

Get parent of this node

Returns:

Parent of node or null if this is root node

node

ConfigNode node(java.lang.String... path)

Get child node by path

Parameters:

path - Relative path to child node

Returns:

Found or created node

child

ConfigNode child(java.lang.String key)

Get child node by key

Parameters:

key - Key of child node

Returns:

Found or created child node

hasChildren

boolean hasChildren()

Is ths node has children. Works with objects and lists

Returns:

true if node has children or false otherwise

isList

boolean isList()

Is this node a list

Returns:

true if node is list

isMap

boolean isMap()

Is this node a map

Returns:

true if node is map

isPrimitive

boolean isPrimitive()

Is this node a primitive (boolean, number, string)

Returns:

true if node is list

isNull

boolean isNull()

Is this node a null

Returns:

true if node is null

rawValue

java.lang.Object rawValue()

Get raw native Java value

Returns:

raw config value

getValue

default <T> T getValue(java.lang.Class<T> type)
                throws NodeSerializeException

Get deserialized value

Type Parameters:

T - Type of the value

Parameters:

type - Type of the value

Returns:

Deserialized value or null

Throws:

NodeSerializeException - in cases when object cannot be deserialized

getValue

<T> T getValue(java.lang.Class<T> type,
               T def)
        throws NodeSerializeException

Get deserialized value

Type Parameters:

T - Type of the value

Parameters:

type - Type of the value

def - default value returned if value absent

Returns:

Deserialized value or null

Throws:

NodeSerializeException - in cases when object cannot be deserialized

getList

<T> java.util.List<T> getList(java.lang.Class<T> type)
                       throws NodeSerializeException

Get deserialized list of values

Type Parameters:

T - Type of the value

Parameters:

type - Type of the value

Returns:

Deserialized list

Throws:

NodeSerializeException - in cases when object cannot be deserialized

childrenList

java.util.List<ConfigNode> childrenList()

Get list of children if node is list

Returns:

List of children

childrenMap

java.util.Map<java.lang.String,ConfigNode> childrenMap()

Get map of children if node is map

Returns:

Map of children

getBoolean

boolean getBoolean(boolean def)

Get boolean value

Parameters:

def - value that will be returned if node is null

Returns:

Boolean value

getBoolean

default boolean getBoolean()

Get boolean value or false as default

Returns:

Boolean value or false as default

getInt

int getInt(int def)

Get int value

Parameters:

def - value that will be returned if node is null

Returns:

int value

getInt

default int getInt()

Get int value or 0 as default

Returns:

int value or 0 as default

getLong

long getLong(long def)

Get long value

Parameters:

def - value that will be returned if node is null

Returns:

long value

getLong

default long getLong()

Get long value or 0 as default

Returns:

long value or 0 as default

getFloat

float getFloat(float def)

Get float value

Parameters:

def - value that will be returned if node is null

Returns:

float value

getFloat

default float getFloat()

Get float value or 0 as default

Returns:

float value or 0 as default

getDouble

double getDouble(double def)

Get double value

Parameters:

def - value that will be returned if node is null

Returns:

double value

getDouble

default double getDouble()

Get double value or 0 as default

Returns:

double value or 0 as default

getString

java.lang.String getString(java.lang.String def)

Get String value

Parameters:

def - value that will be returned if node is null

Returns:

String value

getString

default java.lang.String getString()

Get String value or null as default

Returns:

String value or null as default