Package org.apache.commons.vfs.provider
Class DelegateFileObject
- java.lang.Object
-
- org.apache.commons.vfs.provider.AbstractFileObject
-
- org.apache.commons.vfs.provider.DelegateFileObject
-
- All Implemented Interfaces:
FileListener
,FileObject
public class DelegateFileObject extends AbstractFileObject implements FileListener
A file backed by another file.- Version:
- $Revision: 480428 $ $Date: 2006-11-29 07:15:24 +0100 (Wed, 29 Nov 2006) $
- Author:
- Adam Murdoch, Gary D. Gregory
-
-
Constructor Summary
Constructors Constructor Description DelegateFileObject(FileName name, AbstractFileSystem fileSystem, FileObject file)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
attachChild(FileName baseName, FileType type)
Adds a child to this file.void
close()
Close the delegated fileprotected void
doCreateFolder()
Creates this file as a folder.protected void
doDelete()
Deletes the file.protected java.util.Map
doGetAttributes()
Returns the attributes of this file.protected java.security.cert.Certificate[]
doGetCertificates()
Returns the certificates of this file.protected long
doGetContentSize()
Returns the size of the file content (in bytes).protected java.io.InputStream
doGetInputStream()
Creates an input stream to read the file content from.protected long
doGetLastModifiedTime()
Returns the last-modified time of this file.protected java.io.OutputStream
doGetOutputStream(boolean bAppend)
Creates an output stream to write the file content to.protected FileType
doGetType()
Determines the type of the file, returns null if the file does not exist.protected boolean
doIsHidden()
Determines if this file is hidden.protected boolean
doIsReadable()
Determines if this file can be read.protected boolean
doIsWriteable()
Determines if this file can be written to.protected java.lang.String[]
doListChildren()
Lists the children of the file.protected void
doSetAttribute(java.lang.String atttrName, java.lang.Object value)
Sets an attribute of this file.protected void
doSetLastModifiedTime(long modtime)
Sets the last-modified time of this file.void
fileChanged(FileChangeEvent event)
Called when a file is changed.void
fileCreated(FileChangeEvent event)
Called when a file is created.void
fileDeleted(FileChangeEvent event)
Called when a file is deleted.void
setFile(FileObject file)
Attaches or detaches the target file.-
Methods inherited from class org.apache.commons.vfs.provider.AbstractFileObject
canRenameTo, childrenChanged, childrenChanged, copyFrom, createFile, createFolder, delete, delete, doAttach, doDetach, doGetRandomAccessContent, doIsSameFile, doListChildrenResolved, doRename, endOutput, exists, finalize, findFiles, findFiles, getChild, getChildren, getContent, getFileContentInfoFactory, getFileOperations, getFileSystem, getInputStream, getName, getOutputStream, getOutputStream, getParent, getRandomAccessContent, getType, getURL, handleChanged, handleCreate, handleDelete, holdObject, injectType, isAttached, isContentOpen, isHidden, isReadable, isSameFile, isWriteable, moveTo, notifyAllStreamsClosed, onChange, onChildrenChanged, refresh, resolveFile, resolveFile, toString
-
-
-
-
Constructor Detail
-
DelegateFileObject
public DelegateFileObject(FileName name, AbstractFileSystem fileSystem, FileObject file) throws FileSystemException
- Throws:
FileSystemException
-
-
Method Detail
-
attachChild
public void attachChild(FileName baseName, FileType type) throws java.lang.Exception
Adds a child to this file.- Throws:
java.lang.Exception
-
setFile
public void setFile(FileObject file) throws java.lang.Exception
Attaches or detaches the target file.- Throws:
java.lang.Exception
-
doGetType
protected FileType doGetType() throws FileSystemException
Determines the type of the file, returns null if the file does not exist.- Specified by:
doGetType
in classAbstractFileObject
- Throws:
FileSystemException
-
doIsReadable
protected boolean doIsReadable() throws FileSystemException
Determines if this file can be read.- Overrides:
doIsReadable
in classAbstractFileObject
- Throws:
FileSystemException
-
doIsWriteable
protected boolean doIsWriteable() throws FileSystemException
Determines if this file can be written to.- Overrides:
doIsWriteable
in classAbstractFileObject
- Throws:
FileSystemException
-
doIsHidden
protected boolean doIsHidden() throws FileSystemException
Determines if this file is hidden.- Overrides:
doIsHidden
in classAbstractFileObject
- Throws:
FileSystemException
-
doListChildren
protected java.lang.String[] doListChildren() throws java.lang.Exception
Lists the children of the file.- Specified by:
doListChildren
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doCreateFolder
protected void doCreateFolder() throws java.lang.Exception
Creates this file as a folder.- Overrides:
doCreateFolder
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doDelete
protected void doDelete() throws java.lang.Exception
Deletes the file.- Overrides:
doDelete
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doGetContentSize
protected long doGetContentSize() throws java.lang.Exception
Returns the size of the file content (in bytes). Is only called ifdoGetType()
returnsFileType.FILE
.- Specified by:
doGetContentSize
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doGetAttributes
protected java.util.Map doGetAttributes() throws java.lang.Exception
Returns the attributes of this file.- Overrides:
doGetAttributes
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doSetAttribute
protected void doSetAttribute(java.lang.String atttrName, java.lang.Object value) throws java.lang.Exception
Sets an attribute of this file.- Overrides:
doSetAttribute
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doGetCertificates
protected java.security.cert.Certificate[] doGetCertificates() throws java.lang.Exception
Returns the certificates of this file.- Overrides:
doGetCertificates
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doGetLastModifiedTime
protected long doGetLastModifiedTime() throws java.lang.Exception
Returns the last-modified time of this file.- Overrides:
doGetLastModifiedTime
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doSetLastModifiedTime
protected void doSetLastModifiedTime(long modtime) throws java.lang.Exception
Sets the last-modified time of this file.- Overrides:
doSetLastModifiedTime
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doGetInputStream
protected java.io.InputStream doGetInputStream() throws java.lang.Exception
Creates an input stream to read the file content from.- Specified by:
doGetInputStream
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doGetOutputStream
protected java.io.OutputStream doGetOutputStream(boolean bAppend) throws java.lang.Exception
Creates an output stream to write the file content to.- Overrides:
doGetOutputStream
in classAbstractFileObject
- Throws:
java.lang.Exception
-
fileCreated
public void fileCreated(FileChangeEvent event) throws java.lang.Exception
Called when a file is created.- Specified by:
fileCreated
in interfaceFileListener
- Throws:
java.lang.Exception
-
fileDeleted
public void fileDeleted(FileChangeEvent event) throws java.lang.Exception
Called when a file is deleted.- Specified by:
fileDeleted
in interfaceFileListener
- Throws:
java.lang.Exception
-
fileChanged
public void fileChanged(FileChangeEvent event) throws java.lang.Exception
Called when a file is changed. This will only happen if you monitor the file usingFileMonitor
.- Specified by:
fileChanged
in interfaceFileListener
- Throws:
java.lang.Exception
-
close
public void close() throws FileSystemException
Close the delegated file- Specified by:
close
in interfaceFileObject
- Overrides:
close
in classAbstractFileObject
- Throws:
FileSystemException
- On error closing the file.- See Also:
FileContent.close()
-
-