me.piggypiglet.framework.file.framework

Class AbstractFileConfiguration

java.lang.Object

me.piggypiglet.framework.file.framework.AbstractFileConfiguration

All Implemented Interfaces:

FileConfiguration

Direct Known Subclasses:

BlankFileConfiguration, MapFileConfiguration

public abstract class AbstractFileConfiguration
extends java.lang.Object
implements FileConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<Mapper>	mappers
protected static boolean	NULL_BOOL
protected static int	NULL_NUM
protected static java.lang.String	NULL_STRING

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFileConfiguration(java.util.function.Predicate<java.lang.String> match) Provision a predicate to see whether a file extension will match this configuration
protected	AbstractFileConfiguration(java.util.function.Predicate<java.lang.String> match, Mapper... mappers)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	get(java.lang.String path, java.lang.Object def) Get an object at a specific path, and if it's null, use a default value
java.util.Map<java.lang.String,java.lang.Object>	getAll()
boolean	getBoolean(java.lang.String path, boolean def) Get a boolean at a specific path, and if it's null, use a default value
java.util.List<FileConfiguration>	getConfigList(java.lang.String path, java.util.List<FileConfiguration> def) Get a list of FileConfigurations at a specific path, and if it's null, use a default value
FileConfiguration	getConfigSection(java.lang.String path, FileConfiguration def) Get a config section as a FileConfiguration at a specific path, and if it's null, use a default value
double	getDouble(java.lang.String path, double def) Get a Double at a specific path, and if it's null, use a default value
java.io.File	getFile() Get this FileConfiguration's file instance
int	getInt(java.lang.String path, int def) Get an int at a specific path, and if it's null, use a default value
<T> java.util.List<T>	getList(java.lang.String path, java.util.List<T> def) Get a List at a specific path, and if it's null, use a default value
long	getLong(java.lang.String path, long def) Get a Long at a specific path, and if it's null, use a default value
java.util.function.Predicate<java.lang.String>	getMatch() Get a predicate to test whether a file extension matches this specific AbstractFileConfiguration
java.lang.String	getString(java.lang.String path, java.lang.String def) Get a String at a specific path, and if it's null, use a default value
java.util.List<java.lang.String>	getStringList(java.lang.String path, java.util.List<java.lang.String> def) Get a list of strings at a specific path, and if it's null, use a default value
protected void	internalLoad(java.io.File file, java.lang.String fileContent) Optional code that will be executed on load
AbstractFileConfiguration	load(java.io.File file, java.lang.String fileContent) Load and populate an AbstractFileConfiguration instance
protected abstract java.util.Map<java.lang.String,java.lang.Object>	retrieveAll()

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

Field Detail

mappers

protected final java.util.List<Mapper> mappers

NULL_STRING

protected static final java.lang.String NULL_STRING

See Also:

Constant Field Values

NULL_NUM

protected static final int NULL_NUM

See Also:

Constant Field Values

NULL_BOOL

protected static final boolean NULL_BOOL

See Also:

Constant Field Values

Constructor Detail

AbstractFileConfiguration

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

Provision a predicate to see whether a file extension will match this configuration

Parameters:

match - Predicate

AbstractFileConfiguration

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

Method Detail

load

public final AbstractFileConfiguration load(java.io.File file,
                                            java.lang.String fileContent)

Load and populate an AbstractFileConfiguration instance

Parameters:

file - File

fileContent - File's raw content

Returns:

AbstractFileConfiguration

internalLoad

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

Optional code that will be executed on load

Parameters:

file - File instance

fileContent - File's raw content as a String

getFile

public java.io.File getFile()

Get this FileConfiguration's file instance

Returns:

File

getMatch

public java.util.function.Predicate<java.lang.String> getMatch()

Get a predicate to test whether a file extension matches this specific AbstractFileConfiguration

Returns:

Predicate

get

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

Description copied from interface: FileConfiguration

Get an object at a specific path, and if it's null, use a default value

Specified by:

get in interface FileConfiguration

Parameters:

path - Path of the object

def - Default value

Returns:

Object

getConfigSection

public FileConfiguration getConfigSection(java.lang.String path,
                                          FileConfiguration def)

Description copied from interface: FileConfiguration

Get a config section as a FileConfiguration at a specific path, and if it's null, use a default value

Specified by:

getConfigSection in interface FileConfiguration

Parameters:

path - Path of the section

def - Default value

Returns:

FileConfiguration

getString

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

Description copied from interface: FileConfiguration

Get a String at a specific path, and if it's null, use a default value

Specified by:

getString in interface FileConfiguration

Parameters:

path - Path of the String

def - Default value

Returns:

String

getInt

public int getInt(java.lang.String path,
                  int def)

Description copied from interface: FileConfiguration

Get an int at a specific path, and if it's null, use a default value

Specified by:

getInt in interface FileConfiguration

Parameters:

path - Path of the int

def - Default value

Returns:

int

getLong

public long getLong(java.lang.String path,
                    long def)

Description copied from interface: FileConfiguration

Get a Long at a specific path, and if it's null, use a default value

Specified by:

getLong in interface FileConfiguration

Parameters:

path - Path of the Long

def - Default value

Returns:

Long

getDouble

public double getDouble(java.lang.String path,
                        double def)

Description copied from interface: FileConfiguration

Get a Double at a specific path, and if it's null, use a default value

Specified by:

getDouble in interface FileConfiguration

Parameters:

path - Path of the Double

def - Default value

Returns:

Double

getBoolean

public boolean getBoolean(java.lang.String path,
                          boolean def)

Description copied from interface: FileConfiguration

Get a boolean at a specific path, and if it's null, use a default value

Specified by:

getBoolean in interface FileConfiguration

Parameters:

path - Path of the Boolean

def - Default value

Returns:

Boolean

getStringList

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

Description copied from interface: FileConfiguration

Get a list of strings at a specific path, and if it's null, use a default value

Specified by:

getStringList in interface FileConfiguration

Parameters:

path - Path of the list

def - Default value

Returns:

List of Strings

getConfigList

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

Description copied from interface: FileConfiguration

Get a list of FileConfigurations at a specific path, and if it's null, use a default value

Specified by:

getConfigList in interface FileConfiguration

Parameters:

path - Path of the list

def - Default value

Returns:

List of FileConfiguration

getList

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

Description copied from interface: FileConfiguration

Get a List at a specific path, and if it's null, use a default value

Specified by:

getList in interface FileConfiguration

Type Parameters:

T - Object type

Parameters:

path - Path of the List

def - Default value

Returns:

List

retrieveAll

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

getAll

public java.util.Map<java.lang.String,java.lang.Object> getAll()