Package org.apache.commons.vfs2.provider
Class DelegateFileObject<AFS extends AbstractFileSystem>
java.lang.Object
org.apache.commons.vfs2.provider.AbstractFileObject<AFS>
org.apache.commons.vfs2.provider.DelegateFileObject<AFS>
- Type Parameters:
AFS- A subclass of AbstractFileSystem.
- All Implemented Interfaces:
Closeable,AutoCloseable,Comparable<FileObject>,Iterable<FileObject>,FileListener,FileObject
public class DelegateFileObject<AFS extends AbstractFileSystem>
extends AbstractFileObject<AFS>
implements FileListener
A file backed by another file.
TODO - Extract subclass that overlays the children.
-
Field Summary
Fields inherited from class org.apache.commons.vfs2.provider.AbstractFileObject
DEFAULT_BUFFER_SIZEFields inherited from interface org.apache.commons.vfs2.FileObject
EMPTY_ARRAY -
Constructor Summary
ConstructorsConstructorDescriptionDelegateFileObject(AbstractFileName fileName, AFS fileSystem, FileObject fileObject) Constructs a new instance. -
Method Summary
Modifier and TypeMethodDescriptionvoidattachChild(FileName baseName, FileType type) Adds a child to this file.voidclose()Close the delegated file.protected voidCreates this file as a folder.protected voiddoDelete()Deletes the file.Returns the attributes of this file.protected Certificate[]Returns the certificates of this file.protected FileContentInfoGets file content info.protected longReturns the size of the file content (in bytes).protected InputStreamdoGetInputStream(int bufferSize) Creates an input stream to read the file content from.protected longReturns the last-modified time of this file.protected OutputStreamdoGetOutputStream(boolean bAppend) Creates an output stream to write the file content to.protected RandomAccessContentCreates access to the file for random I/O.protected FileTypeDetermines the type of the file, returns null if the file does not exist.protected booleanDetermines if this file is executable.protected booleanDetermines if this file is hidden.protected booleanDetermines if this file can be read.protected booleanDetermines if this file can be written to.protected String[]Lists the children of the file.protected voiddoRemoveAttribute(String attrName) Removes an attribute of this file.protected voiddoRename(FileObject newFile) Renames the file.protected voiddoSetAttribute(String attrName, Object value) Sets an attribute of this file.protected booleandoSetLastModifiedTime(long modtime) Sets the last-modified time of this file.voidfileChanged(FileChangeEvent event) Called when a file is changed.voidfileCreated(FileChangeEvent event) Called when a file is created.voidfileDeleted(FileChangeEvent event) Called when a file is deleted.Gets access to the delegated file.voidrefresh()Refresh file information.voidsetFile(FileObject fileObject) Attaches or detaches the target file.Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileObject
canRenameTo, childrenChanged, compareTo, copyFrom, createFile, createFolder, delete, delete, deleteAll, doAttach, doCreateFileContent, doDetach, doGetInputStream, doIsSameFile, doIsSymbolicLink, doListChildrenResolved, doSetExecutable, doSetReadable, doSetWritable, endOutput, exists, finalize, findFiles, findFiles, getAbstractFileSystem, getChild, getChildren, getContent, getFileContentInfoFactory, getFileOperations, getFileSystem, getInputStream, getInputStream, getName, getOutputStream, getOutputStream, getParent, getPublicURIString, getRandomAccessContent, getType, getURL, handleChanged, handleCreate, handleDelete, holdObject, injectType, isAttached, isContentOpen, isExecutable, isFile, isFolder, isHidden, isReadable, isSameFile, isSymbolicLink, isWriteable, iterator, listFiles, moveTo, notifyAllStreamsClosed, onChange, onChildrenChanged, resolveFile, resolveFile, setExecutable, setReadable, setWritable, toStringMethods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.vfs2.FileObject
getPath, getURIMethods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
DelegateFileObject
public DelegateFileObject(AbstractFileName fileName, AFS fileSystem, FileObject fileObject) throws FileSystemException Constructs a new instance.- Parameters:
fileName- the file name.fileSystem- the file system.fileObject- My file object.- Throws:
FileSystemException- For subclasses to throw.
-
-
Method Details
-
attachChild
Adds a child to this file.- Parameters:
baseName- The base FileName.type- The FileType.- Throws:
Exception- if an error occurs.
-
close
Close the delegated file.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein interfaceFileObject- Overrides:
closein classAbstractFileObject<AFS extends AbstractFileSystem>- Throws:
FileSystemException- if an error occurs.- See Also:
-
doCreateFolder
Creates this file as a folder.- Overrides:
doCreateFolderin classAbstractFileObject<AFS extends AbstractFileSystem>- Throws:
Exception- if an error occurs.
-
doDelete
Deletes the file.- Overrides:
doDeletein classAbstractFileObject<AFS extends AbstractFileSystem>- Throws:
Exception- if an error occurs.
-
doGetAttributes
Returns the attributes of this file.- Overrides:
doGetAttributesin classAbstractFileObject<AFS extends AbstractFileSystem>- Returns:
- The attributes of the file.
- Throws:
Exception- if an error occurs.
-
doGetCertificates
Returns the certificates of this file.- Overrides:
doGetCertificatesin classAbstractFileObject<AFS extends AbstractFileSystem>- Returns:
- The certificates used to sign the file.
- Throws:
Exception- if an error occurs.
-
doGetContentInfo
Gets file content info.- Returns:
- the file content info of the delegee.
- Throws:
Exception- Any thrown Exception is wrapped in FileSystemException.- Since:
- 2.0
-
doGetContentSize
Returns the size of the file content (in bytes). Is only called ifdoGetType()returnsFileType.FILE.- Specified by:
doGetContentSizein classAbstractFileObject<AFS extends AbstractFileSystem>- Returns:
- The size of the file in bytes.
- Throws:
Exception- if an error occurs.
-
doGetInputStream
Creates an input stream to read the file content from.- Overrides:
doGetInputStreamin classAbstractFileObject<AFS extends AbstractFileSystem>- Parameters:
bufferSize- Buffer size hint.- Returns:
- An InputStream to read the file content.
- Throws:
Exception- if an error occurs.
-
doGetLastModifiedTime
Returns the last-modified time of this file.- Overrides:
doGetLastModifiedTimein classAbstractFileObject<AFS extends AbstractFileSystem>- Returns:
- The last modification time.
- Throws:
Exception- if an error occurs.
-
doGetOutputStream
Creates an output stream to write the file content to.- Overrides:
doGetOutputStreamin classAbstractFileObject<AFS extends AbstractFileSystem>- Parameters:
bAppend- true if the file should be appended to, false if it should be overwritten.- Returns:
- An OutputStream to write to the file.
- Throws:
Exception- if an error occurs.
-
doGetRandomAccessContent
Creates access to the file for random I/O.- Overrides:
doGetRandomAccessContentin classAbstractFileObject<AFS extends AbstractFileSystem>- Parameters:
mode- The mode to access the file.- Returns:
- The RandomAccessContext.
- Throws:
Exception- if an error occurs.- Since:
- 2.0
-
doGetType
Determines the type of the file, returns null if the file does not exist.- Specified by:
doGetTypein classAbstractFileObject<AFS extends AbstractFileSystem>- Returns:
- the type of the file.
- Throws:
FileSystemException
-
doIsExecutable
Determines if this file is executable.- Overrides:
doIsExecutablein classAbstractFileObject<AFS extends AbstractFileSystem>- Returns:
- true if the file is executable, false otherwise.
- Throws:
FileSystemException
-
doIsHidden
Determines if this file is hidden.- Overrides:
doIsHiddenin classAbstractFileObject<AFS extends AbstractFileSystem>- Returns:
- true if the file is hidden, false otherwise.
- Throws:
FileSystemException
-
doIsReadable
Determines if this file can be read.- Overrides:
doIsReadablein classAbstractFileObject<AFS extends AbstractFileSystem>- Returns:
- true if the file is readable, false otherwise.
- Throws:
FileSystemException
-
doIsWriteable
Determines if this file can be written to.- Overrides:
doIsWriteablein classAbstractFileObject<AFS extends AbstractFileSystem>- Returns:
- true if the file is writable.
- Throws:
FileSystemException
-
doListChildren
Lists the children of the file.- Specified by:
doListChildrenin classAbstractFileObject<AFS extends AbstractFileSystem>- Returns:
- a possible empty String array if the file is a directory or null or an exception if the file is not a directory or can't be read.
- Throws:
Exception- if an error occurs.
-
doRemoveAttribute
Removes an attribute of this file.- Overrides:
doRemoveAttributein classAbstractFileObject<AFS extends AbstractFileSystem>- Parameters:
attrName- The name of the attribute to remove.- Throws:
Exception- if an error occurs.- Since:
- 2.0
-
doRename
Renames the file.- Overrides:
doRenamein classAbstractFileObject<AFS extends AbstractFileSystem>- Parameters:
newFile- the new location/name.- Throws:
Exception- Any thrown Exception is wrapped in FileSystemException.- Since:
- 2.0
-
doSetAttribute
Sets an attribute of this file.- Overrides:
doSetAttributein classAbstractFileObject<AFS extends AbstractFileSystem>- Parameters:
attrName- The attribute name.value- The value to be associated with the attribute name.- Throws:
Exception- if an error occurs.
-
doSetLastModifiedTime
Sets the last-modified time of this file.- Overrides:
doSetLastModifiedTimein classAbstractFileObject<AFS extends AbstractFileSystem>- Parameters:
modtime- The last modification time.- Returns:
- true if the time was set.
- Throws:
Exception- Any Exception thrown is wrapped in FileSystemException.- Since:
- 2.0
-
fileChanged
Called when a file is changed.This will only happen if you monitor the file using
FileMonitor.- Specified by:
fileChangedin interfaceFileListener- Parameters:
event- The FileChangeEvent.- Throws:
Exception- if an error occurs.
-
fileCreated
Called when a file is created.- Specified by:
fileCreatedin interfaceFileListener- Parameters:
event- The FileChangeEvent.- Throws:
Exception- if an error occurs.
-
fileDeleted
Called when a file is deleted.- Specified by:
fileDeletedin interfaceFileListener- Parameters:
event- The FileChangeEvent.- Throws:
Exception- if an error occurs.
-
getDelegateFile
Gets access to the delegated file.- Returns:
- The FileObject.
- Since:
- 2.0
-
refresh
Refresh file information.- Specified by:
refreshin interfaceFileObject- Overrides:
refreshin classAbstractFileObject<AFS extends AbstractFileSystem>- Throws:
FileSystemException- if an error occurs.- Since:
- 2.0
-
setFile
Attaches or detaches the target file.- Parameters:
fileObject- The FileObject.- Throws:
Exception- if an error occurs.
-