org.sejda.sambox.encryption

Enum StandardSecurityHandlerRevision

java.lang.Object

java.lang.Enum<StandardSecurityHandlerRevision>

org.sejda.sambox.encryption.StandardSecurityHandlerRevision

All Implemented Interfaces:

Serializable, Comparable<StandardSecurityHandlerRevision>

public enum StandardSecurityHandlerRevision
extends Enum<StandardSecurityHandlerRevision>

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

Author:

Andrea Vacondio

Enum Constant Summary

Enum Constants

Enum Constant and Description
R2
R3
R4
R5
R6

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
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 type with the specified name.
static StandardSecurityHandlerRevision[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

length

public final int length

Length of the encryption key in bytes

revisionNumber

public final int revisionNumber

Method Detail

values

public static StandardSecurityHandlerRevision[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StandardSecurityHandlerRevision c : StandardSecurityHandlerRevision.values())
    System.out.println(c);

Returns:

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

valueOf

public static StandardSecurityHandlerRevision valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type 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 -