me.piggypiglet.framework.file.framework.implementations.map

Class MapFileConfiguration

java.lang.Object

me.piggypiglet.framework.file.framework.AbstractFileConfiguration

me.piggypiglet.framework.file.framework.implementations.map.MapFileConfiguration

All Implemented Interfaces:

FileConfiguration, MutableFileConfiguration

Direct Known Subclasses:

BungeeFileConfiguration, JsonFileConfiguration, MapFileConfigurationSection, NukkitFileConfiguration, SpigotFileConfiguration, SpongeYamlFileConfiguration

public abstract class MapFileConfiguration
extends AbstractFileConfiguration
implements MutableFileConfiguration

Field Summary

Fields inherited from class me.piggypiglet.framework.file.framework.AbstractFileConfiguration

mappers, NULL_BOOL, NULL_NUM, NULL_STRING

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapFileConfiguration(java.util.function.Predicate<java.lang.String> match)
protected	MapFileConfiguration(java.util.function.Predicate<java.lang.String> match, Mapper... mappers)

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	convert(java.util.Map<java.lang.String,java.lang.Object> items)
java.lang.Object	get(java.lang.String path) Get an object at a specific path
java.lang.Boolean	getBoolean(java.lang.String path) Get a Boolean at a specific path
java.util.List<FileConfiguration>	getConfigList(java.lang.String path) Get a list of FileConfigurations at a specific path
FileConfiguration	getConfigSection(java.lang.String path) Get a config section as a FileConfiguration at a specific path
java.lang.Double	getDouble(java.lang.String path) Get a Double at a specific path
java.lang.Integer	getInt(java.lang.String path) Get an Integer at a specific path
<T> java.util.List<T>	getList(java.lang.String path) Get a List at a specific path
java.lang.Long	getLong(java.lang.String path) Get a Long at a specific path
java.lang.String	getString(java.lang.String path) Get an String at a specific path
java.util.List<java.lang.String>	getStringList(java.lang.String path) Get a list of strings at a specific path
protected void	internalLoad(java.io.File file, java.lang.String fileContent) Optional code that will be executed on load
protected abstract java.util.Map<java.lang.String,java.lang.Object>	provide(java.io.File file, java.lang.String fileContent)
protected java.util.Map<java.lang.String,java.lang.Object>	retrieveAll()
void	save()
void	set(java.lang.String path, java.lang.Object value)

Methods inherited from class me.piggypiglet.framework.file.framework.AbstractFileConfiguration

get, getAll, getBoolean, getConfigList, getConfigSection, getDouble, getFile, getInt, getList, getLong, getMatch, getString, getStringList, load

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.piggypiglet.framework.file.framework.FileConfiguration

get, getBoolean, getConfigList, getConfigSection, getDouble, getInt, getList, getLong, getString, getStringList

Constructor Detail

MapFileConfiguration

protected MapFileConfiguration(java.util.function.Predicate<java.lang.String> match)

MapFileConfiguration

protected MapFileConfiguration(java.util.function.Predicate<java.lang.String> match,
                               Mapper... mappers)

Method Detail

provide

protected abstract java.util.Map<java.lang.String,java.lang.Object> provide(java.io.File file,
                                                                            java.lang.String fileContent)

convert

protected abstract java.lang.String convert(java.util.Map<java.lang.String,java.lang.Object> items)

internalLoad

protected void internalLoad(java.io.File file,
                            java.lang.String fileContent)

Description copied from class: AbstractFileConfiguration

Optional code that will be executed on load

Overrides:

internalLoad in class AbstractFileConfiguration

Parameters:

file - File instance

fileContent - File's raw content as a String

get

public java.lang.Object get(java.lang.String path)

Description copied from interface: FileConfiguration

Get an object at a specific path

Specified by:

get in interface FileConfiguration

Parameters:

path - Path of the object

Returns:

Object

getConfigSection

public FileConfiguration getConfigSection(java.lang.String path)

Description copied from interface: FileConfiguration

Get a config section as a FileConfiguration at a specific path

Specified by:

getConfigSection in interface FileConfiguration

Parameters:

path - Path of the section

Returns:

FileConfiguration

getString

public java.lang.String getString(java.lang.String path)

Description copied from interface: FileConfiguration

Get an String at a specific path

Specified by:

getString in interface FileConfiguration

Parameters:

path - Path of the String

Returns:

String

getInt

public java.lang.Integer getInt(java.lang.String path)

Description copied from interface: FileConfiguration

Get an Integer at a specific path

Specified by:

getInt in interface FileConfiguration

Parameters:

path - Path of the Integer

Returns:

Integer

getLong

public java.lang.Long getLong(java.lang.String path)

Description copied from interface: FileConfiguration

Get a Long at a specific path

Specified by:

getLong in interface FileConfiguration

Parameters:

path - Path of the Long

Returns:

Long

getDouble

public java.lang.Double getDouble(java.lang.String path)

Description copied from interface: FileConfiguration

Get a Double at a specific path

Specified by:

getDouble in interface FileConfiguration

Parameters:

path - Path of the Double

Returns:

Double

getBoolean

public java.lang.Boolean getBoolean(java.lang.String path)

Description copied from interface: FileConfiguration

Get a Boolean at a specific path

Specified by:

getBoolean in interface FileConfiguration

Parameters:

path - Path of the Boolean

Returns:

Boolean

getStringList

public java.util.List<java.lang.String> getStringList(java.lang.String path)

Description copied from interface: FileConfiguration

Get a list of strings at a specific path

Specified by:

getStringList in interface FileConfiguration

Parameters:

path - Path of the list

Returns:

List of Strings

getConfigList

public java.util.List<FileConfiguration> getConfigList(java.lang.String path)

Description copied from interface: FileConfiguration

Get a list of FileConfigurations at a specific path

Specified by:

getConfigList in interface FileConfiguration

Parameters:

path - Path of the list

Returns:

List of FileConfiguration

getList

public <T> java.util.List<T> getList(java.lang.String path)

Description copied from interface: FileConfiguration

Get a List at a specific path

Specified by:

getList in interface FileConfiguration

Type Parameters:

T - Object type

Parameters:

path - Path of the List

Returns:

List

retrieveAll

protected java.util.Map<java.lang.String,java.lang.Object> retrieveAll()

Specified by:

retrieveAll in class AbstractFileConfiguration

set

public void set(java.lang.String path,
                java.lang.Object value)

Specified by:

set in interface MutableFileConfiguration

save

public void save()
          throws ConfigSaveException

Specified by:

save in interface MutableFileConfiguration

Throws:

ConfigSaveException