Package io.github.mrtesz.teszcore.config

Class YamlConfig

java.lang.Object

io.github.mrtesz.teszcore.config.YamlConfig

All Implemented Interfaces:

Copyable<YamlConfig>

public class YamlConfig
extends Object
implements Copyable<YamlConfig>

Class for managing YAML files

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	YamlConfig.Builder

Method Summary

Modifier and Type	Method	Description
void	addDefault(@NotNull String path, Object value)	Add a new entry to the defaults map
static YamlConfig.Builder	builder()	Generate a YamlConfig builder
boolean	contains(@NotNull String path)	See if a path contains a value
YamlConfig	copy()	Copy the executing class
boolean	exists()	See if the YAML file exists
Set<String>	getAllPaths()	Collect all paths of the YAML
boolean	getBoolean(@NotNull String path)
boolean	getBoolean(@NotNull String path, boolean def)
Boolean	getBooleanOrNull(@NotNull String path)
double	getDouble(@NotNull String path)
double	getDouble(@NotNull String path, double def)
Double	getDoubleOrNull(@NotNull String path)
float	getFloat(@NotNull String path)
float	getFloat(@NotNull String path, float def)
Float	getFloatOrNull(@NotNull String path)
int	getInt(@NotNull String path)
int	getInt(@NotNull String path, int def)
Integer	getIntOrNull(@NotNull String path)
long	getLong(@NotNull String path)
long	getLong(@NotNull String path, long def)
Long	getLongOrNull(@NotNull String path)
Set<String>	getPaths(@NotNull String parent)	Return all paths under the given parent path
Map<String,Object>	getRaw()	Get the raw data of the YAML
short	getShort(@NotNull String path)
short	getShort(@NotNull String path, short def)
Short	getShortOrNull(@NotNull String path)
String	getString(@NotNull String path)
String	getString(@NotNull String path, String def)
List<String>	getStringList(@NotNull String path)
List<String>	getStringList(@NotNull String path, List<String> def)
List<String>	getStringListOrNull(@NotNull String path)
void	load()	Creates the file or directory if not existent and loads the data of the YAML file
void	save()	Saves the current data to the YAML file
void	save(@NotNull Charset cs)	Saves the current data to the YAML file
void	set(@NotNull String path, @Nullable Object value)	Sets a value in the YAML file
void	setDefault(@NotNull String path, Object value)	Saves a value to the YAML file if the path is empty

Methods inherited from class java.lang.Object

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

Method Details

load

public void load()
          throws YamlConfigException

Creates the file or directory if not existent and loads the data of the YAML file

Throws:

YamlConfigException - when an I/O error occurs

save

public void save()
          throws YamlConfigException

Saves the current data to the YAML file

Throws:

YamlConfigException - when an I/O error occurs

save

public void save(@NotNull
 @NotNull Charset cs)
          throws YamlConfigException

Saves the current data to the YAML file

Parameters:

cs - `cs` of `OutputStreamWriter(OutputStream, Charset)`

Throws:

YamlConfigException - when an I/O error occurs

addDefault

public void addDefault(@NotNull
 @NotNull String path,
 Object value)

Add a new entry to the defaults map

Parameters:

path - Path

value - Value

setDefault

public void setDefault(@NotNull
 @NotNull String path,
 Object value)

Saves a value to the YAML file if the path is empty

Parameters:

path - Path

value - Value

set

public void set(@NotNull
 @NotNull String path,
 @Nullable
 @Nullable Object value)

Sets a value in the YAML file

Parameters:

path - Path

value - Value

getString

public String getString(@NotNull
 @NotNull String path)

getString

public String getString(@NotNull
 @NotNull String path,
 String def)

getInt

public int getInt(@NotNull
 @NotNull String path)

getInt

public int getInt(@NotNull
 @NotNull String path,
 int def)

getIntOrNull

public Integer getIntOrNull(@NotNull
 @NotNull String path)

getLong

public long getLong(@NotNull
 @NotNull String path)

getLong

public long getLong(@NotNull
 @NotNull String path,
 long def)

getLongOrNull

public Long getLongOrNull(@NotNull
 @NotNull String path)

getFloat

public float getFloat(@NotNull
 @NotNull String path)

getFloat

public float getFloat(@NotNull
 @NotNull String path,
 float def)

getFloatOrNull

public Float getFloatOrNull(@NotNull
 @NotNull String path)

getShort

public short getShort(@NotNull
 @NotNull String path)

getShort

public short getShort(@NotNull
 @NotNull String path,
 short def)

getShortOrNull

public Short getShortOrNull(@NotNull
 @NotNull String path)

getDouble

public double getDouble(@NotNull
 @NotNull String path)

getDouble

public double getDouble(@NotNull
 @NotNull String path,
 double def)

getDoubleOrNull

public Double getDoubleOrNull(@NotNull
 @NotNull String path)

getBoolean

public boolean getBoolean(@NotNull
 @NotNull String path)

getBoolean

public boolean getBoolean(@NotNull
 @NotNull String path,
 boolean def)

getBooleanOrNull

public Boolean getBooleanOrNull(@NotNull
 @NotNull String path)

getStringList

public List<String> getStringList(@NotNull
 @NotNull String path)

getStringList

public List<String> getStringList(@NotNull
 @NotNull String path,
 List<String> def)

getStringListOrNull

public List<String> getStringListOrNull(@NotNull
 @NotNull String path)

contains

public boolean contains(@NotNull
 @NotNull String path)

See if a path contains a value

Parameters:

path - Path

Returns:

if the path contains a value

exists

public boolean exists()

See if the YAML file exists

Returns:

true if the YAML file exists

getRaw

public Map<String,Object> getRaw()

Get the raw data of the YAML

Returns:

raw data of the YAML

getAllPaths

public Set<String> getAllPaths()

Collect all paths of the YAML

Returns:

all paths in the config (e.g. `database.host`, `database.port`)

getPaths

public Set<String> getPaths(@NotNull
 @NotNull String parent)

Return all paths under the given parent path

Parameters:

parent - Path to the parent section (e.g. `database`)

Returns:

all paths under the given parent path (e.g. `database.host`, `database.port`), or empty if the path does not exist or is not a section

builder

public static YamlConfig.Builder builder()

Generate a YamlConfig builder

Returns:

a YamlConfig builder

copy

public YamlConfig copy()

Description copied from interface: Copyable

Copy the executing class

Specified by:

copy in interface Copyable<YamlConfig>

Returns:

a copy of the class executed in