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.

Method Summary

Modifier and Type	Method and Description
Object	getObject(String path) Returns the value for the given path, or null if not present.
<T> T	getTypedObject(String path, Class<T> clazz) Returns the value for the given path in a typed manner.
void	reload() Reloads the properties from the external source.
void	set(String path, Object value) Sets the value at the given path in memory.

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

Method Detail

getObject

public Object getObject(String path)

Description copied from interface: PropertyReader

Returns the value for the given path, or null if not present.

Specified by:

getObject in interface PropertyReader

Parameters:

path - the path to retrieve the value for

Returns:

the value, or null if not available

getTypedObject

public <T> T getTypedObject(String path,
                            Class<T> clazz)

Description copied from interface: PropertyReader

Returns the value for the given path in a typed manner. Returns null if no value is present or if the value does not match the requested type.

Specified by:

getTypedObject in interface PropertyReader

Type Parameters:

T - the class' type

Parameters:

path - the path to retrieve the value for

clazz - the class to cast the value to if possible

Returns:

the typed value, or null if unavailable or not applicable

set

public void set(String path,
                Object value)

Description copied from interface: PropertyReader

Sets the value at the given path in memory. This method does not persist any values to an external resource; this should only be done by PropertyResource.exportProperties(ch.jalu.configme.configurationdata.ConfigurationData).

Specified by:

set in interface PropertyReader

Parameters:

path - the path to set a value for

value - the value to set

reload

public void reload()

Description copied from interface: PropertyReader

Reloads the properties from the external source.

Specified by:

reload in interface PropertyReader