Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- ArchiveEntry - Record Class in xyz.apollosoftware.bibliothiki.compression
-
An entry found in an archive.
- ArchiveEntry(String, ArchiveEntry.Type, ArchiveEntry.PermissionSet, Long) - Constructor for record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry
-
Construct an entry found in an archive.
- ArchiveEntry.Builder - Class in xyz.apollosoftware.bibliothiki.compression
-
The builder for
ArchiveEntry. - ArchiveEntry.Permission - Record Class in xyz.apollosoftware.bibliothiki.compression
-
Permission flags for a single target (e.g., user, group or world).
- ArchiveEntry.PermissionSet - Record Class in xyz.apollosoftware.bibliothiki.compression
-
A set of permissions.
- ArchiveEntry.Type - Enum Class in xyz.apollosoftware.bibliothiki.compression
-
The type of
ArchiveEntry. - ArchiveFormat - Enum Class in xyz.apollosoftware.bibliothiki.compression
-
Archive formats supported by Bibliothiki Compression.
- ArchiveInputStream - Class in xyz.apollosoftware.bibliothiki.compression
-
Process an archive one entry at a time.
- ArchiveInputStream(InputStream) - Constructor for class xyz.apollosoftware.bibliothiki.compression.ArchiveInputStream
-
Construct an
ArchiveInputStreamfrom the given stream. - available() - Method in class xyz.apollosoftware.bibliothiki.compression.utils.PeekableInputStream
-
Get an estimate of the number of bytes available in the stream.
B
- BLANK_FILENAME - Enum constant in enum class xyz.apollosoftware.bibliothiki.compression.CompressionSecurityException.SecurityViolation
-
An archive entry was created (or was found in an existing archive) with a blank filename.
- BLOCK_SPECIAL - Enum constant in enum class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Type
-
A UNIX block (device) special file.
- build() - Method in class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Builder
-
Build the
ArchiveEntry. - build() - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Builder
-
Build the
TapeArchiveEntryHeader. - build() - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder
- builder() - Static method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry
-
Create a builder for an
ArchiveEntry. - builder() - Static method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
Create a builder for a
TapeArchiveEntryHeader. - builder() - Static method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader
-
Create a builder for a UStar header (
TapeArchiveEntryHeader.UnixStandardEntryHeader).
C
- CHARACTER_SPECIAL - Enum constant in enum class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Type
-
A UNIX character (device) special file.
- checksum() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
Returns the value of the
checksumrecord component. - checksum(long) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Builder
-
Set the checksum of the entry.
- close() - Method in class xyz.apollosoftware.bibliothiki.compression.ArchiveInputStream
- close() - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveInputStream
- close() - Method in class xyz.apollosoftware.bibliothiki.compression.formats.zip.ZipArchiveInputStream
- close() - Method in class xyz.apollosoftware.bibliothiki.compression.utils.PeekableInputStream
- closeCurrentEntry() - Method in class xyz.apollosoftware.bibliothiki.compression.ArchiveInputStream
-
Close the current entry.
- closeCurrentEntry() - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveInputStream
- closeCurrentEntry() - Method in class xyz.apollosoftware.bibliothiki.compression.formats.zip.ZipArchiveInputStream
- CompressionException - Exception in xyz.apollosoftware.bibliothiki.compression
-
An exception that was thrown by the compression library (because of a file format issue or because of an exception raised during a compression or decompression operation).
- CompressionException(String) - Constructor for exception xyz.apollosoftware.bibliothiki.compression.CompressionException
-
Construct a
CompressionExceptionraised by the library directly. - CompressionException(String, Throwable) - Constructor for exception xyz.apollosoftware.bibliothiki.compression.CompressionException
-
Construct a
CompressionExceptionthat was ultimately caused by an exception within a different library. - CompressionSecurityException - Exception in xyz.apollosoftware.bibliothiki.compression
-
A subset of
CompressionExceptionthat is caused by a specificCompressionSecurityException.SecurityViolation. - CompressionSecurityException(CompressionSecurityException.SecurityViolation) - Constructor for exception xyz.apollosoftware.bibliothiki.compression.CompressionSecurityException
-
Construct a
CompressionSecurityExceptionbased on the given presetCompressionSecurityException.SecurityViolationtype. - CompressionSecurityException.SecurityViolation - Enum Class in xyz.apollosoftware.bibliothiki.compression
-
The security violation that caused the exception.
- CONTIGUOUS_FILE - Enum constant in enum class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Type
-
A contiguous file.
D
- decode(int) - Static method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Permission
-
Decode the permission from the numeric value.
- decode(long) - Static method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.PermissionSet
-
Decode the permission set from the numeric value.
- decode(String) - Static method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchivePaxAttributes
-
Decode the
paxextended attributes from the given value. - decode(ByteBuffer) - Static method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
Decode a header from its binary representation.
- detect(InputStream) - Static method in class xyz.apollosoftware.bibliothiki.compression.ArchiveInputStream
-
Automatically detects the archive format (and therefore the
ArchiveInputStreamimplementation) to use for the given stream. - deviceMajorNumber() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader
-
Returns the value of the
deviceMajorNumberrecord component. - deviceMajorNumber(long) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder
-
Set the device major version number of the entry.
- deviceMinorNumber() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader
-
Returns the value of the
deviceMinorNumberrecord component. - deviceMinorNumber(long) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder
-
Set the device minor version number of the entry.
- DIRECTORY - Enum constant in enum class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Type
-
A directory (folder).
- DIRECTORY - Enum constant in enum class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Type
-
A directory (folder).
E
- ensurePeekable(InputStream) - Static method in class xyz.apollosoftware.bibliothiki.compression.utils.PeekableInputStream
-
If, for the given stream,
InputStream.markSupported()returns true, this method is a no-op, returning the provided stream. - equals(Object) - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Permission
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.PermissionSet
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchivePaxAttributes
-
Indicates whether some other object is "equal to" this one.
- execute() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Permission
-
Returns the value of the
executerecord component. - EXECUTE_MASK - Static variable in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Permission
-
The execute permission bit mask (UNIX
0b001). - EXTENDED_HEADER_WITH_METADATA - Enum constant in enum class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Type
-
An extended header with metadata for the next file in the archive (POSIX.1-2001).
F
- FIFO - Enum constant in enum class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Type
-
A FIFO (named pipe).
- FILE - Enum constant in enum class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Type
-
An ordinary file.
- FILENAME_LENGTH_BYTES - Static variable in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
The length, in bytes, of the file path and name field.
- FILENAME_PREFIX_LENGTH_BYTES - Static variable in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
The length, in bytes, of the file path and name prefix.
- filenamePrefix() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader
-
Returns the value of the
filenamePrefixrecord component. - filenamePrefix(String) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder
-
Set the filename prefix of the entry.
- fileSize() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
Returns the value of the
fileSizerecord component. - fileSize(long) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Builder
-
Set the fileSize of the entry.
- FORBIDDEN_ABSOLUTE_PATH - Enum constant in enum class xyz.apollosoftware.bibliothiki.compression.CompressionSecurityException.SecurityViolation
-
An archive entry was created (or was found in an existing archive) with an absolute file path, which is forbidden.
- FULL_FILENAME_LENGTH_BYTES - Static variable in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
The maximum name that can be stored in a
TapeArchiveEntryHeader, including theTapeArchiveEntryHeader.UnixStandardEntryHeader.
G
- getByValue(byte) - Static method in enum class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Type
-
Resolve the type by its byte value.
- getDefaultMessage() - Method in enum class xyz.apollosoftware.bibliothiki.compression.CompressionSecurityException.SecurityViolation
-
Get the default message (in English) for the Security Violation.
- getExtensionSuffix() - Method in enum class xyz.apollosoftware.bibliothiki.compression.ArchiveFormat
-
The canonical file extension for this file format.
- getFullName() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
Get the full name of the entry.
- getNextEntry() - Method in class xyz.apollosoftware.bibliothiki.compression.ArchiveInputStream
-
Get the next entry in the archive.
- getNextEntry() - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveInputStream
- getNextEntry() - Method in class xyz.apollosoftware.bibliothiki.compression.formats.zip.ZipArchiveInputStream
- getValue() - Method in enum class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Type
-
The byte value used in the UNIX Standard entry header for the type of file.
- GLOBAL_EXTENDED_HEADER - Enum constant in enum class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Type
-
A "global extended header with metadata" (POSIX.1-2001).
- group() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.PermissionSet
-
Returns the value of the
grouprecord component. - group() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
Returns the value of the
grouprecord component. - group(long) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Builder
-
Set the group of the entry.
- groupName() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader
-
Returns the value of the
groupNamerecord component. - groupName(String) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder
-
Set the owner group name of the entry.
H
- HARD_LINK - Enum constant in enum class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Type
-
Hard link to another file (from elsewhere in the archive).
- HARD_LINK - Enum constant in enum class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Type
-
A hard link to another file in the archive.
- hashCode() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry
-
Returns a hash code value for this object.
- hashCode() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Permission
-
Returns a hash code value for this object.
- hashCode() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.PermissionSet
-
Returns a hash code value for this object.
- hashCode() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
Returns a hash code value for this object.
- hashCode() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader
-
Returns a hash code value for this object.
- hashCode() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchivePaxAttributes
-
Returns a hash code value for this object.
- hasUnixStandardHeader() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
Returns whether the
TapeArchiveEntryHeader.UnixStandardEntryHeaderis present (i.e., whether the UStar fields are present).
I
- INDICATOR - Static variable in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader
-
The ASCII bytes for 'ustar' are used as the indicator for a
TapeArchiveEntryHeader.UnixStandardEntryHeader. - isDevice() - Method in enum class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Type
-
Whether the entry type is a special/device entry (i.e.,
TapeArchiveEntryHeader.Type.CHARACTER_SPECIALorTapeArchiveEntryHeader.Type.BLOCK_SPECIAL). - isGzipStream(InputStream) - Static method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveInputStream
-
Peek the first two bytes of the stream to see if they match the GZIP magic number.
- isLink() - Method in enum class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Type
-
Whether the entry type is a link (i.e.,
TapeArchiveEntryHeader.Type.HARD_LINKorTapeArchiveEntryHeader.Type.SOFT_LINK). - isMarked() - Method in class xyz.apollosoftware.bibliothiki.compression.utils.PeekableInputStream
-
Whether the stream is currently marked (i.e., buffering).
- isTarStream(InputStream) - Static method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveInputStream
-
Peek the first 512 bytes (TAR header) of the stream to see if the stream contains TAR data.
- isZipStream(InputStream) - Static method in class xyz.apollosoftware.bibliothiki.compression.formats.zip.ZipArchiveInputStream
-
Peek the first four bytes of the stream to see if they match the ZIP magic number.
L
- lastModified() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
Returns the value of the
lastModifiedrecord component. - lastModified(Instant) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Builder
-
Set the last modification timestamp of the entry.
- LENGTH_BYTES - Static variable in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
The length, in bytes, of the tape archive header.
- linkedFile() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
Returns the value of the
linkedFilerecord component. - linkedFile(String) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Builder
-
Set the linked file of the entry (relevant only to types where
TapeArchiveEntryHeader.Type.isLink()is true).
M
- mark(int) - Method in class xyz.apollosoftware.bibliothiki.compression.utils.PeekableInputStream
- markSupported() - Method in class xyz.apollosoftware.bibliothiki.compression.utils.PeekableInputStream
- mode() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
Returns the value of the
moderecord component. - mode(long) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Builder
-
Set the mode of the entry.
N
- name() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry
-
Returns the value of the
namerecord component. - name() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
Returns the value of the
namerecord component. - name(String) - Method in class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Builder
-
Set the name (qualified file path) of the entry.
- name(String) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Builder
-
Set the name of the entry.
- NORMAL - Enum constant in enum class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Type
-
A normal file.
O
- owner() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
Returns the value of the
ownerrecord component. - owner(long) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Builder
-
Set the owner of the entry.
P
- path() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchivePaxAttributes
-
Returns the value of the
pathrecord component. - PATH_OUTSIDE_PARENT - Enum constant in enum class xyz.apollosoftware.bibliothiki.compression.CompressionSecurityException.SecurityViolation
-
An archive entry was outside of the parent directory (e.g., because of relative paths).
- PeekableInputStream - Class in xyz.apollosoftware.bibliothiki.compression.utils
-
A wrapper for
InputStreamthat is able to memoize bytes read afterPeekableInputStream.mark(int)to replay them. - PeekableInputStream(InputStream) - Constructor for class xyz.apollosoftware.bibliothiki.compression.utils.PeekableInputStream
-
Construct a
PeekableInputStreamthat wraps the givenInputStream. - Permission(boolean, boolean, boolean) - Constructor for record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Permission
-
Creates an instance of a
Permissionrecord class. - permissions() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry
-
Returns the value of the
permissionsrecord component. - permissions(ArchiveEntry.PermissionSet) - Method in class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Builder
-
Set the UNIX permissions of the entry.
- PermissionSet(ArchiveEntry.Permission, ArchiveEntry.Permission, ArchiveEntry.Permission) - Constructor for record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.PermissionSet
-
Creates an instance of a
PermissionSetrecord class. - pipeNBytes(InputStream, OutputStream, long) - Static method in class xyz.apollosoftware.bibliothiki.compression.utils.Streams
-
Pipe n bytes from the given
InputStreamto the givenOutputStream.
R
- read() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Permission
-
Returns the value of the
readrecord component. - read() - Method in class xyz.apollosoftware.bibliothiki.compression.utils.PeekableInputStream
- READ_MASK - Static variable in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Permission
-
The read permission bit mask (UNIX
0b100). - reset() - Method in class xyz.apollosoftware.bibliothiki.compression.utils.PeekableInputStream
- resolveFile(File, boolean) - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry
-
Resolve a reference to a file, relative to the given
parent.
S
- size() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry
-
Returns the value of the
sizerecord component. - size(Long) - Method in class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Builder
-
Set the file size, in bytes, of the entry.
- SOFT_LINK - Enum constant in enum class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Type
-
Soft (symbolic) link to another file.
- SOFT_LINK - Enum constant in enum class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Type
-
A soft (symbolic) link to another file that may be in the archive or may exist elsewhere on the system.
- stream - Variable in class xyz.apollosoftware.bibliothiki.compression.ArchiveInputStream
-
The stream of compressed data.
- Streams - Class in xyz.apollosoftware.bibliothiki.compression.utils
-
Utility methods for working with streams.
T
- TapeArchiveEntryHeader - Record Class in xyz.apollosoftware.bibliothiki.compression.formats.tar
-
The header for a Tape Archive file.
- TapeArchiveEntryHeader(String, long, long, long, long, Instant, long, TapeArchiveEntryHeader.Type, String, TapeArchiveEntryHeader.UnixStandardEntryHeader) - Constructor for record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
Construct a header for a tar archive.
- TapeArchiveEntryHeader.Builder - Class in xyz.apollosoftware.bibliothiki.compression.formats.tar
-
The builder for
TapeArchiveEntryHeader. - TapeArchiveEntryHeader.Type - Enum Class in xyz.apollosoftware.bibliothiki.compression.formats.tar
-
The type of tape archive entry.
- TapeArchiveEntryHeader.UnixStandardEntryHeader - Record Class in xyz.apollosoftware.bibliothiki.compression.formats.tar
-
The UStar (UNIX Standard tar) format extends the nominal tar header to include additional fields.
- TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder - Class in xyz.apollosoftware.bibliothiki.compression.formats.tar
-
The builder for
TapeArchiveEntryHeader.UnixStandardEntryHeader. - TapeArchiveInputStream - Class in xyz.apollosoftware.bibliothiki.compression.formats.tar
-
Support for reading (T)ape (AR)chive (TAR) files.
- TapeArchiveInputStream(InputStream) - Constructor for class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveInputStream
-
Construct a
TapeArchiveInputStreamthat encapsulates the givenInputStream. - TapeArchivePaxAttributes - Record Class in xyz.apollosoftware.bibliothiki.compression.formats.tar
-
The extended attributes data as originally defined by the
paxarchive utility and codified in POSIX.1-2001. - TapeArchivePaxAttributes(String) - Constructor for record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchivePaxAttributes
-
Creates an instance of a
TapeArchivePaxAttributesrecord class. - TAR - Enum constant in enum class xyz.apollosoftware.bibliothiki.compression.ArchiveFormat
-
The (T)ape (AR)chive (TAR) file format.
- toString() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Permission
-
Returns a string representation of this record class.
- toString() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.PermissionSet
-
Returns a string representation of this record class.
- toString() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry
-
Returns a string representation of this record class.
- toString() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
Returns a string representation of this record class.
- toString() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader
-
Returns a string representation of this record class.
- toString() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchivePaxAttributes
-
Returns a string representation of this record class.
- type() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry
-
Returns the value of the
typerecord component. - type() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
Returns the value of the
typerecord component. - type(ArchiveEntry.Type) - Method in class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Builder
-
Set the
ArchiveEntry.Typeof the entry. - type(TapeArchiveEntryHeader.Type) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Builder
-
Set the
TapeArchiveEntryHeader.Typeof the entry.
U
- UnixStandardEntryHeader(short, String, String, long, long, String) - Constructor for record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader
-
Construct a UNIX Standard (UStar) header for a tar archive header.
- unixStandardHeader() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader
-
Returns the value of the
unixStandardHeaderrecord component. - unixStandardHeader(TapeArchiveEntryHeader.UnixStandardEntryHeader) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Builder
-
Set the (UStar) UNIX Standard header information of the entry.
- user() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.PermissionSet
-
Returns the value of the
userrecord component. - userName() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader
-
Returns the value of the
userNamerecord component. - userName(String) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder
-
Set the owner username of the entry.
V
- valueOf(String) - Static method in enum class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class xyz.apollosoftware.bibliothiki.compression.ArchiveFormat
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class xyz.apollosoftware.bibliothiki.compression.CompressionSecurityException.SecurityViolation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Type
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class xyz.apollosoftware.bibliothiki.compression.ArchiveFormat
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class xyz.apollosoftware.bibliothiki.compression.CompressionSecurityException.SecurityViolation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- version() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader
-
Returns the value of the
versionrecord component. - version(short) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder
-
Set the version of the entry.
W
- world() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.PermissionSet
-
Returns the value of the
worldrecord component. - write() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Permission
-
Returns the value of the
writerecord component. - WRITE_MASK - Static variable in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Permission
-
The write permission bit mask (UNIX
0b010). - writeCurrentEntryTo(OutputStream) - Method in class xyz.apollosoftware.bibliothiki.compression.ArchiveInputStream
-
Write the current archive entry to the given
OutputStream. - writeCurrentEntryTo(OutputStream) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveInputStream
- writeCurrentEntryTo(OutputStream) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.zip.ZipArchiveInputStream
X
- xyz.apollosoftware.bibliothiki.compression - module xyz.apollosoftware.bibliothiki.compression
-
compression (bibliothiki)
- xyz.apollosoftware.bibliothiki.compression - package xyz.apollosoftware.bibliothiki.compression
-
compression (bibliothiki)
- xyz.apollosoftware.bibliothiki.compression.formats.tar - package xyz.apollosoftware.bibliothiki.compression.formats.tar
-
Support for the (T)ape (AR)chive (TAR) file format.
- xyz.apollosoftware.bibliothiki.compression.formats.zip - package xyz.apollosoftware.bibliothiki.compression.formats.zip
-
Support for the ZIP file format.
- xyz.apollosoftware.bibliothiki.compression.utils - package xyz.apollosoftware.bibliothiki.compression.utils
-
Currently only intended for internal use.
Z
- ZIP - Enum constant in enum class xyz.apollosoftware.bibliothiki.compression.ArchiveFormat
-
The ZIP archive file format.
- ZipArchiveInputStream - Class in xyz.apollosoftware.bibliothiki.compression.formats.zip
-
An adapter for the built-in
java.util.zipcapability. - ZipArchiveInputStream(InputStream) - Constructor for class xyz.apollosoftware.bibliothiki.compression.formats.zip.ZipArchiveInputStream
-
Construct a
ZipArchiveInputStreamthat encapsulates the givenInputStream.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form