edu.harvard.hul.ois.jhove.module.aiff

Enum MessageConstants

java.lang.Object

java.lang.Enum<MessageConstants>

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

All Implemented Interfaces:

Serializable, Comparable<MessageConstants>

public enum MessageConstants
extends Enum<MessageConstants>

Enum used to externalise the PDF 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 PDF entity causing the prohlem, e.g. FONT, or DOC.
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.

Version:

0.1 Created 1 Oct 2016:11:38:18

Author:

Carl Wilson carlwilson AT github

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Field Summary

Fields

Modifier and Type	Field and Description
static JhoveMessage	AIFF_HUL_1 Error messages
static JhoveMessage	AIFF_HUL_2
static JhoveMessage	AIFF_HUL_3
static JhoveMessage	AIFF_HUL_4
static JhoveMessage	AIFF_HUL_5
static JhoveMessage	AIFF_HUL_6
static JhoveMessage	AIFF_HUL_7
static JhoveMessage	AIFF_HUL_8
static JhoveMessage	AIFF_HUL_9

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

AIFF_HUL_1

public static final JhoveMessage AIFF_HUL_1

Error messages

AIFF_HUL_2

public static final JhoveMessage AIFF_HUL_2

AIFF_HUL_3

public static final JhoveMessage AIFF_HUL_3

AIFF_HUL_4

public static final JhoveMessage AIFF_HUL_4

AIFF_HUL_5

public static final JhoveMessage AIFF_HUL_5

AIFF_HUL_6

public static final JhoveMessage AIFF_HUL_6

AIFF_HUL_7

public static final JhoveMessage AIFF_HUL_7

AIFF_HUL_8

public static final JhoveMessage AIFF_HUL_8

AIFF_HUL_9

public static final JhoveMessage AIFF_HUL_9

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