edu.harvard.hul.ois.jhove

Enum SignatureUseType

java.lang.Object

java.lang.Enum<SignatureUseType>

edu.harvard.hul.ois.jhove.SignatureUseType

All Implemented Interfaces:

Serializable, Comparable<SignatureUseType>

public enum SignatureUseType
extends Enum<SignatureUseType>

This class defines enumerated use types for a Signature in a module. These give information on whether a signature is required in valid content. Applications will not create or modify SignatureUseTypes, but will use one of the predefined SignatureUseType instances MANDATORY, MANDATORY_IF_APPLICABLE, or OPTIONAL.

See Also:

Signature

Enum Constant Summary

Enum Constants

Enum Constant and Description
MANDATORY Use type for a required signature
MANDATORY_IF_APPLICABLE Use type for a conditionally required signature.
OPTIONAL Use type for an optional signature.

Field Summary

Fields

Modifier and Type	Field and Description
String	name A String name for the type, used for reporting.

Method Summary

Modifier and Type	Method and Description
String	toString()
static SignatureUseType	valueOf(String name) Returns the enum constant of this type with the specified name.
static SignatureUseType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MANDATORY

public static final SignatureUseType MANDATORY

Use type for a required signature

MANDATORY_IF_APPLICABLE

public static final SignatureUseType MANDATORY_IF_APPLICABLE

Use type for a conditionally required signature.

OPTIONAL

public static final SignatureUseType OPTIONAL

Use type for an optional signature.

Field Detail

name

public final String name

A String name for the type, used for reporting.

Method Detail

values

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

Returns:

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

valueOf

public static SignatureUseType 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

toString

public String toString()

Overrides:

toString in class Enum<SignatureUseType>