Class EngineFileSystem

java.lang.Object

com.blackrook.fs.FileSystem

com.blackrook.engine.EngineFileSystem

public class EngineFileSystem
extends com.blackrook.fs.FileSystem

Main file system tree for Engine applications.

Author:

Matthew Tropiano

Field Summary

Fields inherited from class com.blackrook.fs.FileSystem

fileStack

Method Summary

Modifier and Type	Method	Description
OutputStream	createGlobalSettingFile(String path)	Creates a new file off of the global settings path provided by EngineConfig.
OutputStream	createUserSettingFile(String path)	Creates a new file off of the user settings path provided by EngineConfig.
String	getGlobalSettingFilePath(String path)	Gets the path to a file in the global setting path.
String	getUserSettingFilePath(String path)	Gets the path to a file in the user setting path.
InputStream	openGlobalSettingFile(String path)	Creates a new file off of the global settings path provided by EngineConfig.
InputStream	openUserSettingFile(String path)	Creates a new file off of the user settings path provided by EngineConfig.
void	pushArchive(com.blackrook.fs.FSFileArchive fsfa)

Methods inherited from class com.blackrook.fs.FileSystem

addArchive, createFile, getAllFileInstances, getAllFiles, getAllFiles, getAllFilesInDir, getAllFilesInDir, getFile, popArchive, removeArchive

Methods inherited from class Object

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

Method Details

pushArchive

public void pushArchive(com.blackrook.fs.FSFileArchive fsfa)

Overrides:

pushArchive in class com.blackrook.fs.FileSystem

createGlobalSettingFile

public OutputStream createGlobalSettingFile(String path)
                                     throws IOException

Creates a new file off of the global settings path provided by EngineConfig. If EngineConfig.getGlobalSettingsPath() returns null, the base path is the current working directory.

Parameters:

path - the path to use.

Returns:

an open OutputStream for writing to the file, or null if it couldn't be open.

Throws:

IOException - if a write error occurs.

See Also:

• EngineConfig.getGlobalSettingsPath()

createUserSettingFile

public OutputStream createUserSettingFile(String path)
                                   throws IOException

Creates a new file off of the user settings path provided by EngineConfig. If EngineConfig.getUserSettingsPath() returns null, the base path is the current working directory.

Parameters:

path - the path to use.

Returns:

an open OutputStream for writing to the file, or null if it couldn't be open.

Throws:

IOException - if a write error occurs.

See Also:

• EngineConfig.getUserSettingsPath()

openGlobalSettingFile

public InputStream openGlobalSettingFile(String path)
                                  throws IOException

Creates a new file off of the global settings path provided by EngineConfig. If EngineConfig.getGlobalSettingsPath() returns null, the base path is the current working directory.

Parameters:

path - the path to use.

Returns:

an open InputStream for reading from the file, or null if the file does not exist.

Throws:

IOException - if a read error occurs.

See Also:

• EngineConfig.getGlobalSettingsPath()

openUserSettingFile

public InputStream openUserSettingFile(String path)
                                throws IOException

Creates a new file off of the user settings path provided by EngineConfig. If EngineConfig.getUserSettingsPath() returns null, the base path is the current working directory.

Parameters:

path - the path to use.

Returns:

an open InputStream for reading from the file.

Throws:

IOException - if a read error occurs.

See Also:

• EngineConfig.getUserSettingsPath()

getGlobalSettingFilePath

public String getGlobalSettingFilePath(String path)

Gets the path to a file in the global setting path.

Parameters:

path - the path off of the path root.

Returns:

the full file path to the file.

getUserSettingFilePath

public String getUserSettingFilePath(String path)

Gets the path to a file in the user setting path.

Parameters:

path - the path off of the path root.

Returns:

the full file path to the file.