at.knowcenter.wag.egov.egiz.sig

Enum SignatureTypes.State

java.lang.Object

java.lang.Enum<SignatureTypes.State>

at.knowcenter.wag.egov.egiz.sig.SignatureTypes.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SignatureTypes.State>

Enclosing class:

SignatureTypes

public static enum SignatureTypes.State
extends java.lang.Enum<SignatureTypes.State>

Defines all supported states for SignatureTypes (signature profiles). Signature types can be enabled ("on"), can be set to support signature only ("sign_only"), to verification only ("verify_only") or can be disabled ("off" or any other value not covered by other enum values).

Enum Constant Summary

Enum Constants

Enum Constant and Description
OFF Disables a signature profile.
ON Enables a signature profile.
SIGN_ONLY Allows the signature profile to be used for signature but not for verification.
VERIFY_ONLY Restricts the signature profile so that is can only be used for verification purposes and not for signature.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSign() Returns if the respective state allows signatures.
boolean	canVerify() Returns if the respective state allows verification.
static SignatureTypes.State	fromString(java.lang.String keyWord) Returns a valid State from a given keyWord.
boolean	in(SignatureTypes.State... states) Returns true when the current state is one of the given candidate states.
static SignatureTypes.State	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SignatureTypes.State[]	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

ON

public static final SignatureTypes.State ON

Enables a signature profile.

OFF

public static final SignatureTypes.State OFF

Disables a signature profile.

VERIFY_ONLY

public static final SignatureTypes.State VERIFY_ONLY

Restricts the signature profile so that is can only be used for verification purposes and not for signature.

SIGN_ONLY

public static final SignatureTypes.State SIGN_ONLY

Allows the signature profile to be used for signature but not for verification.

Method Detail

values

public static SignatureTypes.State[] 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 (SignatureTypes.State c : SignatureTypes.State.values())
    System.out.println(c);

Returns:

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

valueOf

public static SignatureTypes.State valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

fromString

public static SignatureTypes.State fromString(java.lang.String keyWord)

Returns a valid State from a given keyWord. If the keyWord cannot be matched to a certain state, the default State OFF is returned.

Parameters:

keyWord - A valid keyword like "on", "sign_only"...

Returns:

The enum State.

in

public boolean in(SignatureTypes.State... states)

Returns true when the current state is one of the given candidate states.

Parameters:

states - The candidate states.

Returns:

true when the current state is one of the given candidate states, false if not.

canSign

public boolean canSign()

Returns if the respective state allows signatures.

Returns:

true if signatures are allowed, false if not.

canVerify

public boolean canVerify()

Returns if the respective state allows verification.

Returns:

true if verification is allowed, false if not.