Module xyz.apollosoftware.bibliothiki.compression

Package xyz.apollosoftware.bibliothiki.compression

Enum Class ArchiveFormat

java.lang.Object

java.lang.Enum<ArchiveFormat>

xyz.apollosoftware.bibliothiki.compression.ArchiveFormat

All Implemented Interfaces:

Serializable, Comparable<ArchiveFormat>, Constable

public enum ArchiveFormat
extends Enum<ArchiveFormat>

Archive formats supported by Bibliothiki Compression.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
TAR	The (T)ape (AR)chive (TAR) file format.
ZIP	The ZIP archive file format.

Method Summary

Modifier and Type	Method	Description
@NonNull String	getExtensionSuffix()	The canonical file extension for this file format.
static ArchiveFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ArchiveFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TAR

public static final ArchiveFormat TAR

The (T)ape (AR)chive (TAR) file format.

tar (Wikipedia)

ZIP

public static final ArchiveFormat ZIP

The ZIP archive file format.

Java's internal ZIP library is used to process ZIP archives.

ZIP (Wikipedia)

Method Details

values

public static ArchiveFormat[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ArchiveFormat valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getExtensionSuffix

public @NonNull String getExtensionSuffix()

The canonical file extension for this file format.

This can be used as a detection mechanism, however inspecting the file is preferred.

Returns:

The canonical file format extension.