public class SynchronizedFileObject extends DecoratedFileObject
Constructor and Description |
---|
SynchronizedFileObject(FileObject fileObject) |
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes this file, and its content.
|
void |
copyFrom(FileObject srcFile,
FileSelector selector)
Copies another file, and all its descendents, to this file.
|
void |
createFile()
Creates this file, if it does not exist.
|
void |
createFolder()
Creates this folder, if it does not exist.
|
boolean |
delete()
Deletes this file.
|
int |
delete(FileSelector selector)
Deletes all descendents of this file that match a selector.
|
boolean |
exists()
Determines if this file exists.
|
FileObject[] |
findFiles(FileSelector selector)
Finds the set of matching descendents of this file, in depthwise order.
|
void |
findFiles(FileSelector selector,
boolean depthwise,
List<FileObject> selected)
Finds the set of matching descendents of this file.
|
FileObject |
getChild(String name)
Returns a child of this file.
|
FileObject[] |
getChildren()
Lists the children of this file.
|
FileContent |
getContent()
Returns this file's content.
|
FileType |
getType()
Returns this file's type.
|
boolean |
isHidden()
Determines if this file is hidden.
|
boolean |
isReadable()
Determines if this file can be read.
|
boolean |
isWriteable()
Determines if this file can be written to.
|
void |
moveTo(FileObject destFile)
Move this file.
|
FileObject |
resolveFile(String path)
Finds a file, relative to this file.
|
FileObject |
resolveFile(String name,
NameScope scope)
Finds a file, relative to this file.
|
canRenameTo, getDecoratedFileObject, getFileOperations, getFileSystem, getName, getParent, getURL, isAttached, isContentOpen, refresh, toString
public SynchronizedFileObject(FileObject fileObject)
public void close() throws FileSystemException
FileObject
The file object can continue to be used after this method is called.
close
in interface FileObject
close
in class DecoratedFileObject
FileSystemException
- On error closing the file.FileContent.close()
public void copyFrom(FileObject srcFile, FileSelector selector) throws FileSystemException
FileObject
This method is not transactional. If it fails and throws an exception, this file will potentially only be partially copied.
copyFrom
in interface FileObject
copyFrom
in class DecoratedFileObject
srcFile
- The source file to copy.selector
- The selector to use to select which files to copy.FileSystemException
- If this file is read-only, or if the source file does not exist,
or on error copying the file.public void createFile() throws FileSystemException
FileObject
createFile
in interface FileObject
createFile
in class DecoratedFileObject
FileSystemException
- If the file already exists with the wrong type, or the parent
folder is read-only, or on error creating this file or one of
its ancestors.public void createFolder() throws FileSystemException
FileObject
createFolder
in interface FileObject
createFolder
in class DecoratedFileObject
FileSystemException
- If the folder already exists with the wrong type, or the parent
folder is read-only, or on error creating this folder or one of
its ancestors.public boolean delete() throws FileSystemException
FileObject
FileObject.delete(FileSelector)
for that.delete
in interface FileObject
delete
in class DecoratedFileObject
FileSystemException
- If this file is a non-empty folder, or if this file is read-only,
or on error deleteing this file.public int delete(FileSelector selector) throws FileSystemException
FileObject
This method is not transactional. If it fails and throws an exception, this file will potentially only be partially deleted.
delete
in interface FileObject
delete
in class DecoratedFileObject
selector
- The selector to use to select which files to delete.FileSystemException
- If this file or one of its descendents is read-only, or on error
deleting this file or one of its descendents.public boolean exists() throws FileSystemException
FileObject
exists
in interface FileObject
exists
in class DecoratedFileObject
true
if this file exists, false
if not.FileSystemException
- On error determining if this file exists.public void findFiles(FileSelector selector, boolean depthwise, List<FileObject> selected) throws FileSystemException
FileObject
findFiles
in interface FileObject
findFiles
in class DecoratedFileObject
selector
- the selector used to determine if the file should be selecteddepthwise
- controls the ordering in the list. e.g. deepest firstselected
- container for selected files. list needs not to be empty.FileSystemException
- if an error occurs.public FileObject[] findFiles(FileSelector selector) throws FileSystemException
FileObject
findFiles
in interface FileObject
findFiles
in class DecoratedFileObject
selector
- The selector to use to select matching files.FileSystemException
- if an error occurs.public FileObject getChild(String name) throws FileSystemException
FileObject
null
when the child does not exist. This differs from
FileObject.resolveFile( String, NameScope)
which never returns null.getChild
in interface FileObject
getChild
in class DecoratedFileObject
name
- The name of the child.FileSystemException
- If this file does not exist, or is not a folder, or on error
determining this file's children.public FileObject[] getChildren() throws FileSystemException
FileObject
getChildren
in interface FileObject
getChildren
in class DecoratedFileObject
FileSystemException
- If this file does not exist, or is not a folder, or on error
listing this file's children.public FileContent getContent() throws FileSystemException
FileObject
FileContent
returned by this
method can be used to read and write the content of the file.
This method can be called if the file does not exist, and
the returned FileContent
can be used to create the file
by writing its content.
getContent
in interface FileObject
getContent
in class DecoratedFileObject
FileSystemException
- On error getting this file's content.public FileType getType() throws FileSystemException
FileObject
getType
in interface FileObject
getType
in class DecoratedFileObject
FileType
constants. Never returns null.FileSystemException
- On error determining the file's type.public boolean isHidden() throws FileSystemException
FileObject
isHidden
in interface FileObject
isHidden
in class DecoratedFileObject
true
if this file is hidden, false
if not.FileSystemException
- On error determining if this file exists.public boolean isReadable() throws FileSystemException
FileObject
isReadable
in interface FileObject
isReadable
in class DecoratedFileObject
true
if this file is readable, false
if not.FileSystemException
- On error determining if this file exists.public boolean isWriteable() throws FileSystemException
FileObject
isWriteable
in interface FileObject
isWriteable
in class DecoratedFileObject
true
if this file is writeable, false
if not.FileSystemException
- On error determining if this file exists.public void moveTo(FileObject destFile) throws FileSystemException
FileObject
If the destFile exists, it is deleted first
moveTo
in interface FileObject
moveTo
in class DecoratedFileObject
destFile
- the New filename.FileSystemException
- If this file is read-only, or if the source file does not exist,
or on error copying the file.public FileObject resolveFile(String name, NameScope scope) throws FileSystemException
FileObject
NameScope
for a description of how names are resolved in the different scopes.resolveFile
in interface FileObject
resolveFile
in class DecoratedFileObject
name
- The name to resolve.scope
- the NameScope for the file.FileSystemException
- On error parsing the path, or on error finding the file.public FileObject resolveFile(String path) throws FileSystemException
FileObject
resolveFile( path, NameScope.FILE_SYSTEM )
.resolveFile
in interface FileObject
resolveFile
in class DecoratedFileObject
path
- The path of the file to locate. Can either be a relative
path or an absolute path.FileSystemException
- On error parsing the path, or on error finding the file.Copyright © 2002–2015 The Apache Software Foundation. All rights reserved.