me.piggypiglet.framework.file

Class FileManager

java.lang.Object

me.piggypiglet.framework.file.FileManager

public final class FileManager
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
FileManager()

Method Summary

Modifier and Type	Method and Description
boolean	exists(java.lang.String name) Check if a file is stored under an identifier.
<T> T	get(java.lang.String name) Get the raw type instance of a stored file/config (FileWrapper or FileConfiguration)
FileConfiguration	getConfig(java.lang.String name) Get a FileConfiguration that's stored in the file manager.
FileConfiguration	loadConfig(java.lang.String name, java.lang.String internalPath, java.lang.String externalPath) Load a config into the FileManager
FileWrapper	loadFile(java.lang.String name, java.lang.String internalPath, java.lang.String externalPath) Load a file into the FileManager
void	save(java.lang.String name) Save a MutableFileConfiguration to file.
void	update(java.lang.String name) Update instances of AbstractFileConfigurations or FileWrappers with physical changes to their respective files by the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileManager

public FileManager()

Method Detail

loadFile

public FileWrapper loadFile(java.lang.String name,
                            java.lang.String internalPath,
                            java.lang.String externalPath)
                     throws java.lang.Exception

Load a file into the FileManager

Parameters:

name - Name the file will be referenced by

internalPath - Internal path of the file to be exported

externalPath - External path to save and load the file from

Returns:

Returns a file wrapper containing the file object and it's plaintext content

Throws:

java.lang.Exception - Will throw if IO, BadConfigType, or UnknownConfigType exceptions are encountered

loadConfig

public FileConfiguration loadConfig(java.lang.String name,
                                    java.lang.String internalPath,
                                    java.lang.String externalPath)
                             throws java.lang.Exception

Load a config into the FileManager

Parameters:

name - Name the config will be referenced by

internalPath - Internal path of the config to be exported

externalPath - External path to save and load the config from

Returns:

FileConfiguration object

Throws:

java.lang.Exception - Will throw if IO, BadConfigType, or UnknownConfigType exceptions are encountered

getConfig

public FileConfiguration getConfig(java.lang.String name)

Get a FileConfiguration that's stored in the file manager.

Parameters:

name - Name of the config

Returns:

FileConfiguration instance, or null if the file couldn't be found, or isn't a config

exists

public boolean exists(java.lang.String name)

Check if a file is stored under an identifier.

Parameters:

name - Name of the file

Returns:

boolean

get

public <T> T get(java.lang.String name)

Get the raw type instance of a stored file/config (FileWrapper or FileConfiguration)

Type Parameters:

T - Type

Parameters:

name - Name of the file

Returns:

Type

update

public void update(java.lang.String name)
            throws java.lang.Exception

Update instances of AbstractFileConfigurations or FileWrappers with physical changes to their respective files by the user.

Parameters:

name - Reference to the stored object

Throws:

java.lang.Exception - IO error

save

public void save(java.lang.String name)
          throws java.lang.Exception

Save a MutableFileConfiguration to file.

Parameters:

name - Name of the fileconfiguration.

Throws:

java.lang.Exception - May throw on IO error