Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.commons.vfs.provider.tar
Class TarFileObject

    java.lang.Object
      org.apache.commons.vfs.provider.AbstractFileObject
          org.apache.commons.vfs.provider.tar.TarFileObject

All Implemented Interfaces:
  FileObject

public class TarFileObject
extends AbstractFileObject
implements FileObject

A file in a Tar file system.

Field Summary
`protected org.apache.commons.vfs.provider.tar.TarEntry` | `entry`

Constructor Summary
`protected` | `TarFileObject(FileName name, org.apache.commons.vfs.provider.tar.TarEntry entry, TarFileSystem fs, boolean tarExists)`

Method Summary
`protected void` | `attachChild(FileName childName)` Attaches a child
`protected long` | `doGetContentSize()` Returns the size of the file content (in bytes).
`protected 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()` Returns the file's type.
`protected String[]` | `doListChildren()` Lists the children of the file.
`boolean` | `isWriteable()` Determines if this file can be written to.
`protected void` | `setTarEntry(org.apache.commons.vfs.provider.tar.TarEntry entry)` Sets the details for this file object.

Methods inherited from class org.apache.commons.vfs.provider.AbstractFileObject
`canRenameTo, childrenChanged, childrenChanged, close, copyFrom, createFile, createFolder, delete, delete, doAttach, doCreateFolder, doDelete, doDetach, doGetAttributes, doGetCertificates, doGetOutputStream, doGetRandomAccessContent, doIsHidden, doIsReadable, doIsSameFile, doIsWriteable, doListChildrenResolved, doRename, doSetAttribute, 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, 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, moveTo, refresh, resolveFile, resolveFile`

Field Detail

### entry

    protected org.apache.commons.vfs.provider.tar.TarEntry entry

Constructor Detail

### TarFileObject

    protected TarFileObject(FileName name,
                            org.apache.commons.vfs.provider.tar.TarEntry entry,
                            TarFileSystem fs,
                            boolean tarExists)
                     throws FileSystemException

Method Detail

### setTarEntry

    protected void setTarEntry(org.apache.commons.vfs.provider.tar.TarEntry entry)

  Sets the details for this file object.

### attachChild

    protected void attachChild(FileName childName)

  Attaches a child

### isWriteable

    public boolean isWriteable()
                        throws FileSystemException

  Determines if this file can be written to.

  Specified by:
    `isWriteable` in interface `FileObject`
  Overrides:
    `isWriteable` in class `AbstractFileObject`
  Returns:
    `true` if this file is writeable, `false` if not.
  Throws:
    `FileSystemException`

### doGetType

    protected FileType doGetType()

  Returns the file's type.

  Specified by:
    `doGetType` in class `AbstractFileObject`

### doListChildren

    protected String[] doListChildren()

  Lists the children of the file.

  Specified by:
    `doListChildren` in class `AbstractFileObject`

### doGetContentSize

    protected long doGetContentSize()

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

  Specified by:
    `doGetContentSize` in class `AbstractFileObject`

### doGetLastModifiedTime

    protected long doGetLastModifiedTime()
                                  throws Exception

  Returns the last modified time of this file.

  Overrides:
    `doGetLastModifiedTime` in class `AbstractFileObject`
  Throws:
    `Exception`

### doGetInputStream

    protected InputStream doGetInputStream()
                                    throws Exception

  Creates an input stream to read the file content from. Is only called if `doGetType()` returns `FileType.FILE`. The input stream returned by this method is guaranteed to be closed before this method is called again.

  Specified by:
    `doGetInputStream` in class `AbstractFileObject`
  Throws:
    `Exception`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2002-2006 The Apache Software Foundation. All Rights Reserved.