ch.jalu.configme.resource

Interface PropertyReader

All Known Implementing Classes:

YamlFileReader

public interface PropertyReader

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.
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.
String	getString(String path) Returns the value of the given path as a String if available.

Method Detail

contains

boolean contains(String path)

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.

Parameters:

path - the path to check

Returns:

true if there is a value, false otherwise

getKeys

Set<String> getKeys(boolean onlyLeafNodes)

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.

Parameters:

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

Returns:

set of all existing keys (ordered)

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