Package top.focess.util.yaml

Class YamlConfiguration

java.lang.Object

top.focess.util.yaml.YamlConfiguration

All Implemented Interfaces:

Serializable, SectionMap

Direct Known Subclasses:

YamlConfigurationSection

public class YamlConfiguration
extends Object
implements SectionMap

This class is used to define a YAML configuration.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
YamlConfiguration(@Nullable Map<String,Object> values)	Initializes the YamlConfiguration with existed key-value pairs

Method Summary

Modifier and Type	Method	Description
boolean	containsSection(String key)	Indicate there is a section named key
YamlConfigurationSection	createSection(String key)	Create the section named key Note: if the section named key already exists, it will be replaced by a new section
<T> @Nullable T	get(String key)	Get the value of the key-value pair
<T> @Nullable List<T>	getList(String key)	Get the value of the key-value pair as list
<T> List<T>	getListOrEmpty(String key)	Get the value of the key-value pair as list
YamlConfigurationSection	getSection(String key)	Get the section named key Note: if the section named key does not exist, it will be created
Map<String,Object>	getValues()	Get all the key-value pairs
static YamlConfiguration	load(@Nullable InputStream inputStream)
static YamlConfiguration	loadFile(@NonNull File file)	Load the file as a YAML configuration
void	save(File file)	Save the YAML configuration as a file
void	set(String key, @Nullable Object value)	Store the key-value pair
void	setList(String key, List<?> value)	Set the list value of the key-value pair
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface top.focess.util.SectionMap

compute, contains, getOrDefault, keys, remove

Constructor Detail

YamlConfiguration

public YamlConfiguration(@Nullable Map<String,Object> values)

Initializes the YamlConfiguration with existed key-value pairs

Parameters:

values - the YAML configuration key-value pairs

Method Detail

loadFile

@NotNull
public static YamlConfiguration loadFile(@NonNull File file)
                                  throws YamlLoadException

Load the file as a YAML configuration

Parameters:

file - where to load

Returns:

YAML configuration

Throws:

YamlLoadException - if there is any io exception in loading the file

load

@NotNull
@Contract("_ -> new")
public static YamlConfiguration load(@Nullable InputStream inputStream)

createSection

public YamlConfigurationSection createSection(String key)

Description copied from interface: SectionMap

Create the section named key Note: if the section named key already exists, it will be replaced by a new section

Specified by:

createSection in interface SectionMap

Parameters:

key - the key of the Section

Returns:

a section named key

set

public void set(String key,
                @Nullable Object value)

Description copied from interface: SectionMap

Store the key-value pair

Specified by:

set in interface SectionMap

Parameters:

key - the key of the key-value pair

value - the value of the key-value pair

getList

public <T> @Nullable List<T> getList(String key)

Get the value of the key-value pair as list

Parameters:

key - the key

Returns:

the value of the key-value pair as list, or null if the key does not exist

getListOrEmpty

public <T> List<T> getListOrEmpty(String key)

Get the value of the key-value pair as list

Parameters:

key - the key

Returns:

the value of the key-value pair as list or an empty list if the key-value pair does not exist

setList

public void setList(String key,
                    List<?> value)

Set the list value of the key-value pair

Parameters:

key - the key

value - the list value

get

public <T> @Nullable T get(String key)

Description copied from interface: SectionMap

Get the value of the key-value pair

Specified by:

get in interface SectionMap

Type Parameters:

T - the value type

Parameters:

key - the key of the key-value pair

Returns:

the value

getValues

public Map<String,Object> getValues()

Description copied from interface: SectionMap

Get all the key-value pairs

Specified by:

getValues in interface SectionMap

Returns:

all the key-value pairs

save

public void save(File file)

Save the YAML configuration as a file

Parameters:

file - where to save

getSection

public YamlConfigurationSection getSection(String key)

Description copied from interface: SectionMap

Get the section named key Note: if the section named key does not exist, it will be created

Specified by:

getSection in interface SectionMap

Parameters:

key - the key of the Section

Returns:

the section named key

containsSection

public boolean containsSection(String key)

Description copied from interface: SectionMap

Indicate there is a section named key

Specified by:

containsSection in interface SectionMap

Parameters:

key - the key of the Section

Returns:

true there is a section named key, false otherwise

toString

public String toString()

Overrides:

toString in class Object