ch.jalu.configme.resource

Class YamlFileReader

java.lang.Object

ch.jalu.configme.resource.YamlFileReader

All Implemented Interfaces:

PropertyReader

public class YamlFileReader
extends Object
implements PropertyReader

YAML file reader.

Constructor Summary

Constructors

Constructor and Description
YamlFileReader(File file) Constructor.
YamlFileReader(File file, Charset charset)

Method Summary

Modifier and Type	Method and Description
boolean	contains(String path) Returns whether a value is present for the given path.
Boolean	getBoolean(String path) Returns the value of the given path as a boolean if available.
Double	getDouble(String path) Returns the value of the given path as a double if available.
protected File	getFile()
Integer	getInt(String path) Returns the value of the given path as an integer if available.
Set<String>	getKeys(boolean onlyLeafNodes) Returns the keys available in the file.
List<?>	getList(String path) Returns the value of the given path as a list if available.
Object	getObject(String path) Returns the object at the given path, or null if absent.
protected Map<String,Object>	getRoot()
String	getString(String path) Returns the value of the given path as a String if available.
protected <T> T	getTypedObject(String path, Class<T> clazz) Gets the object at the given path and safely casts it to the given class' type.
protected Map<String,Object>	loadFile() Loads the values of the file.

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlFileReader

public YamlFileReader(File file)

Constructor.

Parameters:

file - the file to load

YamlFileReader

public YamlFileReader(File file,
                      Charset charset)

Method Detail

getObject

public Object getObject(String path)

Description copied from interface: PropertyReader

Returns the object at the given path, or null if absent.

Specified by:

getObject in interface PropertyReader

Parameters:

path - the path to retrieve the value for

Returns:

the value, or null if there is none

getString

public String getString(String path)

Description copied from interface: PropertyReader

Returns the value of the given path as a String if available.

Specified by:

getString in interface PropertyReader

Parameters:

path - the path to retrieve a String for

Returns:

the value as a String, or null if not applicable or unavailable

getInt

public Integer getInt(String path)

Description copied from interface: PropertyReader

Returns the value of the given path as an integer if available.

Specified by:

getInt in interface PropertyReader

Parameters:

path - the path to retrieve an integer for

Returns:

the value as integer, or null if not applicable or unavailable

getDouble

public Double getDouble(String path)

Description copied from interface: PropertyReader

Returns the value of the given path as a double if available.

Specified by:

getDouble in interface PropertyReader

Parameters:

path - the path to retrieve a double for

Returns:

the value as a double, or null if not applicable or unavailable

getBoolean

public Boolean getBoolean(String path)

Description copied from interface: PropertyReader

Returns the value of the given path as a boolean if available.

Specified by:

getBoolean in interface PropertyReader

Parameters:

path - the path to retrieve a boolean for

Returns:

the value as a boolean, or null if not applicable or unavailable

getList

public List<?> getList(String path)

Description copied from interface: PropertyReader

Returns the value of the given path as a list if available.

Specified by:

getList in interface PropertyReader

Parameters:

path - the path to retrieve a list for

Returns:

the value as a list, or null if not applicable or unavailable

contains

public boolean contains(String path)

Description copied from interface: PropertyReader

Returns whether a value is present for the given path. When applicable, Property.isPresent(PropertyReader) should be favored over calling this method as it may make more type-aware checks. This method simply returns whether some value exists under the given path.

Specified by:

contains in interface PropertyReader

Parameters:

path - the path to check

Returns:

true if there is a value, false otherwise

getKeys

public Set<String> getKeys(boolean onlyLeafNodes)

Description copied from interface: PropertyReader

Returns the keys available in the file. Depending on the parameter either all keys are returned, or only the keys of the leaf nodes are considered.

Specified by:

getKeys in interface PropertyReader

Parameters:

onlyLeafNodes - true if only the paths of leaf nodes should be returned (no intermediate paths)

Returns:

set of all existing keys (ordered)

loadFile

protected Map<String,Object> loadFile()

Loads the values of the file.

Returns:

map with the values from the file

getFile

protected final File getFile()

getRoot

protected final Map<String,Object> getRoot()

getTypedObject

@Nullable
protected <T> T getTypedObject(String path,
                                         Class<T> clazz)

Gets the object at the given path and safely casts it to the given class' type. Returns null if no value is available or if it cannot be cast.

Type Parameters:

T - the class type

Parameters:

path - the path to retrieve

clazz - the class to cast to

Returns:

cast value at the given path, null if not applicable