ch.jalu.configme.resource

Interface PropertyResource

All Known Implementing Classes:

YamlFileResource

public interface PropertyResource

Property resource; provides and exports properties.

Method Summary

Modifier and Type	Method and Description
boolean	contains(String path) Returns whether a value is present for the given path.
void	exportProperties(ConfigurationData configurationData) Exports the properties (e.g.
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.
Integer	getInt(String path) Returns the value of the given path as an integer if available.
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.
String	getString(String path) Returns the value of the given path as a String if available.
void	reload() Reloads the configuration, e.g.
void	setValue(String path, Object value) Sets the value for the given path.

Method Detail

getObject

@Nullable
Object getObject(String path)

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

Parameters:

path - the path to retrieve the value for

Returns:

the value, or null if there is none

getString

@Nullable
String getString(String path)

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

Parameters:

path - the path to retrieve a String for

Returns:

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

getInt

@Nullable
Integer getInt(String path)

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

Parameters:

path - the path to retrieve an integer for

Returns:

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

getDouble

@Nullable
Double getDouble(String path)

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

Parameters:

path - the path to retrieve a double for

Returns:

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

getBoolean

@Nullable
Boolean getBoolean(String path)

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

Parameters:

path - the path to retrieve a boolean for

Returns:

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

getList

@Nullable
List<?> getList(String path)

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

Parameters:

path - the path to retrieve a list for

Returns:

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

contains

boolean contains(String path)

Returns whether a value is present for the given path. When applicable, Property.isPresent(PropertyResource) 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.

Parameters:

path - the path to check

Returns:

true if there is a value, false otherwise

setValue

void setValue(String path,
              @Nullable
              Object value)

Sets the value for the given path. Only modifies the in-memory collection of loaded values. New values are only persisted after exportProperties(ConfigurationData) has been called.

Parameters:

path - the path to set a new value for

value - the value to set

reload

void reload()

Reloads the configuration, e.g. from a file.

exportProperties

void exportProperties(ConfigurationData configurationData)

Exports the properties (e.g. writes to a file).

Parameters:

configurationData - the configuration data