Index (bibliothiki API 1.0-SNAPSHOT)

A B C D E F G H I L M N O P R S T U V W X Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addBuildMetadata(String...) - Method in class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.Builder: Add to the build metadata components.
addBuildMetadata(SemanticVersion.BuildIdentifier...) - Method in class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.Builder: Add to the build metadata components.
addPreRelease(String...) - Method in class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.Builder: Add to the pre-release components.
addPreRelease(SemanticVersion.PreReleaseIdentifier...) - Method in class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.Builder: Add to the pre-release components.
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.
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 ArchiveInputStream from the given stream.
asBuilder() - Method in record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion: Construct a SemanticVersion.Builder that has the current version's values set as initial values.
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: Build the TapeArchiveEntryHeader.UnixStandardEntryHeader.
build() - Method in class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.Builder: Build the SemanticVersion representation from the properties set on the 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).
builder() - Static method in record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion: Construct a new SemanticVersion.Builder for SemanticVersion representations.
BuildIdentifier(String) - Constructor for record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.BuildIdentifier: Construct the build metadata identifier.
buildMetadata() - Method in record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion: The list of build metadata identifiers (see SemanticVersion.BuildIdentifier).
buildMetadata(String) - Static method in record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.BuildIdentifier: A static sugar for BuildIdentifier(String).
buildMetadata(SemanticVersion.BuildIdentifier...) - Method in class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.Builder: Set the build metadata components.

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 checksum record 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
compareTo(T) - Method in interface xyz.apollosoftware.bibliothiki.versioning.Version: Compares this version with the specified version.
compareTo(SemanticVersion) - Method in record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion
compareTo(SemanticVersion.PreReleaseIdentifier) - Method in class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.PreReleaseIdentifier
compression (bibliothiki) - Section in module xyz.apollosoftware.bibliothiki.compression
compression (bibliothiki) - Section in package xyz.apollosoftware.bibliothiki.compression
CompressionException - Exception Class in xyz.apollosoftware.bibliothiki.compression: An exception that was thrown by the compression module (because of a file format issue or because of an exception raised during a compression or decompression operation).
CompressionException(String) - Constructor for exception class xyz.apollosoftware.bibliothiki.compression.CompressionException: Construct a CompressionException raised by this module directly.
CompressionException(String, Throwable) - Constructor for exception class xyz.apollosoftware.bibliothiki.compression.CompressionException: Construct a CompressionException that was ultimately caused by an exception within a different module.
CompressionSecurityException - Exception Class in xyz.apollosoftware.bibliothiki.compression: A subset of CompressionException that is caused by a specific CompressionSecurityException.SecurityViolation.
CompressionSecurityException(CompressionSecurityException.SecurityViolation) - Constructor for exception class xyz.apollosoftware.bibliothiki.compression.CompressionSecurityException: Construct a CompressionSecurityException based on the given preset CompressionSecurityException.SecurityViolation type.
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 pax extended 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: Attempts to automatically detect the archive format (and therefore the ArchiveInputStream implementation) to use for the given stream.
deviceMajorNumber() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader: Returns the value of the deviceMajorNumber record 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 deviceMinorNumber record 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.
equals(Object) - Method in record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.BuildIdentifier: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.PreReleaseIdentifier
equals(Object) - Method in interface xyz.apollosoftware.bibliothiki.versioning.Version: Indicates whether the other version object is equal to this one.
execute() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Permission: Returns the value of the execute record 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 filenamePrefix record 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 fileSize record 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 the TapeArchiveEntryHeader.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.
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 group record component.
group() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader: Returns the value of the group record 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 groupName record 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.
hasBuildMetadata() - Method in record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion: Whether the version has build metadata.
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.
hashCode() - Method in record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.BuildIdentifier: Returns a hash code value for this object.
hashCode() - Method in record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion: Returns a hash code value for this object.
hashCode() - Method in class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.PreReleaseIdentifier
hasUnixStandardHeader() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader: Returns whether the TapeArchiveEntryHeader.UnixStandardEntryHeader is present (i.e., whether the UStar fields are present).

I

Implementation Notes - Section in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveInputStream
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_SPECIAL or TapeArchiveEntryHeader.Type.BLOCK_SPECIAL).
isEquivalent(T) - Method in interface xyz.apollosoftware.bibliothiki.versioning.Version: A convenience method that invokes Version.compareTo(T) and checks whether the result is equal to zero.
isGreaterThan(T) - Method in interface xyz.apollosoftware.bibliothiki.versioning.Version: A convenience method that invokes Version.compareTo(T) and checks whether the result is greater than zero.
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.
isLessThan(T) - Method in interface xyz.apollosoftware.bibliothiki.versioning.Version: A convenience method that invokes Version.compareTo(T) and checks whether the result is less than zero.
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_LINK or TapeArchiveEntryHeader.Type.SOFT_LINK).
isMarked() - Method in class xyz.apollosoftware.bibliothiki.compression.utils.PeekableInputStream: Whether the stream is currently marked (i.e., buffering).
isNumeric() - Method in class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.PreReleaseIdentifier: Whether the identifier was parsed as a numeric value.
isPreRelease() - Method in record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion: Whether the version is a pre-release version.
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 lastModified record 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 linkedFile record 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

major() - Method in record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion: Returns the value of the major record component.
major(int) - Method in class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.Builder: Set the major version component.
MAJOR - Enum constant in enum class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.IncrementType: Increment the major version.
mark(int) - Method in class xyz.apollosoftware.bibliothiki.compression.utils.PeekableInputStream
markSupported() - Method in class xyz.apollosoftware.bibliothiki.compression.utils.PeekableInputStream
minor() - Method in record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion: Returns the value of the minor record component.
minor(int) - Method in class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.Builder: Set the minor version component.
MINOR - Enum constant in enum class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.IncrementType: Increment the minor version.
mode() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader: Returns the value of the mode record 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 name record component.
name() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader: Returns the value of the name record 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.
numericValue() - Method in class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.PreReleaseIdentifier: Get the numeric value, if there is one.

O

Overview - Section in Overview
owner() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader: Returns the value of the owner record component.
owner(long) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Builder: Set the owner of the entry.

P

parse(String) - Static method in class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.PreReleaseIdentifier: Parse the given value as a SemanticVersion.PreReleaseIdentifier.
parse(String) - Method in class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersionParser: Try to parse the given version string as a SemanticVersion.
parse(String) - Method in interface xyz.apollosoftware.bibliothiki.versioning.VersionParser: Parse the given version string.
patch() - Method in record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion: Returns the value of the patch record component.
patch(int) - Method in class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.Builder: Set the patch version component.
PATCH - Enum constant in enum class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.IncrementType: Increment the patch version.
path() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchivePaxAttributes: Returns the value of the path record 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 InputStream that is able to memoize bytes read after PeekableInputStream.mark(int) to replay them.
PeekableInputStream(InputStream) - Constructor for class xyz.apollosoftware.bibliothiki.compression.utils.PeekableInputStream: Construct a PeekableInputStream that wraps the given InputStream.
Permission(boolean, boolean, boolean) - Constructor for record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Permission: Creates an instance of a Permission record class.
permissions() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry: Returns the value of the permissions record 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 PermissionSet record class.
pipeNBytes(InputStream, OutputStream, long) - Static method in class xyz.apollosoftware.bibliothiki.compression.utils.Streams: Pipe n bytes from the given InputStream to the given OutputStream.
preRelease() - Method in record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion: The list of pre-release identifiers (see SemanticVersion.PreReleaseIdentifier).
preRelease(String) - Static method in class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.PreReleaseIdentifier: A static sugar for SemanticVersion.PreReleaseIdentifier.parse(String).
preRelease(SemanticVersion.PreReleaseIdentifier...) - Method in class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.Builder: Set the pre-release components.

R

rawValue() - Method in class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.PreReleaseIdentifier: Get the raw string value for the identifier.
read() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Permission: Returns the value of the read record 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

SemanticVersion - Record Class in xyz.apollosoftware.bibliothiki.versioning.schemes.semver: A Semantic Versioning (SemVer) version.
SemanticVersion(int, int, int, List, List) - Constructor for record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion: Constructor for semantic version representations.
SemanticVersion.Builder - Class in xyz.apollosoftware.bibliothiki.versioning.schemes.semver: A builder for a SemanticVersion.
SemanticVersion.BuildIdentifier - Record Class in xyz.apollosoftware.bibliothiki.versioning.schemes.semver: A build metadata identifier.
SemanticVersion.IncrementType - Enum Class in xyz.apollosoftware.bibliothiki.versioning.schemes.semver: Types of Semantic Versioning (SemVer) increments.
SemanticVersion.PreReleaseIdentifier - Class in xyz.apollosoftware.bibliothiki.versioning.schemes.semver: A pre-release build identifier.
SemanticVersionParser - Class in xyz.apollosoftware.bibliothiki.versioning.schemes.semver: A parser for a SemanticVersion.
SemanticVersionParser() - Constructor for class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersionParser: Construct a SemanticVersionParser.
size() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry: Returns the value of the size record 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 TapeArchiveInputStream that encapsulates the given InputStream.
TapeArchivePaxAttributes - Record Class in xyz.apollosoftware.bibliothiki.compression.formats.tar: The extended attributes data as originally defined by the pax archive 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 TapeArchivePaxAttributes record class.
Testing - Section in Overview
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.
toString() - Method in record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.BuildIdentifier: Returns a string representation of this record class.
toString() - Method in class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.PreReleaseIdentifier
toString() - Method in record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion: Returns a string representation of this record class.
toString() - Method in interface xyz.apollosoftware.bibliothiki.versioning.Version: Renders the version as either its original string, or a new equivalent string.
type() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry: Returns the value of the type record component.
type() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader: Returns the value of the type record component.
type(ArchiveEntry.Type) - Method in class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Builder: Set the ArchiveEntry.Type of the entry.
type(TapeArchiveEntryHeader.Type) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Builder: Set the TapeArchiveEntryHeader.Type of 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 unixStandardHeader record 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 user record component.
userName() - Method in record class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader: Returns the value of the userName record component.
userName(String) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder: Set the owner username of the entry.

V

value() - Method in record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.BuildIdentifier: Returns the value of the value record component.
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.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.
valueOf(String) - Static method in enum class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.IncrementType: 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.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.
values() - Static method in enum class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.IncrementType: 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 version record component.
version(int, int, int) - Method in class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.Builder: Set the core version components (major, minor and patch) all at once.
version(short) - Method in class xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder: Set the version of the entry.
Version<T> - Interface in xyz.apollosoftware.bibliothiki.versioning: A parsed representation of a version.
versioning (bibliothiki) - Section in module xyz.apollosoftware.bibliothiki.versioning
versioning (bibliothiki) - Section in package xyz.apollosoftware.bibliothiki.versioning
VersioningException - Exception Class in xyz.apollosoftware.bibliothiki.versioning: An exception that was thrown by the versioning module (because of a version formatting or semantics issue).
VersioningException(String) - Constructor for exception class xyz.apollosoftware.bibliothiki.versioning.VersioningException: Construct a VersioningException raised by this module directly.
VersionParser<T> - Interface in xyz.apollosoftware.bibliothiki.versioning: A parser for a version scheme.

W

withIncremented(SemanticVersion.IncrementType) - Method in record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion: Increments the version by performing an increment of the specified SemanticVersion.IncrementType.
withIncrementedPreRelease(String) - Method in record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion: Increments the specified pre-release version.
withIncrementedPreRelease(String, int) - Method in record class xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion: Increments the specified pre-release version.
world() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.PermissionSet: Returns the value of the world record component.
write() - Method in record class xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Permission: Returns the value of the write record 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.
xyz.apollosoftware.bibliothiki.versioning - module xyz.apollosoftware.bibliothiki.versioning: versioning (bibliothiki)
xyz.apollosoftware.bibliothiki.versioning - package xyz.apollosoftware.bibliothiki.versioning: versioning (bibliothiki)
xyz.apollosoftware.bibliothiki.versioning.schemes.semver - package xyz.apollosoftware.bibliothiki.versioning.schemes.semver: A Java implementation of Semantic Versioning 2.0.0.

Z

ZipArchiveInputStream - Class in xyz.apollosoftware.bibliothiki.compression.formats.zip: An adapter for the built-in java.util.zip capability.
ZipArchiveInputStream(InputStream) - Constructor for class xyz.apollosoftware.bibliothiki.compression.formats.zip.ZipArchiveInputStream: Construct a ZipArchiveInputStream that encapsulates the given InputStream.

A B C D E F G H I L M N O P R S T U V W X Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form