edu.harvard.hul.ois.jhove.messages

Enum JhoveMessages

java.lang.Object

java.lang.Enum<JhoveMessages>

edu.harvard.hul.ois.jhove.messages.JhoveMessages

All Implemented Interfaces:

Serializable, Comparable<JhoveMessages>

public enum JhoveMessages
extends Enum<JhoveMessages>

Utility class that handles creation of Message type instances, etc.

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	DEFAULT_MESSAGE
static String	EMPTY_MESSAGE
static String	NO_ID

Method Summary

Modifier and Type	Method and Description
static JhoveMessageFactory	getInstance(String bundleName) Get a JhoveMessageFactory instance with the requested property based bundle name and the default user locale
static JhoveMessageFactory	getInstance(String bundleName, Locale locale) Get a JhoveMessageFactory instance with the requested property based bundle name and a specific locale
static JhoveMessage	getMessageInstance(String message) Create a new message instance with a DEFAULT_ID
static JhoveMessage	getMessageInstance(String id, String message) Create a JhoveMessage instance with the give id and message value
static JhoveMessage	getMessageInstance(String id, String message, String subMessage) Create a new JhoveMessage instance with the given id, message and sub-message
static JhoveMessages	valueOf(String name) Returns the enum constant of this type with the specified name.
static JhoveMessages[]	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 JhoveMessages INSTANCE

Field Detail

NO_ID

public static final String NO_ID

See Also:

Constant Field Values

EMPTY_MESSAGE

public static final String EMPTY_MESSAGE

See Also:

Constant Field Values

DEFAULT_MESSAGE

public static final JhoveMessage DEFAULT_MESSAGE

Method Detail

values

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

Returns:

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

valueOf

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

getMessageInstance

public static JhoveMessage getMessageInstance(String message)
                                       throws IllegalArgumentException

Create a new message instance with a DEFAULT_ID

Parameters:

message - the message of the new message

Returns:

the new message instance

Throws:

IllegalArgumentException - if the id or message is null or empty

getMessageInstance

public static JhoveMessage getMessageInstance(String id,
                                              String message)
                                       throws IllegalArgumentException

Create a JhoveMessage instance with the give id and message value

Parameters:

id - the id of the new message

message - the message of the new message

Returns:

the new message instance

Throws:

IllegalArgumentException - if the id or message is null or empty

getMessageInstance

public static JhoveMessage getMessageInstance(String id,
                                              String message,
                                              String subMessage)
                                       throws IllegalArgumentException

Create a new JhoveMessage instance with the given id, message and sub-message

Parameters:

id - the id of the new message

message - the message of the new message

subMessage - the sub-message of the new message

Returns:

the new message instance

Throws:

IllegalArgumentException - if the id or message is null or empty

getInstance

public static JhoveMessageFactory getInstance(String bundleName)
                                       throws IllegalArgumentException

Get a JhoveMessageFactory instance with the requested property based bundle name and the default user locale

Parameters:

bundleName - the fully qualified resource path for the message bundle property file

Returns:

a new JhoveMessageFactory instance backed by the bundle property file.

Throws:

IllegalArgumentException - if the bundle name is empty or the message bundle can't be located

getInstance

public static JhoveMessageFactory getInstance(String bundleName,
                                              Locale locale)
                                       throws IllegalArgumentException

Get a JhoveMessageFactory instance with the requested property based bundle name and a specific locale

Parameters:

bundleName - the fully qualified resource path for the message bundle property file

locale - the locale for the message bundle

Returns:

a new JhoveMessageFactory instance backed by the bundle property file.

Throws:

IllegalArgumentException - if the bundle name is empty or the message bundle can't be located