ch.jalu.configme.resource

Interface PropertyReader

All Known Implementing Classes:

YamlFileReader

public interface PropertyReader

Method Summary

Modifier and Type	Method and Description
boolean	contains(@NotNull String path) Returns whether a value is present for the given path.
@Nullable Boolean	getBoolean(@NotNull String path) Returns the value of the given path as a boolean if available.
@NotNull Set<String>	getChildKeys(@NotNull String path) Returns the direct children of the given path which are available in the file.
@Nullable Double	getDouble(@NotNull String path) Returns the value of the given path as a double if available.
@Nullable Integer	getInt(@NotNull String path) Returns the value of the given path as an integer if available.
@NotNull Set<String>	getKeys(boolean onlyLeafNodes) Returns the keys available in the file.
@Nullable List<?>	getList(@NotNull String path) Returns the value of the given path as a list if available.
@Nullable Object	getObject(@NotNull String path) Returns the object at the given path, or null if absent.
@Nullable String	getString(@NotNull String path) Returns the value of the given path as a String if available.

Method Detail

contains

boolean contains(@NotNull
                 @NotNull String path)

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

@NotNull
@NotNull 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)

getChildKeys

@NotNull
@NotNull Set<String> getChildKeys(@NotNull
                                           @NotNull String path)

Returns the direct children of the given path which are available in the file. Returns an empty set if the path does not exist in the file (never null).

Parameters:

path - the path whose direct child paths should be looked up

Returns:

set of all direct children (ordered, never null)

getObject

@Nullable
@Nullable Object getObject(@NotNull
                                     @NotNull 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
@Nullable String getString(@NotNull
                                     @NotNull 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
@Nullable Integer getInt(@NotNull
                                   @NotNull 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
@Nullable Double getDouble(@NotNull
                                     @NotNull 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
@Nullable Boolean getBoolean(@NotNull
                                       @NotNull 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
@Nullable List<?> getList(@NotNull
                                    @NotNull 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