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: 537958 $ $Date: 2007-05-14 20:37:15 +0100 (Mon, 14 May 2007) $

Author:

Adam Murdoch, Gary D. Gregory

Constructor Summary

DelegateFileObject(FileName name, AbstractFileSystem fileSystem, FileObject file)

Method Summary

void	attachChild(FileName baseName, FileType type) Adds a child to this file.
void	close() Close the delegated file
protected 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 FileContentInfo	doGetContentInfo()
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 RandomAccessContent	doGetRandomAccessContent(RandomAccessMode mode) Creates access to the file for random i/o.
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	doRemoveAttribute(java.lang.String atttrName) Removes an attribute of this file.
protected void	doRename(FileObject newFile) Renames the file.
protected void	doSetAttribute(java.lang.String atttrName, java.lang.Object value) Sets an attribute of this file.
protected boolean	doSetLastModTime(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.
FileObject	getDelegateFile() get access to the delegated file
void	refresh() refresh file informations
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, doCreateFileContent, doDetach, doIsSameFile, doListChildrenResolved, doSetLastModifiedTime, 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, resolveFile, resolveFile, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegateFileObject

public DelegateFileObject(FileName name,
                          AbstractFileSystem fileSystem,
                          FileObject file)
                   throws FileSystemException

Throws:

FileSystemException

Method Detail

getDelegateFile

public FileObject getDelegateFile()

get access to the delegated file

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 class AbstractFileObject

Throws:

FileSystemException

doIsReadable

protected boolean doIsReadable()
                        throws FileSystemException

Determines if this file can be read.

Overrides:

doIsReadable in class AbstractFileObject

Throws:

FileSystemException

doIsWriteable

protected boolean doIsWriteable()
                         throws FileSystemException

Determines if this file can be written to.

Overrides:

doIsWriteable in class AbstractFileObject

Throws:

FileSystemException

doIsHidden

protected boolean doIsHidden()
                      throws FileSystemException

Determines if this file is hidden.

Overrides:

doIsHidden in class AbstractFileObject

Throws:

FileSystemException

doListChildren

protected java.lang.String[] doListChildren()
                                     throws java.lang.Exception

Lists the children of the file.

Specified by:

doListChildren in class AbstractFileObject

Throws:

java.lang.Exception

doCreateFolder

protected void doCreateFolder()
                       throws java.lang.Exception

Creates this file as a folder.

Overrides:

doCreateFolder in class AbstractFileObject

Throws:

java.lang.Exception

doDelete

protected void doDelete()
                 throws java.lang.Exception

Deletes the file.

Overrides:

doDelete in class AbstractFileObject

Throws:

java.lang.Exception

doGetContentSize

protected long doGetContentSize()
                         throws java.lang.Exception

Returns the size of the file content (in bytes). Is only called if doGetType() returns FileType.FILE.

Specified by:

doGetContentSize in class AbstractFileObject

Throws:

java.lang.Exception

doGetAttributes

protected java.util.Map doGetAttributes()
                                 throws java.lang.Exception

Returns the attributes of this file.

Overrides:

doGetAttributes in class AbstractFileObject

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 class AbstractFileObject

Throws:

java.lang.Exception

doGetCertificates

protected java.security.cert.Certificate[] doGetCertificates()
                                                      throws java.lang.Exception

Returns the certificates of this file.

Overrides:

doGetCertificates in class AbstractFileObject

Throws:

java.lang.Exception

doGetLastModifiedTime

protected long doGetLastModifiedTime()
                              throws java.lang.Exception

Returns the last-modified time of this file.

Overrides:

doGetLastModifiedTime in class AbstractFileObject

Throws:

java.lang.Exception

doSetLastModTime

protected boolean doSetLastModTime(long modtime)
                            throws java.lang.Exception

Sets the last-modified time of this file.

Overrides:

doSetLastModTime in class AbstractFileObject

Returns:

false if it was not possible to change the time

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 class AbstractFileObject

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 class AbstractFileObject

Throws:

java.lang.Exception

fileCreated

public void fileCreated(FileChangeEvent event)
                 throws java.lang.Exception

Called when a file is created.

Specified by:

fileCreated in interface FileListener

Throws:

java.lang.Exception

fileDeleted

public void fileDeleted(FileChangeEvent event)
                 throws java.lang.Exception

Called when a file is deleted.

Specified by:

fileDeleted in interface FileListener

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 using FileMonitor.

Specified by:

fileChanged in interface FileListener

Throws:

java.lang.Exception

close

public void close()
           throws FileSystemException

Close the delegated file

Specified by:

close in interface FileObject

Overrides:

close in class AbstractFileObject

Throws:

FileSystemException - On error closing the file.

See Also:

FileContent.close()

refresh

public void refresh()
             throws FileSystemException

refresh file informations

Specified by:

refresh in interface FileObject

Overrides:

refresh in class AbstractFileObject

Throws:

FileSystemException

doGetContentInfo

protected FileContentInfo doGetContentInfo()
                                    throws java.lang.Exception

Throws:

java.lang.Exception

doRename

protected void doRename(FileObject newFile)
                 throws java.lang.Exception

Renames the file.

Overrides:

doRename in class AbstractFileObject

Throws:

java.lang.Exception

doRemoveAttribute

protected void doRemoveAttribute(java.lang.String atttrName)
                          throws java.lang.Exception

Removes an attribute of this file.

Overrides:

doRemoveAttribute in class AbstractFileObject

Throws:

java.lang.Exception

doGetRandomAccessContent

protected RandomAccessContent doGetRandomAccessContent(RandomAccessMode mode)
                                                throws java.lang.Exception

Creates access to the file for random i/o.

Overrides:

doGetRandomAccessContent in class AbstractFileObject

Throws:

java.lang.Exception