org.ws4d.java.io.fs

Class FileSystem

java.lang.Object

org.ws4d.java.io.fs.FileSystem

Direct Known Subclasses:

LocalFileSystem

public abstract class FileSystem
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
FileSystem()

Method Summary

Modifier and Type	Method and Description
abstract boolean	deleteDirectory(java.lang.String directoryPath)
abstract boolean	deleteFile(java.lang.String filePath)
abstract java.lang.String	escapeFileName(java.lang.String rawFileName)
abstract boolean	fileExists(java.lang.String filePath)
abstract java.lang.String	fileSeparator()
abstract long	fileSize(java.lang.String filePath)
abstract java.lang.String	getAbsoluteFilePath(java.lang.String filePath)
abstract java.lang.String	getBaseDir() Returns the current root directory, used if a function is called with a relative path.
abstract java.lang.String	getFileSystemType() Returns the local file system type (e.g.
static FileSystem	getInstance() Returns an implementation of the file system supported by the given platform.
abstract long	lastModified(java.lang.String filePath)
abstract java.lang.String[]	listFiles(java.lang.String dirPath)
java.io.InputStream	readFile(java.lang.String filePath)
java.io.InputStream	readFile(URI fileUri)
protected abstract java.io.InputStream	readFileInternal(java.lang.String filePath)
protected abstract java.io.InputStream	readJarInternal(java.lang.String jarName, java.lang.String pathInJar)
abstract boolean	renameFile(java.lang.String filePath, java.lang.String newFilePath)
java.io.OutputStream	writeFile(java.lang.String filePath)
protected abstract java.io.OutputStream	writeFileInternal(java.lang.String filePath)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystem

public FileSystem()

Method Detail

getInstance

public static FileSystem getInstance()
                              throws java.io.IOException

Returns an implementation of the file system supported by the given platform.

It is necessary to load the corresponding module for platform support.

Returns:

an implementation of the file system.

Throws:

java.io.IOException - will throw an exception when the module could not be loaded correctly or the runtime configuration does not support a local file system.

getAbsoluteFilePath

public abstract java.lang.String getAbsoluteFilePath(java.lang.String filePath)

readFile

public java.io.InputStream readFile(java.lang.String filePath)
                             throws java.io.IOException

Throws:

java.io.IOException

readFile

public java.io.InputStream readFile(URI fileUri)
                             throws java.io.IOException

Throws:

java.io.IOException

writeFile

public java.io.OutputStream writeFile(java.lang.String filePath)
                               throws java.io.IOException

Throws:

java.io.IOException

getBaseDir

public abstract java.lang.String getBaseDir()

Returns the current root directory, used if a function is called with a relative path.

getFileSystemType

public abstract java.lang.String getFileSystemType()

Returns the local file system type (e.g. "SE" for standard java, "Android" for Android)

escapeFileName

public abstract java.lang.String escapeFileName(java.lang.String rawFileName)

readFileInternal

protected abstract java.io.InputStream readFileInternal(java.lang.String filePath)
                                                 throws java.io.IOException

Throws:

java.io.IOException

readJarInternal

protected abstract java.io.InputStream readJarInternal(java.lang.String jarName,
                                                       java.lang.String pathInJar)
                                                throws java.io.IOException

Throws:

java.io.IOException

writeFileInternal

protected abstract java.io.OutputStream writeFileInternal(java.lang.String filePath)
                                                   throws java.io.IOException

Throws:

java.io.IOException

deleteFile

public abstract boolean deleteFile(java.lang.String filePath)

deleteDirectory

public abstract boolean deleteDirectory(java.lang.String directoryPath)

renameFile

public abstract boolean renameFile(java.lang.String filePath,
                                   java.lang.String newFilePath)

listFiles

public abstract java.lang.String[] listFiles(java.lang.String dirPath)

fileSize

public abstract long fileSize(java.lang.String filePath)

fileSeparator

public abstract java.lang.String fileSeparator()

fileExists

public abstract boolean fileExists(java.lang.String filePath)

lastModified

public abstract long lastModified(java.lang.String filePath)