Module xyz.apollosoftware.bibliothiki.compression

Package xyz.apollosoftware.bibliothiki.compression

Enum Class CompressionSecurityException.SecurityViolation

java.lang.Object

java.lang.Enum<CompressionSecurityException.SecurityViolation>

xyz.apollosoftware.bibliothiki.compression.CompressionSecurityException.SecurityViolation

All Implemented Interfaces:

Serializable, Comparable<CompressionSecurityException.SecurityViolation>, Constable

Enclosing class:

CompressionSecurityException

public static enum CompressionSecurityException.SecurityViolation
extends Enum<CompressionSecurityException.SecurityViolation>

The security violation that caused the exception.

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
BLANK_FILENAME	An archive entry was created (or was found in an existing archive) with a blank filename.
FORBIDDEN_ABSOLUTE_PATH	An archive entry was created (or was found in an existing archive) with an absolute file path, which is forbidden.
PATH_OUTSIDE_PARENT	An archive entry was outside of the parent directory (e.g., because of relative paths).

Method Summary

Modifier and Type	Method	Description
@NonNull String	getDefaultMessage()	Get the default message (in English) for the Security Violation.
static CompressionSecurityException.SecurityViolation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CompressionSecurityException.SecurityViolation[]	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

FORBIDDEN_ABSOLUTE_PATH

public static final CompressionSecurityException.SecurityViolation FORBIDDEN_ABSOLUTE_PATH

An archive entry was created (or was found in an existing archive) with an absolute file path, which is forbidden.

PATH_OUTSIDE_PARENT

public static final CompressionSecurityException.SecurityViolation PATH_OUTSIDE_PARENT

An archive entry was outside of the parent directory (e.g., because of relative paths).

BLANK_FILENAME

public static final CompressionSecurityException.SecurityViolation BLANK_FILENAME

An archive entry was created (or was found in an existing archive) with a blank filename.

Method Details

values

public static CompressionSecurityException.SecurityViolation[] 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 CompressionSecurityException.SecurityViolation 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

getDefaultMessage

public @NonNull String getDefaultMessage()

Get the default message (in English) for the Security Violation.

Returns:

The default error message.