|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The FileSystem
interface is an abstraction of a virtual
file system. The similarities of its method names with with the methods
of the java.io.File
class are intentional.
Implementations of this interface expose a file system-like resource.
File system-like resources include WebDAV-enabled servers, local file systems,
and so forth.
Field Summary | |
static String |
SEPARATOR
File separator |
static char |
SEPARATOR_CHAR
File separator character |
Method Summary | |
void |
close()
Close the file system. |
void |
copy(String srcPath,
String destPath)
Copies a file or folder to a new location. |
void |
createFolder(String folderPath)
Creates the folder named by this path, including any necessary but nonexistent parent folders. |
void |
deleteFile(String filePath)
Deletes the file denoted by this path. |
void |
deleteFolder(String folderPath)
Deletes the folder denoted by this path. |
boolean |
exists(String path)
Tests whether the file system entry denoted by this path exists. |
InputStream |
getInputStream(String filePath)
Returns an input stream of the contents of the file denoted by this path. |
OutputStream |
getOutputStream(String filePath)
Returns an output stream for writing bytes to the file denoted by this path. |
RandomAccessOutputStream |
getRandomAccessOutputStream(String filePath)
Returns an output stream for writing bytes to the file denoted by this path. |
boolean |
hasChildren(String path)
Tests whether the file system entry denoted by this path has child entries. |
void |
init()
Initialize the file system |
boolean |
isFile(String path)
Tests whether the file system entry denoted by this path is a file. |
boolean |
isFolder(String path)
Tests whether the file system entry denoted by this path is a folder. |
long |
lastModified(String path)
Returns the time that the file system entry denoted by this path was last modified. |
long |
length(String filePath)
Returns the length of the file denoted by this path. |
String[] |
list(String folderPath)
Returns an array of strings naming the files and folders in the folder denoted by this path. |
String[] |
listFiles(String folderPath)
Returns an array of strings naming the files in the folder denoted by this path. |
String[] |
listFolders(String folderPath)
Returns an array of strings naming the folders in the folder denoted by this path. |
void |
move(String srcPath,
String destPath)
Moves a file or folder to a new location. |
void |
touch(String filePath)
Set the modified time of an existing file to now. |
Field Detail |
public static final String SEPARATOR
public static final char SEPARATOR_CHAR
Method Detail |
public void init() throws FileSystemException
FileSystemException
- if the file system initialization failspublic void close() throws FileSystemException
FileSystemException
public InputStream getInputStream(String filePath) throws FileSystemException
filePath
- the path of the file.
FileSystemException
- if the file does not exist
or if it cannot be read frompublic OutputStream getOutputStream(String filePath) throws FileSystemException
filePath
- the path of the file.
FileSystemException
- if the file cannot be written to or createdpublic RandomAccessOutputStream getRandomAccessOutputStream(String filePath) throws FileSystemException, UnsupportedOperationException
0
. See also
RandomAccessOutputStream.seek(long)
;
filePath
- the path of the file.
FileSystemException
- if the file could not be created or
if the output stream cannot be obtained.
UnsupportedOperationException
- if the implementation does
not support file access through a
RandomAccessOutputStream
.public void createFolder(String folderPath) throws FileSystemException
folderPath
- the path of the folder to be created.
FileSystemException
- if a file system entry denoted by path
already exists or if another error occurs.public boolean exists(String path) throws FileSystemException
path
- the path of a file system entry.
FileSystemException
public boolean isFile(String path) throws FileSystemException
path
- the path of a file system entry.
FileSystemException
public boolean isFolder(String path) throws FileSystemException
path
- the path of a file system entry.
FileSystemException
public boolean hasChildren(String path) throws FileSystemException
path
- the path of a file system entry.
FileSystemException
public long length(String filePath) throws FileSystemException
filePath
- the path of the file.
FileSystemException
- if the path does not denote an existing file.public long lastModified(String path) throws FileSystemException
path
- the path of a file system entry.
FileSystemException
- if the file system entry does not exist.public void touch(String filePath) throws FileSystemException
filePath
- the path of the file.
FileSystemException
- if the path does not denote an existing file.public String[] list(String folderPath) throws FileSystemException
folderPath
- the path of the folder whose contents is to be listed.
FileSystemException
- if this path does not denote a folder or if
another error occurs.public String[] listFiles(String folderPath) throws FileSystemException
folderPath
- the path of the folder whose contents is to be listed.
FileSystemException
- if this path does not denote a folder or if
another error occurs.public String[] listFolders(String folderPath) throws FileSystemException
folderPath
- the path of the folder whose contents is to be listed.
FileSystemException
- if this path does not denote a folder or if
another error occurs.public void deleteFile(String filePath) throws FileSystemException
filePath
- the path of the file to be deleted.
FileSystemException
- if this path does not denote a file or if
another error occurs.public void deleteFolder(String folderPath) throws FileSystemException
folderPath
- the path of the folder to be deleted.
FileSystemException
- if this path does not denote a folder or if
another error occurs.public void move(String srcPath, String destPath) throws FileSystemException
srcPath
- the path of the file or folder to be moved.destPath
- the destination path to which the file or folder is to be moved.
FileSystemException
- if the move failspublic void copy(String srcPath, String destPath) throws FileSystemException
srcPath
- the path of the file or folder to be copied.destPath
- the destination path to which the file or folder is to be copied.
FileSystemException
- if the copy fails
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |