com.djrapitops.plan.system.file

Class PlanFiles

java.lang.Object

com.djrapitops.plan.system.file.PlanFiles

All Implemented Interfaces:

SubSystem

Direct Known Subclasses:

SpongePlanFiles

@Singleton
public class PlanFiles
extends java.lang.Object
implements SubSystem

Abstracts File methods of Plugin classes so that they can be tested without Mocks.

Field Summary

Fields

Modifier and Type	Field and Description
protected PlanPlugin	plugin

Constructor Summary

Constructors

Constructor and Description
PlanFiles(PlanPlugin plugin)

Method Summary

Modifier and Type	Method and Description
void	disable() Performs disable actions for the subsystem
void	enable() Performs enable actions for the subsystem.
java.io.File	getConfigFile()
Resource	getCustomizableResourceOrDefault(java.lang.String resourceName) Get a customizable resource from the plugin files or from the jar if one doesn't exist.
java.io.File	getDataFolder()
java.io.File	getFileFromPluginFolder(java.lang.String name)
java.io.File	getLocaleFile()
java.io.File	getLogsFolder()
Resource	getResourceFromJar(java.lang.String resourceName) Get a file in the jar as a Resource.
Resource	getResourceFromPluginFolder(java.lang.String resourceName) Get a file from plugin folder as a Resource.

Methods inherited from class java.lang.Object

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

Field Detail

plugin

protected final PlanPlugin plugin

Constructor Detail

PlanFiles

@Inject
public PlanFiles(PlanPlugin plugin)

Method Detail

getDataFolder

public java.io.File getDataFolder()

getLogsFolder

public java.io.File getLogsFolder()

getConfigFile

public java.io.File getConfigFile()

getLocaleFile

public java.io.File getLocaleFile()

getFileFromPluginFolder

public java.io.File getFileFromPluginFolder(java.lang.String name)

enable

public void enable()
            throws EnableException

Description copied from interface: SubSystem

Performs enable actions for the subsystem.

Specified by:

enable in interface SubSystem

Throws:

EnableException - If an error occurred during enable and it is fatal to the subsystem.

disable

public void disable()

Description copied from interface: SubSystem

Performs disable actions for the subsystem

Specified by:

disable in interface SubSystem

getResourceFromJar

public Resource getResourceFromJar(java.lang.String resourceName)

Get a file in the jar as a Resource.

Parameters:

resourceName - Path to the file inside jar/assets/plan/ folder.

Returns:

a Resource for accessing the resource.

getResourceFromPluginFolder

public Resource getResourceFromPluginFolder(java.lang.String resourceName)

Get a file from plugin folder as a Resource.

Parameters:

resourceName - Path to the file inside the plugin folder.

Returns:

a Resource for accessing the resource.

getCustomizableResourceOrDefault

public Resource getCustomizableResourceOrDefault(java.lang.String resourceName)

Get a customizable resource from the plugin files or from the jar if one doesn't exist.

Parameters:

resourceName - Path to the file inside the plugin folder.

Returns:

a Resource for accessing the resource, either from the plugin folder or jar.