org.apache.commons.vfs.provider.mime
Class MimeFileObject

java.lang.Object
  org.apache.commons.vfs.provider.AbstractFileObject
      org.apache.commons.vfs.provider.mime.MimeFileObject

All Implemented Interfaces:

FileObject

public class MimeFileObject
extends AbstractFileObject
implements FileObject

A part of a MIME message.

Version:

$Revision: 497043 $ $Date: 2007-01-17 15:22:14 +0000 (Wed, 17 Jan 2007) $

Author:

imario@apache.org

Constructor Summary

protected

MimeFileObject(FileName name, javax.mail.Part part, AbstractFileSystem fileSystem)

Method Summary

protected void	doAttach() Attaches this file object to its file resource.
protected void	doDetach() Detaches this file object from its file resource.
protected java.util.Map	doGetAttributes() Returns all headers of this part. The map key is a java.lang.String and the value is a: java.lang.Strings for single entries or a java.utils.List of java.lang.Strings for entries with multiple values
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 FileType	doGetType() Determines the type of the file, returns null if the file does not exist.
protected java.lang.String[]	doListChildren() Lists the children of this file.
protected FileObject[]	doListChildrenResolved() Lists the children of the file.
protected java.util.Enumeration	getAllHeaders()
protected FileContentInfoFactory	getFileContentInfoFactory() create the filecontentinfo implementation
protected javax.mail.Part	getPart()

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

canRenameTo, childrenChanged, childrenChanged, close, copyFrom, createFile, createFolder, delete, delete, doCreateFileContent, doCreateFolder, doDelete, doGetCertificates, doGetOutputStream, doGetRandomAccessContent, doIsHidden, doIsReadable, doIsSameFile, doIsWriteable, doRemoveAttribute, doRename, doSetAttribute, doSetLastModifiedTime, doSetLastModTime, endOutput, exists, finalize, findFiles, findFiles, getChild, getChildren, getContent, 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

Methods inherited from class java.lang.Object

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

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

canRenameTo, close, copyFrom, createFile, createFolder, delete, delete, exists, findFiles, findFiles, getChild, getChildren, getContent, getFileOperations, getFileSystem, getName, getParent, getType, getURL, isAttached, isContentOpen, isHidden, isReadable, isWriteable, moveTo, refresh, resolveFile, resolveFile

Constructor Detail

MimeFileObject

protected MimeFileObject(FileName name,
                         javax.mail.Part part,
                         AbstractFileSystem fileSystem)
                  throws FileSystemException

Throws:

FileSystemException

Method Detail

doAttach

protected void doAttach()
                 throws java.lang.Exception

Attaches this file object to its file resource.

Overrides:

doAttach in class AbstractFileObject

Throws:

java.lang.Exception

doDetach

protected void doDetach()
                 throws java.lang.Exception

Description copied from class: AbstractFileObject

Detaches this file object from its file resource.

Called when this file is closed. Note that the file object may be reused later, so should be able to be reattached.

This implementation does nothing.

Overrides:

doDetach in class AbstractFileObject

Throws:

java.lang.Exception

doGetType

protected FileType doGetType()
                      throws java.lang.Exception

Determines the type of the file, returns null if the file does not exist.

Specified by:

doGetType in class AbstractFileObject

Throws:

java.lang.Exception

doListChildren

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

Description copied from class: AbstractFileObject

Lists the children of this file. Is only called if AbstractFileObject.doGetType() returns FileType.FOLDER. The return value of this method is cached, so the implementation can be expensive.

Specified by:

doListChildren in class AbstractFileObject

Throws:

java.lang.Exception

doListChildrenResolved

protected FileObject[] doListChildrenResolved()
                                       throws java.lang.Exception

Lists the children of the file. Is only called if doGetType() returns FileType.FOLDER.

Overrides:

doListChildrenResolved in class AbstractFileObject

Throws:

java.lang.Exception

doGetContentSize

protected long doGetContentSize()
                         throws java.lang.Exception

Returns the size of the file content (in bytes).

Specified by:

doGetContentSize 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

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

getFileContentInfoFactory

protected FileContentInfoFactory getFileContentInfoFactory()

Description copied from class: AbstractFileObject

create the filecontentinfo implementation

Overrides:

getFileContentInfoFactory in class AbstractFileObject

getPart

protected javax.mail.Part getPart()

doGetAttributes

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

Returns all headers of this part.
The map key is a java.lang.String and the value is a:

• java.lang.Strings for single entries
or a
• java.utils.List of java.lang.Strings for entries with multiple values

Overrides:

doGetAttributes in class AbstractFileObject

Throws:

java.lang.Exception

getAllHeaders

protected java.util.Enumeration getAllHeaders()
                                       throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException