Package com.djrapitops.plan.storage.file

Class PlanFiles

java.lang.Object

com.djrapitops.plan.storage.file.PlanFiles

All Implemented Interfaces:

SubSystem

Direct Known Subclasses:

SpongePlanFiles

@Singleton
public class PlanFiles
extends Object
implements SubSystem

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

Field Summary

Fields

Modifier and Type	Field	Description
protected JarResource.StreamFunction	getResourceStream

Constructor Summary

Constructors

Constructor	Description
PlanFiles(File dataFolder, JarResource.StreamFunction getResourceStream)

Method Summary

Modifier and Type	Method	Description
Optional<File>	attemptToFind(String resourceName)
void	disable()	Performs disable actions for the subsystem
void	enable()	Performs enable actions for the subsystem.
File	getConfigFile()
Optional<Resource>	getCustomizableResource(String resourceName)
Path	getCustomizationDirectory()
Path	getDataDirectory()
File	getDataFolder()
File	getFileFromPluginFolder(String name)
Path	getJSONStorageDirectory()
File	getLocaleFile()
Path	getLogsDirectory()
File	getLogsFolder()
Resource	getResourceFromJar(String resourceName)	Get a file in the jar as a Resource.
Resource	getResourceFromPluginFolder(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 Details

getResourceStream

protected final JarResource.StreamFunction getResourceStream

Constructor Details

PlanFiles

@Inject
public PlanFiles(@Named("dataFolder")
 File dataFolder,
 JarResource.StreamFunction getResourceStream)

Method Details

getDataFolder

public File getDataFolder()

getDataDirectory

public Path getDataDirectory()

getCustomizationDirectory

public Path getCustomizationDirectory()

getLogsFolder

public File getLogsFolder()

getLogsDirectory

public Path getLogsDirectory()

getConfigFile

public File getConfigFile()

getLocaleFile

public File getLocaleFile()

getFileFromPluginFolder

public File getFileFromPluginFolder(String name)

enable

public void enable()

Description copied from interface: SubSystem

Performs enable actions for the subsystem.

Specified by:

enable in interface 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(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(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.

getCustomizableResource

public Optional<Resource> getCustomizableResource(String resourceName)

attemptToFind

public Optional<File> attemptToFind(String resourceName)

getJSONStorageDirectory

public Path getJSONStorageDirectory()