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:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Comparable<FileObject>, java.lang.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_SIZE

Fields inherited from interface org.apache.commons.vfs2.FileObject

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
DelegateFileObject(AbstractFileName fileName, AFS fileSystem, FileObject fileObject)	Constructs a new instance.

Method Summary

Modifier and Type	Method	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()	Gets file content info.
protected long	doGetContentSize()	Returns the size of the file content (in bytes).
protected java.io.InputStream	doGetInputStream(int bufferSize)	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	doIsExecutable()	Determines if this file is executable.
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 attrName)	Removes an attribute of this file.
protected void	doRename(FileObject newFile)	Renames the file.
protected void	doSetAttribute(java.lang.String attrName, 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()	Gets access to the delegated file.
void	refresh()	Refresh file information.
void	setFile(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, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.vfs2.FileObject

getPath, getURI

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

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 Detail

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.

close

public void close()
           throws FileSystemException

Close the delegated file.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface FileObject

Overrides:

close in class AbstractFileObject<AFS extends AbstractFileSystem>

Throws:

FileSystemException - if an error occurs.

See Also:

FileContent.close()

doCreateFolder

protected void doCreateFolder()
                       throws java.lang.Exception

Creates this file as a folder.

Overrides:

doCreateFolder in class AbstractFileObject<AFS extends AbstractFileSystem>

Throws:

java.lang.Exception - if an error occurs.

doDelete

protected void doDelete()
                 throws java.lang.Exception

Deletes the file.

Overrides:

doDelete in class AbstractFileObject<AFS extends AbstractFileSystem>

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<AFS extends AbstractFileSystem>

Returns:

The attributes of the file.

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<AFS extends AbstractFileSystem>

Returns:

The certificates used to sign the file.

Throws:

java.lang.Exception - if an error occurs.

doGetContentInfo

protected FileContentInfo doGetContentInfo()
                                    throws java.lang.Exception

Gets file content info.

Returns:

the file content info of the delegee.

Throws:

java.lang.Exception - Any thrown Exception is wrapped in FileSystemException.

Since:

2.0

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<AFS extends AbstractFileSystem>

Returns:

The size of the file in bytes.

Throws:

java.lang.Exception - if an error occurs.

doGetInputStream

protected java.io.InputStream doGetInputStream(int bufferSize)
                                        throws java.lang.Exception

Creates an input stream to read the file content from.

Overrides:

doGetInputStream in class AbstractFileObject<AFS extends AbstractFileSystem>

Parameters:

bufferSize - Buffer size hint.

Returns:

An InputStream to read the file content.

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<AFS extends AbstractFileSystem>

Returns:

The last modification time.

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<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:

java.lang.Exception - if an error occurs.

doGetRandomAccessContent

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

Creates access to the file for random I/O.

Overrides:

doGetRandomAccessContent in class AbstractFileObject<AFS extends AbstractFileSystem>

Parameters:

mode - The mode to access the file.

Returns:

The RandomAccessContext.

Throws:

java.lang.Exception - if an error occurs.

Since:

2.0

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<AFS extends AbstractFileSystem>

Returns:

the type of the file.

Throws:

FileSystemException

doIsExecutable

protected boolean doIsExecutable()
                          throws FileSystemException

Determines if this file is executable.

Overrides:

doIsExecutable in class AbstractFileObject<AFS extends AbstractFileSystem>

Returns:

true if the file is executable, false otherwise.

Throws:

FileSystemException

doIsHidden

protected boolean doIsHidden()
                      throws FileSystemException

Determines if this file is hidden.

Overrides:

doIsHidden in class AbstractFileObject<AFS extends AbstractFileSystem>

Returns:

true if the file is hidden, false otherwise.

Throws:

FileSystemException

doIsReadable

protected boolean doIsReadable()
                        throws FileSystemException

Determines if this file can be read.

Overrides:

doIsReadable in class AbstractFileObject<AFS extends AbstractFileSystem>

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<AFS extends AbstractFileSystem>

Returns:

true if the file is writable.

Throws:

FileSystemException

doListChildren

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

Lists the children of the file.

Specified by:

doListChildren in class AbstractFileObject<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:

java.lang.Exception - if an error occurs.

doRemoveAttribute

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

Removes an attribute of this file.

Overrides:

doRemoveAttribute in class AbstractFileObject<AFS extends AbstractFileSystem>

Parameters:

attrName - The name of the attribute to remove.

Throws:

java.lang.Exception - if an error occurs.

Since:

2.0

doRename

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

Renames the file.

Overrides:

doRename in class AbstractFileObject<AFS extends AbstractFileSystem>

Parameters:

newFile - the new location/name.

Throws:

java.lang.Exception - Any thrown Exception is wrapped in FileSystemException.

Since:

2.0

doSetAttribute

protected void doSetAttribute(java.lang.String attrName,
                              java.lang.Object value)
                       throws java.lang.Exception

Sets an attribute of this file.

Overrides:

doSetAttribute in class AbstractFileObject<AFS extends AbstractFileSystem>

Parameters:

attrName - The attribute name.

value - The value to be associated with the attribute name.

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<AFS extends AbstractFileSystem>

Parameters:

modtime - The last modification time.

Returns:

true if the time was set.

Throws:

java.lang.Exception - Any Exception thrown is wrapped in FileSystemException.

Since:

2.0

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.

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.

getDelegateFile

public FileObject getDelegateFile()

Gets access to the delegated file.

Returns:

The FileObject.

Since:

2.0

refresh

public void refresh()
             throws FileSystemException

Refresh file information.

Specified by:

refresh in interface FileObject

Overrides:

refresh in class AbstractFileObject<AFS extends AbstractFileSystem>

Throws:

FileSystemException - if an error occurs.

Since:

2.0

setFile

public void setFile(FileObject fileObject)
             throws java.lang.Exception

Attaches or detaches the target file.

Parameters:

fileObject - The FileObject.

Throws:

java.lang.Exception - if an error occurs.