Class TarFileObject
java.lang.Object
org.apache.commons.vfs2.provider.AbstractFileObject<TarFileSystem>
org.apache.commons.vfs2.provider.tar.TarFileObject
- All Implemented Interfaces:
Closeable,AutoCloseable,Comparable<FileObject>,Iterable<FileObject>,FileObject
A file in a Tar file system.
-
Field Summary
Fields inherited from class org.apache.commons.vfs2.provider.AbstractFileObject
DEFAULT_BUFFER_SIZEFields inherited from interface org.apache.commons.vfs2.FileObject
EMPTY_ARRAY -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedTarFileObject(AbstractFileName fileName, org.apache.commons.compress.archivers.tar.TarArchiveEntry entry, TarFileSystem fileSystem, boolean tarExists) Constructs a new instance. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidattachChild(FileName childName) Attaches a child.protected longReturns the size of the file content (in bytes).protected InputStreamdoGetInputStream(int bufferSize) Creates an input stream to read the file content from.protected longReturns the last modified time of this file.protected FileTypeReturns the file's type.protected String[]Lists the children of the file.booleanDetermines if this file can be written to.protected voidsetTarEntry(org.apache.commons.compress.archivers.tar.TarArchiveEntry entry) Sets the details for this file object.Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileObject
canRenameTo, childrenChanged, close, compareTo, copyFrom, createFile, createFolder, delete, delete, deleteAll, doAttach, doCreateFileContent, doCreateFolder, doDelete, doDetach, doGetAttributes, doGetCertificates, doGetInputStream, doGetOutputStream, doGetRandomAccessContent, doIsExecutable, doIsHidden, doIsReadable, doIsSameFile, doIsSymbolicLink, doIsWriteable, doListChildrenResolved, doRemoveAttribute, doRename, doSetAttribute, doSetExecutable, doSetLastModifiedTime, 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, iterator, listFiles, moveTo, notifyAllStreamsClosed, onChange, onChildrenChanged, refresh, resolveFile, resolveFile, setExecutable, setReadable, setWritable, toStringMethods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.vfs2.FileObject
getPath, getURIMethods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
TarFileObject
protected TarFileObject(AbstractFileName fileName, org.apache.commons.compress.archivers.tar.TarArchiveEntry entry, TarFileSystem fileSystem, boolean tarExists) Constructs a new instance.- Parameters:
fileName- the file name.entry- the archive entry.fileSystem- the file system.tarExists- whether the tar file exists.
-
-
Method Details
-
attachChild
Attaches a child.- Parameters:
childName- Name of child to remember.
-
doGetContentSize
Returns the size of the file content (in bytes). Is only called ifdoGetType()returnsFileType.FILE.- Specified by:
doGetContentSizein classAbstractFileObject<TarFileSystem>- Returns:
- The size of the file in bytes.
-
doGetInputStream
Creates an input stream to read the file content from. Is only called ifdoGetType()returnsFileType.FILE. The input stream returned by this method is guaranteed to be closed before this method is called again.- Overrides:
doGetInputStreamin classAbstractFileObject<TarFileSystem>- Parameters:
bufferSize- Buffer size hint.- Returns:
- An InputStream to read the file content.
- Throws:
Exception- if an error occurs.
-
doGetLastModifiedTime
Returns the last modified time of this file.- Overrides:
doGetLastModifiedTimein classAbstractFileObject<TarFileSystem>- Returns:
- The last modification time.
- Throws:
Exception- if an error occurs.
-
doGetType
Returns the file's type.- Specified by:
doGetTypein classAbstractFileObject<TarFileSystem>- Returns:
- the type of the file.
-
doListChildren
Lists the children of the file.- Specified by:
doListChildrenin classAbstractFileObject<TarFileSystem>- 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.
-
isWriteable
Determines if this file can be written to.- Specified by:
isWriteablein interfaceFileObject- Overrides:
isWriteablein classAbstractFileObject<TarFileSystem>- Returns:
trueif this file is writable,falseif not.- Throws:
FileSystemException- if an error occurs.
-
setTarEntry
Sets the details for this file object. Consider this method package private. TODO Might be made package private in the next major version.- Parameters:
entry- Tar archive entry.
-