Class FileHandler

java.lang.Object

me.neurodock.core.files.FileHandler

public class FileHandler
extends Object

Base class responsible for the me.neurodock.core.files related systems

Constructor Summary

Constructors

Constructor	Description
FileHandler(Path baseDirectory)	Creates a new instance as well as setting the instance to this new one A good start is to use Options.getFileHandlerDataLocation() as it's located along all other files

Method Summary

Modifier and Type	Method	Description
static FileHandler	getInstance()
static ArrayList<Tool>	getTools()	Returns a list of all Tool's this module adds
String	path(File file)	Provides a relative path from root to file
String	readFile(String filename)
Path	resolve(String relative)

Methods inherited from class Object

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

Constructor Details

FileHandler

public FileHandler(Path baseDirectory)

Creates a new instance as well as setting the instance to this new one A good start is to use Options.getFileHandlerDataLocation() as it's located along all other files

Parameters:

baseDirectory - the directory to be used as base directory

Method Details

getInstance

public static FileHandler getInstance()

getTools

public static ArrayList<Tool> getTools()

Returns a list of all Tool's this module adds

Returns:

resolve

public Path resolve(String relative)
             throws IOException

Throws:

IOException

readFile

public String readFile(String filename)
                throws FileHandlerException

Parameters:

filename -

Returns:

Throws:

FileHandlerException

path

public String path(File file)

Provides a relative path from root to file

Parameters:

file - the file to be relativised

Returns:

the relative path from root to file