DelegateFileObject (commons-vfs API)

java.lang.Object
- org.apache.commons.vfs2.provider.AbstractFileObject
- - org.apache.commons.vfs2.provider.DelegateFileObject

All Implemented Interfaces:

FileListener, FileObject
```
public class DelegateFileObject
extends AbstractFileObject
implements FileListener
```
A file backed by another file.

Author:

Commons VFS team

Constructor Summary

Constructors
Constructor and Description

DelegateFileObject(AbstractFileName name, AbstractFileSystem fileSystem, FileObject file)

Constructors
Constructor and Description
`DelegateFileObject(AbstractFileName name, AbstractFileSystem fileSystem, FileObject file)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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<java.lang.String,java.lang.Object>`	`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`	`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.
`FileObject`	`getDelegateFile()` Get access to the delegated file.
`void`	`refresh()` Refresh file information.
`void`	`setFile(FileObject file)` Attaches or detaches the target file.

Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileObject
canRenameTo, childrenChanged, copyFrom, createFile, createFolder, delete, delete, doAttach, doCreateFileContent, doDetach, doIsSameFile, doListChildrenResolved, 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(AbstractFileName name,
                          AbstractFileSystem fileSystem,
                          FileObject file)
                   throws FileSystemException
```
    Throws:
    
    FileSystemException
- Method Detail
  - getDelegateFile
```
public FileObject getDelegateFile()
```
    Get access to the delegated file.
    
    Returns:
    
    The FileObject.
    
    Since:
    
    2.0
  - attachChild
```
public void attachChild(FileName baseName,
                        FileType type)
                 throws java.lang.Exception
```
    Adds a child to this file.
    
    Parameters:
    
    baseName - The base FileName.
    
    type - The FileType.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - setFile
```
public void setFile(FileObject file)
             throws java.lang.Exception
```
    Attaches or detaches the target file.
    
    Parameters:
    
    file - The FileObject.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - 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
    
    Returns:
    
    the type of the file.
    
    Throws:
    
    FileSystemException
  - doIsReadable
```
protected boolean doIsReadable()
                        throws FileSystemException
```
    Determines if this file can be read.
    
    Overrides:
    
    doIsReadable in class AbstractFileObject
    
    Returns:
    
    true if the file is readable, false otherwise.
    
    Throws:
    
    FileSystemException
  - doIsWriteable
```
protected boolean doIsWriteable()
                         throws FileSystemException
```
    Determines if this file can be written to.
    
    Overrides:
    
    doIsWriteable in class AbstractFileObject
    
    Returns:
    
    true if the file is writable.
    
    Throws:
    
    FileSystemException
  - doIsHidden
```
protected boolean doIsHidden()
                      throws FileSystemException
```
    Determines if this file is hidden.
    
    Overrides:
    
    doIsHidden in class AbstractFileObject
    
    Returns:
    
    true if the file is hidden, false otherwise.
    
    Throws:
    
    FileSystemException
  - doListChildren
```
protected java.lang.String[] doListChildren()
                                     throws java.lang.Exception
```
    Lists the children of the file.
    
    Specified by:
    
    doListChildren in class AbstractFileObject
    
    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:
    
    java.lang.Exception - if an error occurs.
  - doCreateFolder
```
protected void doCreateFolder()
                       throws java.lang.Exception
```
    Creates this file as a folder.
    
    Overrides:
    
    doCreateFolder in class AbstractFileObject
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - doDelete
```
protected void doDelete()
                 throws java.lang.Exception
```
    Deletes the file.
    
    Overrides:
    
    doDelete in class AbstractFileObject
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - 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
    
    Returns:
    
    The size of the file in bytes.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - doGetAttributes
```
protected java.util.Map<java.lang.String,java.lang.Object> doGetAttributes()
                                                                    throws java.lang.Exception
```
    Returns the attributes of this file.
    
    Overrides:
    
    doGetAttributes in class AbstractFileObject
    
    Returns:
    
    The attributes of the file.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - 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
    
    Parameters:
    
    atttrName - The attribute name.
    
    value - The value to be associated with the attribute name.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - doGetCertificates
```
protected java.security.cert.Certificate[] doGetCertificates()
                                                      throws java.lang.Exception
```
    Returns the certificates of this file.
    
    Overrides:
    
    doGetCertificates in class AbstractFileObject
    
    Returns:
    
    The certificates used to sign the file.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - doGetLastModifiedTime
```
protected long doGetLastModifiedTime()
                              throws java.lang.Exception
```
    Returns the last-modified time of this file.
    
    Overrides:
    
    doGetLastModifiedTime in class AbstractFileObject
    
    Returns:
    
    The last modification time.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - doSetLastModifiedTime
```
protected boolean doSetLastModifiedTime(long modtime)
                                 throws java.lang.Exception
```
    Sets the last-modified time of this file.
    
    Overrides:
    
    doSetLastModifiedTime in class AbstractFileObject
    
    Parameters:
    
    modtime - The last modification time.
    
    Returns:
    
    true if the time was set.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
    
    Since:
    
    2.0
  - 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
    
    Returns:
    
    An InputStream to read the file content.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - 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
    
    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:
    
    java.lang.Exception - if an error occurs.
  - fileCreated
```
public void fileCreated(FileChangeEvent event)
                 throws java.lang.Exception
```
    Called when a file is created.
    
    Specified by:
    
    fileCreated in interface FileListener
    
    Parameters:
    
    event - The FileChangeEvent.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - fileDeleted
```
public void fileDeleted(FileChangeEvent event)
                 throws java.lang.Exception
```
    Called when a file is deleted.
    
    Specified by:
    
    fileDeleted in interface FileListener
    
    Parameters:
    
    event - The FileChangeEvent.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - 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
    
    Parameters:
    
    event - The FileChangeEvent.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - close
```
public void close()
           throws FileSystemException
```
    Close the delegated file.
    
    Specified by:
    
    close in interface FileObject
    
    Overrides:
    
    close in class AbstractFileObject
    
    Throws:
    
    FileSystemException - if an error occurs.
    
    See Also:
    
    FileContent.close()
  - refresh
```
public void refresh()
             throws FileSystemException
```
    Refresh file information.
    
    Specified by:
    
    refresh in interface FileObject
    
    Overrides:
    
    refresh in class AbstractFileObject
    
    Throws:
    
    FileSystemException - if an error occurs.
    
    Since:
    
    2.0
  - doGetContentInfo
```
protected FileContentInfo doGetContentInfo()
                                    throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
    
    Since:
    
    2.0
  - doRename
```
protected void doRename(FileObject newFile)
                 throws java.lang.Exception
```
    Renames the file.
    
    Overrides:
    
    doRename in class AbstractFileObject
    
    Parameters:
    
    newFile - A FileObject with the new file name.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
    
    Since:
    
    2.0
  - doRemoveAttribute
```
protected void doRemoveAttribute(java.lang.String atttrName)
                          throws java.lang.Exception
```
    Removes an attribute of this file.
    
    Overrides:
    
    doRemoveAttribute in class AbstractFileObject
    
    Parameters:
    
    atttrName - The name of the attribute to remove.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
    
    Since:
    
    2.0
  - doGetRandomAccessContent
```
protected RandomAccessContent doGetRandomAccessContent(RandomAccessMode mode)
                                                throws java.lang.Exception
```
    Creates access to the file for random i/o.
    
    Overrides:
    
    doGetRandomAccessContent in class AbstractFileObject
    
    Parameters:
    
    mode - The mode to access the file.
    
    Returns:
    
    The RandomAccessContext.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
    
    Since:
    
    2.0

Class DelegateFileObject

Constructor Summary

Method Summary

Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileObject

Methods inherited from class java.lang.Object

Constructor Detail

DelegateFileObject

Method Detail

getDelegateFile

attachChild

setFile

doGetType

doIsReadable

doIsWriteable

doIsHidden

doListChildren

doCreateFolder

doDelete

doGetContentSize

doGetAttributes

doSetAttribute

doGetCertificates

doGetLastModifiedTime

doSetLastModifiedTime

doGetInputStream

doGetOutputStream

fileCreated

fileDeleted

fileChanged

close

refresh

doGetContentInfo

doRename

doRemoveAttribute

doGetRandomAccessContent