A B C D E F G I J O P R S T U V X Z
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AR - org.rauschig.jarchivelib.ArchiveFormat
-
Constant used to identify the AR archive format.
- ArchiveEntry - Interface in org.rauschig.jarchivelib
-
The entry of an archive.
- ArchiveFormat - Enum in org.rauschig.jarchivelib
-
Denotes an archive format such as zip or tar.
- Archiver - Interface in org.rauschig.jarchivelib
-
An Archiver facades a specific archiving library, allowing for simple archiving of files and directories, and extraction of archives.
- ArchiverFactory - Class in org.rauschig.jarchivelib
-
Factory for creating
Archiverinstances by a given archiver type name. - ArchiveStream - Class in org.rauschig.jarchivelib
-
An input stream of an archive.
- ArchiveStream() - Constructor for class org.rauschig.jarchivelib.ArchiveStream
B
- BZIP2 - org.rauschig.jarchivelib.CompressionType
-
Constant used to identify the BZIP2 compression algorithm.
C
- close() - Method in class org.rauschig.jarchivelib.ArchiveStream
- closeQuietly(Closeable) - Static method in class org.rauschig.jarchivelib.IOUtils
-
Null-safe method that calls
Closeable.close()and chokes the IOException. - compress(File, File) - Method in interface org.rauschig.jarchivelib.Compressor
-
Compresses the given input file to the given destination directory or file.
- CompressionType - Enum in org.rauschig.jarchivelib
-
Denotes a compression algorithm such as gzip or bzip2
- Compressor - Interface in org.rauschig.jarchivelib
-
A compressor facades a specific compression library, allowing for simple compression and decompression of files.
- CompressorFactory - Class in org.rauschig.jarchivelib
-
Factory for creating
Compressorinstances by a given compression algorithm. - copy(InputStream, File) - Static method in class org.rauschig.jarchivelib.IOUtils
-
Copies the content of an InputStream into a destination File.
- copy(InputStream, OutputStream) - Static method in class org.rauschig.jarchivelib.IOUtils
-
Copies the content of a InputStream into an OutputStream.
- copy(InputStream, OutputStream, int) - Static method in class org.rauschig.jarchivelib.IOUtils
-
Copies the entire content of the given InputStream into the given OutputStream.
- CPIO - org.rauschig.jarchivelib.ArchiveFormat
-
Constant used to identify the CPIO archive format.
- create(String, File, File) - Method in interface org.rauschig.jarchivelib.Archiver
-
Creates an archive from the given source file or directory, and saves it into the given destination.
- create(String, File, File...) - Method in interface org.rauschig.jarchivelib.Archiver
-
Creates an archive from the given source files or directories, and saves it into the given destination.
- createArchiver(File) - Static method in class org.rauschig.jarchivelib.ArchiverFactory
-
Probes the given
Filefor its file type and creates anArchiverbased on this file type. - createArchiver(String) - Static method in class org.rauschig.jarchivelib.ArchiverFactory
-
Creates an Archiver for the given archive format.
- createArchiver(String, String) - Static method in class org.rauschig.jarchivelib.ArchiverFactory
-
Creates an Archiver for the given archive format that uses compression.
- createArchiver(ArchiveFormat) - Static method in class org.rauschig.jarchivelib.ArchiverFactory
-
Creates an Archiver for the given archive format.
- createArchiver(ArchiveFormat, CompressionType) - Static method in class org.rauschig.jarchivelib.ArchiverFactory
-
Creates an Archiver for the given archive format that uses compression.
- createArchiver(FileType) - Static method in class org.rauschig.jarchivelib.ArchiverFactory
-
Creates an Archiver that handles the given
FileType. - createCompressor(File) - Static method in class org.rauschig.jarchivelib.CompressorFactory
-
Probes the given
Filefor its file type and creates aCompressorbased on this file type. - createCompressor(String) - Static method in class org.rauschig.jarchivelib.CompressorFactory
-
Creates a compressor from the given compression type.
- createCompressor(CompressionType) - Static method in class org.rauschig.jarchivelib.CompressorFactory
-
Creates a compressor from the given CompressionType.
- createCompressor(FileType) - Static method in class org.rauschig.jarchivelib.CompressorFactory
-
Creates a new
Compressorfor the givenFileType. - createNextEntry() - Method in class org.rauschig.jarchivelib.ArchiveStream
-
Abstract method to create the next
ArchiveEntryfor theArchiveStreamimplementation.
D
- decompress(File, File) - Method in interface org.rauschig.jarchivelib.Compressor
-
Decompresses the given source file to the given destination directory or file.
- decompressingStream(InputStream) - Method in interface org.rauschig.jarchivelib.Compressor
-
Accept a stream and wrap it in a decompressing stream suitable for the current compressor.
- DUMP - org.rauschig.jarchivelib.ArchiveFormat
-
Constant used to identify the Unix DUMP archive format.
E
- extract(File) - Method in interface org.rauschig.jarchivelib.ArchiveEntry
-
Extracts the entry to the given destination directory.
- extract(File, File) - Method in interface org.rauschig.jarchivelib.Archiver
-
Extracts the given archive file into the given destination directory.
- extract(InputStream, File) - Method in interface org.rauschig.jarchivelib.Archiver
-
Extracts the given archive supplied as an input stream into the given destination directory.
F
- filesContainedIn(File) - Static method in class org.rauschig.jarchivelib.IOUtils
-
Given a source File, return its direct descendants if the File is a directory.
- FileType - Class in org.rauschig.jarchivelib
-
Holds the file extension as String and the corresponding
ArchiveFormatand/orCompressionType. - fromString(String) - Static method in enum org.rauschig.jarchivelib.ArchiveFormat
-
Attempts to return the
ArchiveFormatinstance from a possible given string representation. - fromString(String) - Static method in enum org.rauschig.jarchivelib.CompressionType
-
Attempts to return the
CompressionTypeinstance from a possible given string representation.
G
- get(File) - Static method in class org.rauschig.jarchivelib.FileType
-
Checks the suffix of the given
Filefor an entry in the map. - get(String) - Static method in class org.rauschig.jarchivelib.FileType
-
Checks the suffix of the given string for an entry in the map.
- getArchiveFormat() - Method in class org.rauschig.jarchivelib.FileType
-
Returns the archive format corresponding to this file extension if any.
- getCompressionType() - Method in class org.rauschig.jarchivelib.FileType
-
Returns the compression type corresponding to this file extension if any.
- getCurrentEntry() - Method in class org.rauschig.jarchivelib.ArchiveStream
-
Returns the
ArchiveEntrythe stream currently points to. - getDefaultFileExtension() - Method in enum org.rauschig.jarchivelib.ArchiveFormat
-
Returns the default file extension for this compression type.
- getDefaultFileExtension() - Method in enum org.rauschig.jarchivelib.CompressionType
-
Returns the default file extension for this compression type.
- getFilenameExtension() - Method in interface org.rauschig.jarchivelib.Archiver
-
Returns the filename extension that indicates the file format this archiver handles.
- getFilenameExtension() - Method in interface org.rauschig.jarchivelib.Compressor
-
Returns the filename extension that indicates the file format this compressor handles.
- getLastModifiedDate() - Method in interface org.rauschig.jarchivelib.ArchiveEntry
-
Returns the last modified date of the entry.
- getName() - Method in interface org.rauschig.jarchivelib.ArchiveEntry
-
The name of the entry in the archive.
- getName() - Method in enum org.rauschig.jarchivelib.ArchiveFormat
-
Returns the name by which the archive format is identified.
- getName() - Method in enum org.rauschig.jarchivelib.CompressionType
-
Returns the name by which the compression algorithm is identified.
- getNextEntry() - Method in class org.rauschig.jarchivelib.ArchiveStream
-
Moves the pointer of the stream to the next
ArchiveEntryand returns it. - getSize() - Method in interface org.rauschig.jarchivelib.ArchiveEntry
-
The (uncompressed) size of the entry.
- getSuffix() - Method in class org.rauschig.jarchivelib.FileType
-
Returns the file extension suffix (e.g.
- GZIP - org.rauschig.jarchivelib.CompressionType
-
Constant used to identify the GZIP compression algorithm.
I
- IOUtils - Class in org.rauschig.jarchivelib
-
Utility class for I/O operations.
- isArchive() - Method in class org.rauschig.jarchivelib.FileType
-
Returns true if the given file extension denotes an archive.
- isClosed() - Method in class org.rauschig.jarchivelib.ArchiveStream
-
Checks whether the current stream has been closed
- isCompressed() - Method in class org.rauschig.jarchivelib.FileType
-
Returns true if the given file extension denotes a compressed file.
- isDirectory() - Method in interface org.rauschig.jarchivelib.ArchiveEntry
-
Checks whether the given entry is a directory.
- isValidArchiveFormat(String) - Static method in enum org.rauschig.jarchivelib.ArchiveFormat
-
Checks if the given archive format name is valid and known format.
- isValidCompressionType(String) - Static method in enum org.rauschig.jarchivelib.CompressionType
-
Checks if the given compression type name is valid and known format.
J
- JAR - org.rauschig.jarchivelib.ArchiveFormat
-
Constant used to identify the JAR archive format.
O
- org.rauschig.jarchivelib - package org.rauschig.jarchivelib
P
- PACK200 - org.rauschig.jarchivelib.CompressionType
-
Constant used to identify the PACK200 compression algorithm.
R
- relativePath(File, File) - Static method in class org.rauschig.jarchivelib.IOUtils
-
Computes the path name of a file node relative to a given root node.
- requireDirectory(File) - Static method in class org.rauschig.jarchivelib.IOUtils
-
Makes sure that the given
Fileis either a writable directory, or that it does not exist and a directory can be created at its path.
S
- SEVEN_Z - org.rauschig.jarchivelib.ArchiveFormat
-
Constant used to identify the 7z archive format.
- stream(File) - Method in interface org.rauschig.jarchivelib.Archiver
-
Reads the given archive file as an
ArchiveStreamwhich is used to access individualArchiveEntryobjects within the archive without extracting the archive onto the file system.
T
- TAR - org.rauschig.jarchivelib.ArchiveFormat
-
Constant used to identify the TAR archive format.
- toString() - Method in class org.rauschig.jarchivelib.FileType
U
- UNKNOWN - Static variable in class org.rauschig.jarchivelib.FileType
-
Special case object for an unknown archive/compression file type.
- UNKNOWN_SIZE - Static variable in interface org.rauschig.jarchivelib.ArchiveEntry
-
Special value indicating that the size is unknown
V
- valueOf(String) - Static method in enum org.rauschig.jarchivelib.ArchiveFormat
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.rauschig.jarchivelib.CompressionType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.rauschig.jarchivelib.ArchiveFormat
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.rauschig.jarchivelib.CompressionType
-
Returns an array containing the constants of this enum type, in the order they are declared.
X
- XZ - org.rauschig.jarchivelib.CompressionType
-
Constant used to identify the XZ compression algorithm.
Z
- ZIP - org.rauschig.jarchivelib.ArchiveFormat
-
Constant used to identify the ZIP archive format.
All Classes All Packages