Package org.openpreservation.messages

Enum Class Messages

java.lang.Object

java.lang.Enum<Messages>

org.openpreservation.messages.Messages

All Implemented Interfaces:

Serializable, Comparable<Messages>, java.lang.constant.Constable

public enum Messages
extends Enum<Messages>

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

Author:

Carl Wilson carlwilson AT github

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE	Ensure Messages is a singleton

Field Summary

Fields

Modifier and Type	Field	Description
static final Message	DEFAULT_MESSAGE
static final String	EMPTY_MESSAGE
static final String	NO_ID

Method Summary

Modifier and Type	Method	Description
static MessageFactory	getInstance()	Get a MessageFactory instance with the default property based bundle name and the default user locale
static MessageFactory	getInstance(String bundleName)	Get a MessageFactory instance with the requested property based bundle name and the default user locale
static MessageFactory	getInstance(String bundleName, Locale locale)	Get a MessageFactory instance with the requested property based bundle name and a specific locale
static Message	getMessageInstance(String message)	Create a new message instance with a DEFAULT_ID
static Message	getMessageInstance(String id, Message.Severity severity, String message)	Create a Message instance with the give id and message value
static Message	getMessageInstance(String id, Message.Severity severity, String message, String subMessage)	Create a new Message instance with the given id, message and sub-message
static MessageLog	messageLogInstance()
static MessageLog	messageLogInstance(String path, List<Message> messages)
static Messages	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Messages[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTANCE

public static final Messages INSTANCE

Ensure Messages is a singleton

Field Details

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 Message DEFAULT_MESSAGE

Method Details

values

public static Messages[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Messages valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getMessageInstance

public static Message 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 Message getMessageInstance(String id,
 Message.Severity severity,
 String message)
                                  throws IllegalArgumentException

Create a Message 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 Message getMessageInstance(String id,
 Message.Severity severity,
 String message,
 String subMessage)
                                  throws IllegalArgumentException

Create a new Message 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 MessageFactory getInstance()
                                  throws IllegalArgumentException

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

Returns:

a new MessageFactory 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 MessageFactory getInstance(String bundleName)
                                  throws IllegalArgumentException

Get a MessageFactory 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 MessageFactory 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 MessageFactory getInstance(String bundleName,
 Locale locale)
                                  throws IllegalArgumentException

Get a MessageFactory 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 MessageFactory instance backed by the bundle property file.

Throws:

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

messageLogInstance

public static MessageLog messageLogInstance()

messageLogInstance

public static MessageLog messageLogInstance(String path,
 List<Message> messages)