com.codelanx.codelanxlib.config

Interface PluginFile

All Known Subinterfaces:

Config, Lang

All Known Implementing Classes:

DefaultLang, InternalLang

public interface PluginFile

Represents a file containing mappings that is owned by a plugin, and can be automatically initialized

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

Method Summary

Modifier and Type	Method and Description
default Object	get() Gets the current object in memory
default FileDataType	getConfig() Returns the relevant FileDataType for this file.
DataHolder<? extends FileDataType>	getData() Returns the relevant DataHolder for this file, which provides thread-safety for the FileDataType object initialization
Object	getDefault() Returns the default value of the key
static File	getFileLocation(Class<? extends PluginFile> clazz) Returns the save location for passed PluginFile argument
String	getPath() The FileDataType path to store this value in
default <T extends FileDataType> T	init(Class<T> clazz) Loads the PluginFile values from the configuration file.
default void	save() Saves the current file data from memory
default void	save(File file) Saves the current file data from memory to a specific File

Method Detail

getFileLocation

static File getFileLocation(Class<? extends PluginFile> clazz)

Returns the save location for passed PluginFile argument

Parameters:

clazz - An implementing class with the PluginClass and RelativePath annotations

Returns:

A File pointing to the location containing saved values for this configuration type

Since:

0.1.0

getPath

String getPath()

The FileDataType path to store this value in

Returns:

The path to the file value

Since:

0.1.0

getDefault

Object getDefault()

Returns the default value of the key

Returns:

The key's default value

Since:

0.1.0

getConfig

default FileDataType getConfig()

Returns the relevant FileDataType for this file.

Returns:

The internal FileDataType of this Config

Since:

0.1.0

get

default Object get()

Gets the current object in memory

Returns:

The Object found at the relevant location

Since:

0.1.0

getData

DataHolder<? extends FileDataType> getData()

Returns the relevant DataHolder for this file, which provides thread-safety for the FileDataType object initialization

Returns:

The DataHolder for this PluginFile

Since:

0.1.0

init

default <T extends FileDataType> T init(Class<T> clazz)

Loads the PluginFile values from the configuration file. Safe to use for reloading

Type Parameters:

T - The type of FileDataType to return

Parameters:

clazz - The Class of the returned FileDataType

Returns:

The relevant FileDataType for all the file info

Since:

0.1.0

save

default void save()
           throws IOException

Saves the current file data from memory

Throws:

IOException - Failed to save to the file

Since:

0.1.0

save

default void save(File file)
           throws IOException

Saves the current file data from memory to a specific File

Parameters:

file - The file to save to

Throws:

IOException - Failed to save to the file

Since:

0.1.0