edu.harvard.hul.ois.jhove.module.jpeg2000

Enum MessageConstants

java.lang.Object

java.lang.Enum<MessageConstants>

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

All Implemented Interfaces:

Serializable, Comparable<MessageConstants>

public enum MessageConstants
extends Enum<MessageConstants>

Enum used to externalise the JPEG 2000 modules 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 JPEG 2000 entity causing the prohlem, e.g. BOX, FILE_TYPE_BOX, COC_MARKER, etc.
3. PROBLEM_LOCATION: the location or component inside the entity, e.g. POSITION, SIZE, TYPE, NUMBER_OF_ENTRIES, etc.
4. PROBLEM_TYPE: a short indicator of the problem type, e.g. MISSING, INVALID, EMPTY, OVERRUN, UNDERRUN, 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.

Version:

0.1 Created 27 Apr 2017:09:39:41

Author:

Martin Hoppenheit marhop AT github

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Field Summary

Fields

Modifier and Type	Field and Description
static String	INF_BINARY_FILTER_BOX_NOT_GZIP Information messages
static String	INF_FRAGMENT_LIST_BOX_EXT_FILE_REFERENCE
static JhoveMessage	JPEG2000_HUL_10
static JhoveMessage	JPEG2000_HUL_11
static JhoveMessage	JPEG2000_HUL_12
static JhoveMessage	JPEG2000_HUL_13
static JhoveMessage	JPEG2000_HUL_14
static JhoveMessage	JPEG2000_HUL_15
static JhoveMessage	JPEG2000_HUL_16
static JhoveMessage	JPEG2000_HUL_17
static JhoveMessage	JPEG2000_HUL_18
static JhoveMessage	JPEG2000_HUL_19
static JhoveMessage	JPEG2000_HUL_20
static JhoveMessage	JPEG2000_HUL_21
static JhoveMessage	JPEG2000_HUL_22
static JhoveMessage	JPEG2000_HUL_23
static JhoveMessage	JPEG2000_HUL_24
static JhoveMessage	JPEG2000_HUL_25
static JhoveMessage	JPEG2000_HUL_26
static JhoveMessage	JPEG2000_HUL_27
static JhoveMessage	JPEG2000_HUL_28
static JhoveMessage	JPEG2000_HUL_29
static JhoveMessage	JPEG2000_HUL_3 Error messages
static JhoveMessage	JPEG2000_HUL_30
static JhoveMessage	JPEG2000_HUL_31
static JhoveMessage	JPEG2000_HUL_32
static JhoveMessage	JPEG2000_HUL_33
static JhoveMessage	JPEG2000_HUL_34
static JhoveMessage	JPEG2000_HUL_35
static JhoveMessage	JPEG2000_HUL_36
static JhoveMessage	JPEG2000_HUL_37
static JhoveMessage	JPEG2000_HUL_38
static JhoveMessage	JPEG2000_HUL_39
static JhoveMessage	JPEG2000_HUL_4
static JhoveMessage	JPEG2000_HUL_40
static JhoveMessage	JPEG2000_HUL_41
static JhoveMessage	JPEG2000_HUL_42
static JhoveMessage	JPEG2000_HUL_43
static JhoveMessage	JPEG2000_HUL_44
static JhoveMessage	JPEG2000_HUL_45
static JhoveMessage	JPEG2000_HUL_46
static JhoveMessage	JPEG2000_HUL_47
static JhoveMessage	JPEG2000_HUL_48
static JhoveMessage	JPEG2000_HUL_49
static JhoveMessage	JPEG2000_HUL_5
static JhoveMessage	JPEG2000_HUL_50
static JhoveMessage	JPEG2000_HUL_51
static JhoveMessage	JPEG2000_HUL_52
static JhoveMessage	JPEG2000_HUL_53
static JhoveMessage	JPEG2000_HUL_54
static JhoveMessage	JPEG2000_HUL_55
static JhoveMessage	JPEG2000_HUL_56
static JhoveMessage	JPEG2000_HUL_6
static JhoveMessage	JPEG2000_HUL_7
static JhoveMessage	JPEG2000_HUL_8
static JhoveMessage	JPEG2000_HUL_9
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_BINARY_FILTER_BOX_NOT_GZIP

public static final String INF_BINARY_FILTER_BOX_NOT_GZIP

Information messages

See Also:

Constant Field Values

INF_FRAGMENT_LIST_BOX_EXT_FILE_REFERENCE

public static final String INF_FRAGMENT_LIST_BOX_EXT_FILE_REFERENCE

See Also:

Constant Field Values

JPEG2000_HUL_3

public static final JhoveMessage JPEG2000_HUL_3

Error messages

JPEG2000_HUL_4

public static final JhoveMessage JPEG2000_HUL_4

JPEG2000_HUL_5

public static final JhoveMessage JPEG2000_HUL_5

JPEG2000_HUL_6

public static final JhoveMessage JPEG2000_HUL_6

JPEG2000_HUL_7

public static final JhoveMessage JPEG2000_HUL_7

JPEG2000_HUL_8

public static final JhoveMessage JPEG2000_HUL_8

JPEG2000_HUL_9

public static final JhoveMessage JPEG2000_HUL_9

JPEG2000_HUL_10

public static final JhoveMessage JPEG2000_HUL_10

JPEG2000_HUL_11

public static final JhoveMessage JPEG2000_HUL_11

JPEG2000_HUL_12

public static final JhoveMessage JPEG2000_HUL_12

JPEG2000_HUL_13

public static final JhoveMessage JPEG2000_HUL_13

JPEG2000_HUL_14

public static final JhoveMessage JPEG2000_HUL_14

JPEG2000_HUL_15

public static final JhoveMessage JPEG2000_HUL_15

JPEG2000_HUL_16

public static final JhoveMessage JPEG2000_HUL_16

JPEG2000_HUL_17

public static final JhoveMessage JPEG2000_HUL_17

JPEG2000_HUL_18

public static final JhoveMessage JPEG2000_HUL_18

JPEG2000_HUL_19

public static final JhoveMessage JPEG2000_HUL_19

JPEG2000_HUL_20

public static final JhoveMessage JPEG2000_HUL_20

JPEG2000_HUL_21

public static final JhoveMessage JPEG2000_HUL_21

JPEG2000_HUL_22

public static final JhoveMessage JPEG2000_HUL_22

JPEG2000_HUL_23

public static final JhoveMessage JPEG2000_HUL_23

JPEG2000_HUL_24

public static final JhoveMessage JPEG2000_HUL_24

JPEG2000_HUL_25

public static final JhoveMessage JPEG2000_HUL_25

JPEG2000_HUL_26

public static final JhoveMessage JPEG2000_HUL_26

JPEG2000_HUL_27

public static final JhoveMessage JPEG2000_HUL_27

JPEG2000_HUL_28

public static final JhoveMessage JPEG2000_HUL_28

JPEG2000_HUL_29

public static final JhoveMessage JPEG2000_HUL_29

JPEG2000_HUL_30

public static final JhoveMessage JPEG2000_HUL_30

JPEG2000_HUL_31

public static final JhoveMessage JPEG2000_HUL_31

JPEG2000_HUL_32

public static final JhoveMessage JPEG2000_HUL_32

JPEG2000_HUL_33

public static final JhoveMessage JPEG2000_HUL_33

JPEG2000_HUL_34

public static final JhoveMessage JPEG2000_HUL_34

JPEG2000_HUL_35

public static final JhoveMessage JPEG2000_HUL_35

JPEG2000_HUL_36

public static final JhoveMessage JPEG2000_HUL_36

JPEG2000_HUL_37

public static final JhoveMessage JPEG2000_HUL_37

JPEG2000_HUL_38

public static final JhoveMessage JPEG2000_HUL_38

JPEG2000_HUL_39

public static final JhoveMessage JPEG2000_HUL_39

JPEG2000_HUL_40

public static final JhoveMessage JPEG2000_HUL_40

JPEG2000_HUL_41

public static final JhoveMessage JPEG2000_HUL_41

JPEG2000_HUL_42

public static final JhoveMessage JPEG2000_HUL_42

JPEG2000_HUL_43

public static final JhoveMessage JPEG2000_HUL_43

JPEG2000_HUL_44

public static final JhoveMessage JPEG2000_HUL_44

JPEG2000_HUL_45

public static final JhoveMessage JPEG2000_HUL_45

JPEG2000_HUL_46

public static final JhoveMessage JPEG2000_HUL_46

JPEG2000_HUL_47

public static final JhoveMessage JPEG2000_HUL_47

JPEG2000_HUL_48

public static final JhoveMessage JPEG2000_HUL_48

JPEG2000_HUL_49

public static final JhoveMessage JPEG2000_HUL_49

JPEG2000_HUL_50

public static final JhoveMessage JPEG2000_HUL_50

JPEG2000_HUL_51

public static final JhoveMessage JPEG2000_HUL_51

JPEG2000_HUL_52

public static final JhoveMessage JPEG2000_HUL_52

JPEG2000_HUL_53

public static final JhoveMessage JPEG2000_HUL_53

JPEG2000_HUL_54

public static final JhoveMessage JPEG2000_HUL_54

JPEG2000_HUL_55

public static final JhoveMessage JPEG2000_HUL_55

JPEG2000_HUL_56

public static final JhoveMessage JPEG2000_HUL_56

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