edu.harvard.hul.ois.jhove.module.html

Enum MessageConstants

java.lang.Object

java.lang.Enum<MessageConstants>

edu.harvard.hul.ois.jhove.module.html.MessageConstants

All Implemented Interfaces:

Serializable, Comparable<MessageConstants>

public enum MessageConstants
extends Enum<MessageConstants>

Enum used to externalise the XML module message Strings. Using an enum INSTANCE as a "trick" to ensure a single instance of the class. String constants should be prefixed according to their use in the module:

• WRN_ for warning strings, often logger messages.
• INF_ for informational messages.
• ERR_ for error messages that indicate a file is invalid or not well formed.

When adding new messages try to adopt the following order for the naming elements:

1. PREFIX: one of the three prefixes from the list above.
2. ENTITY_NAME: the name of the entity causing the problem.
3. Problem: a short indicator of the problem type, e.g. MISSING, ILLEGAL, etc.

The elements should be separated by underscores. The messages currently don't follow a consistent vocabulary, that is terms such as invalid, illegal, or malformed are used without definition.

Author:

Thomas Ledoux

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Field Summary

Fields

Modifier and Type	Field and Description
static JhoveMessage	HTML_HUL_1
static JhoveMessage	HTML_HUL_10
static JhoveMessage	HTML_HUL_11
static JhoveMessage	HTML_HUL_12
static JhoveMessage	HTML_HUL_13
static JhoveMessage	HTML_HUL_14
static JhoveMessage	HTML_HUL_15
static JhoveMessage	HTML_HUL_16
static JhoveMessage	HTML_HUL_17
static JhoveMessage	HTML_HUL_18
static JhoveMessage	HTML_HUL_19
static JhoveMessage	HTML_HUL_2
static JhoveMessage	HTML_HUL_20
static JhoveMessage	HTML_HUL_21
static JhoveMessage	HTML_HUL_3
static JhoveMessage	HTML_HUL_4
static JhoveMessage	HTML_HUL_5
static JhoveMessage	HTML_HUL_6
static JhoveMessage	HTML_HUL_7
static JhoveMessage	HTML_HUL_8
static JhoveMessage	HTML_HUL_9
static String	INF_EOL_TYPE_UNDET
static String	INF_HTML_VER_UNSPPRTD
static JhoveMessage	JHOVE_1
static JhoveMessage	JHOVE_2
static JhoveMessage	JHOVE_3
static JhoveMessageFactory	messageFactory

Method Summary

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

INSTANCE

public static final MessageConstants INSTANCE

Field Detail

messageFactory

public static final JhoveMessageFactory messageFactory

INF_HTML_VER_UNSPPRTD

public static final String INF_HTML_VER_UNSPPRTD

See Also:

Constant Field Values

INF_EOL_TYPE_UNDET

public static final String INF_EOL_TYPE_UNDET

See Also:

Constant Field Values

HTML_HUL_1

public static final JhoveMessage HTML_HUL_1

HTML_HUL_2

public static final JhoveMessage HTML_HUL_2

HTML_HUL_3

public static final JhoveMessage HTML_HUL_3

HTML_HUL_4

public static final JhoveMessage HTML_HUL_4

HTML_HUL_5

public static final JhoveMessage HTML_HUL_5

HTML_HUL_6

public static final JhoveMessage HTML_HUL_6

HTML_HUL_7

public static final JhoveMessage HTML_HUL_7

HTML_HUL_8

public static final JhoveMessage HTML_HUL_8

HTML_HUL_9

public static final JhoveMessage HTML_HUL_9

HTML_HUL_10

public static final JhoveMessage HTML_HUL_10

HTML_HUL_11

public static final JhoveMessage HTML_HUL_11

HTML_HUL_12

public static final JhoveMessage HTML_HUL_12

HTML_HUL_13

public static final JhoveMessage HTML_HUL_13

HTML_HUL_14

public static final JhoveMessage HTML_HUL_14

HTML_HUL_15

public static final JhoveMessage HTML_HUL_15

HTML_HUL_16

public static final JhoveMessage HTML_HUL_16

HTML_HUL_17

public static final JhoveMessage HTML_HUL_17

HTML_HUL_18

public static final JhoveMessage HTML_HUL_18

HTML_HUL_19

public static final JhoveMessage HTML_HUL_19

HTML_HUL_20

public static final JhoveMessage HTML_HUL_20

HTML_HUL_21

public static final JhoveMessage HTML_HUL_21

JHOVE_1

public static final JhoveMessage JHOVE_1

JHOVE_2

public static final JhoveMessage JHOVE_2

JHOVE_3

public static final JhoveMessage JHOVE_3

Method Detail

values

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

Returns:

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

valueOf

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