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(@NotNull File file) Deprecated. scheduled for removal in favor of Path
YamlFileReader(@NotNull Path path) Constructor.
YamlFileReader(@NotNull Path path, @NotNull Charset charset) Constructor.
YamlFileReader(@NotNull Path path, @NotNull Charset charset, boolean splitDotPaths) Constructor.

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.
protected @NotNull File	getFile() Deprecated.
@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.
protected @NotNull Path	getPath()
protected @Nullable Map<String,Object>	getRoot() Deprecated. use getObject("") instead
@Nullable String	getString(@NotNull String path) Returns the value of the given path as a String if available.
protected <T> T	getTypedObject(@NotNull String path, @NotNull Class<T> clazz) Gets the object at the given path and safely casts it to the given class's type.
protected @Nullable Map<String,Object>	loadFile(boolean splitDotPaths) Loads the values of the file.
protected @Nullable Map<String,Object>	normalizeMap(@Nullable Map<Object,Object> map, boolean splitDotPaths) Processes the map as read from SnakeYAML and may return a new, adjusted one.

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlFileReader

public YamlFileReader(@NotNull
                      @NotNull Path path)

Constructor.

Parameters:

path - the file to load

YamlFileReader

public YamlFileReader(@NotNull
                      @NotNull Path path,
                      @NotNull
                      @NotNull Charset charset)

Constructor.

Parameters:

path - the file to load

charset - the charset to read the data as

YamlFileReader

public YamlFileReader(@NotNull
                      @NotNull Path path,
                      @NotNull
                      @NotNull Charset charset,
                      boolean splitDotPaths)

Constructor.

Parameters:

path - the file to load

charset - the charset to read the data as

splitDotPaths - whether dots in yaml paths should be split into nested paths

YamlFileReader

@Deprecated
public YamlFileReader(@NotNull
                                  @NotNull File file)

Deprecated. scheduled for removal in favor of Path

Constructor (legacy). Prefer the constructors taking Path.

Parameters:

file - the file to load

Method Detail

getObject

@Nullable
public @Nullable Object getObject(@NotNull
                                            @NotNull 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

@Nullable
public @Nullable String getString(@NotNull
                                            @NotNull 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

@Nullable
public @Nullable Integer getInt(@NotNull
                                          @NotNull 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

@Nullable
public @Nullable Double getDouble(@NotNull
                                            @NotNull 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

@Nullable
public @Nullable Boolean getBoolean(@NotNull
                                              @NotNull 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

@Nullable
public @Nullable List<?> getList(@NotNull
                                           @NotNull 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(@NotNull
                        @NotNull String path)

Description copied from interface: PropertyReader

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.

Specified by:

contains in interface PropertyReader

Parameters:

path - the path to check

Returns:

true if there is a value, false otherwise

getKeys

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

getChildKeys

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

Description copied from interface: PropertyReader

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).

Specified by:

getChildKeys in interface PropertyReader

Parameters:

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

Returns:

set of all direct children (ordered, never null)

loadFile

@Nullable
protected @Nullable Map<String,Object> loadFile(boolean splitDotPaths)

Loads the values of the file.

Parameters:

splitDotPaths - whether compound keys (keys with ".") should be split into nested paths

Returns:

map with the values from the file

normalizeMap

@Nullable
protected @Nullable Map<String,Object> normalizeMap(@Nullable
                                                              @Nullable Map<Object,Object> map,
                                                              boolean splitDotPaths)

Processes the map as read from SnakeYAML and may return a new, adjusted one.

Parameters:

map - the map to normalize

splitDotPaths - whether compound keys (keys with ".") should be split into nested paths

Returns:

the normalized map (or same map if no changes are needed)

getFile

@Deprecated
 @NotNull
protected final @NotNull File getFile()

Deprecated.

getPath

@NotNull
protected final @NotNull Path getPath()

getRoot

@Deprecated
 @Nullable
protected final @Nullable Map<String,Object> getRoot()

Deprecated. use getObject("") instead

Returns:

the root value; may be null if the file was empty

getTypedObject

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

Gets the object at the given path and safely casts it to the given class's 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