Module org.sejda.sambox

Package org.sejda.sambox.encryption

Enum Class StandardSecurityHandlerRevision

java.lang.Object

java.lang.Enum<StandardSecurityHandlerRevision>

org.sejda.sambox.encryption.StandardSecurityHandlerRevision

All Implemented Interfaces:

Serializable, Comparable<StandardSecurityHandlerRevision>, Constable

public enum StandardSecurityHandlerRevision
extends Enum<StandardSecurityHandlerRevision>

Possible Standard Security Handler revisions with bytes length of the encryption key associated to that revision

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
R2
R3
R4
R5
R6

Field Summary

Fields

Modifier and Type	Field	Description
final int	length	Length of the encryption key in bytes
final int	revisionNumber

Constructor Summary

Constructors

Modifier	Constructor	Description
private	StandardSecurityHandlerRevision(int length, int revisionNumber)

Method Summary

Modifier and Type	Method	Description
private static void	require(boolean condition, String message)
void	require(StandardSecurityHandlerRevision rev, String message)	Requires this revision to be the same version as the given one.
void	requireAtLeast(StandardSecurityHandlerRevision rev, String message)	Requires this revision to be at least the same version as the given one.
static StandardSecurityHandlerRevision	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StandardSecurityHandlerRevision[]	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

R2

public static final StandardSecurityHandlerRevision R2

R3

public static final StandardSecurityHandlerRevision R3

R4

public static final StandardSecurityHandlerRevision R4

R5

public static final StandardSecurityHandlerRevision R5

R6

public static final StandardSecurityHandlerRevision R6

Field Details

length

public final int length

Length of the encryption key in bytes

revisionNumber

public final int revisionNumber

Constructor Details

StandardSecurityHandlerRevision

private StandardSecurityHandlerRevision(int length,
 int revisionNumber)

Method Details

values

public static StandardSecurityHandlerRevision[] 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 StandardSecurityHandlerRevision 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

require

public void require(StandardSecurityHandlerRevision rev,
 String message)

Requires this revision to be the same version as the given one. Throws an EncryptionException otherwise.

Parameters:

rev -

message - the exception message

Throws:

EncryptionException - if rev is different

requireAtLeast

public void requireAtLeast(StandardSecurityHandlerRevision rev,
 String message)

Requires this revision to be at least the same version as the given one. Throws an EncryptionException otherwise.

Parameters:

rev -

message -

require

private static void require(boolean condition,
 String message)