net.sf.layoutParser.build.messages

Enum Messages

java.lang.Object

java.lang.Enum<Messages>

net.sf.layoutParser.build.messages.Messages

All Implemented Interfaces:

Serializable, Comparable<Messages>

public enum Messages
extends Enum<Messages>

Handles the localisation of messaging.

Since:

Author:

Leonardo Bueno Postacchini

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALIAS_ADED Message for adding alias to types, takes two placehoders: alias name, class name.
ENTRY_EMPTY_FILLER Message indicating an entry index is not valid, takes two placeholders: layout name, entry name.
ENTRY_INVALID_INDEX Message indicating an entry index is not valid, takes three placeholders: layout name, entry name, index.
ENTRY_INVALID_SIZE Message indicating that a entry has an invalid size.
PLUGIN_ADDED Message for adding plugins, takes two placeholders: type handler class, handled class name.

Method Summary

Methods

Modifier and Type	Method and Description
String	format(Object... arguments) Format the message replacing the placeholders with the arguments.
static Messages	valueOf(String name) Returns the enum constant of this type with the specified name.
static Messages[]	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

ALIAS_ADED

public static final Messages ALIAS_ADED

Message for adding alias to types, takes two placehoders: alias name, class name.

PLUGIN_ADDED

public static final Messages PLUGIN_ADDED

Message for adding plugins, takes two placeholders: type handler class, handled class name.

ENTRY_INVALID_INDEX

public static final Messages ENTRY_INVALID_INDEX

Message indicating an entry index is not valid, takes three placeholders: layout name, entry name, index.

ENTRY_EMPTY_FILLER

public static final Messages ENTRY_EMPTY_FILLER

Message indicating an entry index is not valid, takes two placeholders: layout name, entry name.

ENTRY_INVALID_SIZE

public static final Messages ENTRY_INVALID_SIZE

Message indicating that a entry has an invalid size. Takes four placeholders: size, entry name, layout name, processor class.

Method Detail

values

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

Returns:

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

valueOf

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

format

public String format(Object... arguments)

Format the message replacing the placeholders with the arguments.

Parameters:

arguments - The arguments to take place of placeholders.

Returns:

The localised message formated.