net.sf.layoutParser.exception

Enum ExceptionKey

java.lang.Object

java.lang.Enum<ExceptionKey>

net.sf.layoutParser.exception.ExceptionKey

All Implemented Interfaces:

Serializable, Comparable<ExceptionKey>

public enum ExceptionKey
extends Enum<ExceptionKey>

This enum should have all the messages contained in the bundled exception properties files.
It holds only the key name of each entry, and it's used to retrieve the messages from the files.

Since:

1.0

Author:

Mário Valentim Junior

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALIAS_CLASS_NOT_FOUND Could not load class {0} for the alias {1}.
BUNDLE_NAME
DEFAULT_CLASS_NOT_FOUND Could not find the class {0} when defining defaults.
ENTRY_DUPLICATE There is already a entry "{0}" for layout {1}.
FILE_NOT_FOUND Could not load file {0}.
ITEM_CLASS_NOT_FOUND Could not load class {0} for item {1}.
ITEM_DATA_TOO_BIG Value ({0}) is bigger then expected for item {1}.
ITEM_MASK_DONT_MATCH "Mask don't match for field {0} with the value "{1}" \n\tFormat expected: {2} "{3}""
ITEM_NO_NULL_VALUE Item {0} with no value and there is no tag informed on the layout.
ITEM_NOT_COLLECTION "The type {0} associated with item {1} is not a instance of java.util.Collection."
ITEM_NULL_VALUE_TOO_BIG The value informed on tag of item {0} is bigger then the size of it informed on the layout.
LAYOUT_CLASS_NOT_FOUND "The class {0} associated with layout {1} couldn't be loaded."
LAYOUT_DUPLICATE There is already a layout named {0}.
LAYOUT_EXTENSION_NOT_FOUND Could not find a layout named {0} as a extension from {1}
LAYOUT_IGNORE_PARAMETER_OFF "The flag ignoreNonClassParameter for layout {0} was set to {1}.
LAYOUT_INVALID_FOR_PROCESSOR Layout [{0}] is invalid to be used with processor [{1}].
LAYOUT_ITEM_NOT_FOUND The property {2} could not be found for the type {1} in specified layout {0}
LAYOUT_NO_CLASS_DEFINED "There is no class associated with layout {0}.
LAYOUT_NOT_ENOUGH_INFORMATION "To retrieve a a layout the framework needs BaseNameSpaceTO.namePrefix and BaseNameSpaceTO.nameSufix properly filled.
LAYOUT_NOT_FOUND Layout {0} não foi achado.
LAYOUT_READ_DATA "Could not read data being parsed to item {0}."
LAYOUT_TOO_MANY_ITEMS Layout {0} defines more items to be read than actually exists.
LIST_LAYOUTASSOCIATION_NOT_FOUND "There's no layout named {0} referenced on list {1}.{2}"
LISTENER_CLASS_CAST Could not instantiate the listener named {0} because it does not extend the class "net.sf.layoutParser.util.callback.LayoutListener".
LISTENER_INSTANTIATION Could not instantiate the listener named {0}.
LISTENER_NOT_FOUND Could not find the listener named {0}.
MASK_NOT_FOUND Could not find the mask named {0}.
PARSE_ALIAS Could not parse alias using xpath query: {0}.
PARSE_DEFAULTS Could not parse defaults using xpath query: {0}.
PARSE_FILE Could not parse file {0}.
PARSE_LAYOUT Could not parse layout using xpath query: {0}.
PARSE_MASK Could not parse mask using xpath query: {0}.
PARSE_PLUGIN Could not parse plugin using xpath query: {0}.
PLUGIN_CLASS_NOT_FOUND Could not load class for the plugin {0}.
PLUGIN_CLASS_NOT_FOUND_FOR_ENTRY Could not find plugin for type {0} of entry {1}.
PLUGIN_INSTANTIATION Error instantiating the plugin class {0}.
PLUGIN_NO_FORMAT "No format informed on item {0}.
PROCESSOR_NOT_FOUND Could not find the processor given by class {0} for layout {1}.
SCHEMA_CHECK Error parsing {0} against schema.

Method Summary

Methods

Modifier and Type	Method and Description
String	toString() Return's the key name of the bundle.
static ExceptionKey	valueOf(String name) Returns the enum constant of this type with the specified name.
static ExceptionKey[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BUNDLE_NAME

public static final ExceptionKey BUNDLE_NAME

SCHEMA_CHECK

public static final ExceptionKey SCHEMA_CHECK

Error parsing {0} against schema.

FILE_NOT_FOUND

public static final ExceptionKey FILE_NOT_FOUND

Could not load file {0}.

PARSE_FILE

public static final ExceptionKey PARSE_FILE

Could not parse file {0}.

PARSE_MASK

public static final ExceptionKey PARSE_MASK

Could not parse mask using xpath query: {0}.

PARSE_ALIAS

public static final ExceptionKey PARSE_ALIAS

Could not parse alias using xpath query: {0}.

PARSE_LAYOUT

public static final ExceptionKey PARSE_LAYOUT

Could not parse layout using xpath query: {0}.

PARSE_PLUGIN

public static final ExceptionKey PARSE_PLUGIN

Could not parse plugin using xpath query: {0}.

PLUGIN_CLASS_NOT_FOUND

public static final ExceptionKey PLUGIN_CLASS_NOT_FOUND

Could not load class for the plugin {0}.

PLUGIN_CLASS_NOT_FOUND_FOR_ENTRY

public static final ExceptionKey PLUGIN_CLASS_NOT_FOUND_FOR_ENTRY

Could not find plugin for type {0} of entry {1}.

PLUGIN_INSTANTIATION

public static final ExceptionKey PLUGIN_INSTANTIATION

Error instantiating the plugin class {0}.

ALIAS_CLASS_NOT_FOUND

public static final ExceptionKey ALIAS_CLASS_NOT_FOUND

Could not load class {0} for the alias {1}.

ITEM_CLASS_NOT_FOUND

public static final ExceptionKey ITEM_CLASS_NOT_FOUND

Could not load class {0} for item {1}.

ITEM_DATA_TOO_BIG

public static final ExceptionKey ITEM_DATA_TOO_BIG

Value ({0}) is bigger then expected for item {1}. Expected {2} but was {3}.

LAYOUT_NO_CLASS_DEFINED

public static final ExceptionKey LAYOUT_NO_CLASS_DEFINED

"There is no class associated with layout {0}. Layout class is mandatory if you want auto discovery of item types."

LAYOUT_CLASS_NOT_FOUND

public static final ExceptionKey LAYOUT_CLASS_NOT_FOUND

"The class {0} associated with layout {1} couldn't be loaded."

LAYOUT_READ_DATA

public static final ExceptionKey LAYOUT_READ_DATA

"Could not read data being parsed to item {0}."

ITEM_NOT_COLLECTION

public static final ExceptionKey ITEM_NOT_COLLECTION

"The type {0} associated with item {1} is not a instance of java.util.Collection."

PLUGIN_NO_FORMAT

public static final ExceptionKey PLUGIN_NO_FORMAT

"No format informed on item {0}. Type {1} always must have a format declared on the xml."

LAYOUT_IGNORE_PARAMETER_OFF

public static final ExceptionKey LAYOUT_IGNORE_PARAMETER_OFF

"The flag ignoreNonClassParameter for layout {0} was set to {1}. There is not a parameter named {2} for class {3}."

ITEM_MASK_DONT_MATCH

public static final ExceptionKey ITEM_MASK_DONT_MATCH

"Mask don't match for field {0} with the value "{1}" \n\tFormat expected: {2} "{3}""

LIST_LAYOUTASSOCIATION_NOT_FOUND

public static final ExceptionKey LIST_LAYOUTASSOCIATION_NOT_FOUND

"There's no layout named {0} referenced on list {1}.{2}"

LAYOUT_NOT_ENOUGH_INFORMATION

public static final ExceptionKey LAYOUT_NOT_ENOUGH_INFORMATION

"To retrieve a a layout the framework needs BaseNameSpaceTO.namePrefix and BaseNameSpaceTO.nameSufix properly filled. Provided: BaseNameSpaceTO.namePrefix - {0} and BaseNameSpaceTO.nameSufix - {1}"

LAYOUT_NOT_FOUND

public static final ExceptionKey LAYOUT_NOT_FOUND

Layout {0} não foi achado.

MASK_NOT_FOUND

public static final ExceptionKey MASK_NOT_FOUND

Could not find the mask named {0}.

LAYOUT_DUPLICATE

public static final ExceptionKey LAYOUT_DUPLICATE

There is already a layout named {0}. Please change the name of one of those layouts.

ITEM_NO_NULL_VALUE

public static final ExceptionKey ITEM_NO_NULL_VALUE

Item {0} with no value and there is no tag informed on the layout.

ITEM_NULL_VALUE_TOO_BIG

public static final ExceptionKey ITEM_NULL_VALUE_TOO_BIG

The value informed on tag of item {0} is bigger then the size of it informed on the layout.

ENTRY_DUPLICATE

public static final ExceptionKey ENTRY_DUPLICATE

There is already a entry "{0}" for layout {1}.

LISTENER_NOT_FOUND

public static final ExceptionKey LISTENER_NOT_FOUND

Could not find the listener named {0}.

LISTENER_INSTANTIATION

public static final ExceptionKey LISTENER_INSTANTIATION

Could not instantiate the listener named {0}.

LISTENER_CLASS_CAST

public static final ExceptionKey LISTENER_CLASS_CAST

Could not instantiate the listener named {0} because it does not extend the class "net.sf.layoutParser.util.callback.LayoutListener".

LAYOUT_EXTENSION_NOT_FOUND

public static final ExceptionKey LAYOUT_EXTENSION_NOT_FOUND

Could not find a layout named {0} as a extension from {1}

PROCESSOR_NOT_FOUND

public static final ExceptionKey PROCESSOR_NOT_FOUND

Could not find the processor given by class {0} for layout {1}.

LAYOUT_TOO_MANY_ITEMS

public static final ExceptionKey LAYOUT_TOO_MANY_ITEMS

Layout {0} defines more items to be read than actually exists.

PARSE_DEFAULTS

public static final ExceptionKey PARSE_DEFAULTS

Could not parse defaults using xpath query: {0}.

DEFAULT_CLASS_NOT_FOUND

public static final ExceptionKey DEFAULT_CLASS_NOT_FOUND

Could not find the class {0} when defining defaults.

LAYOUT_INVALID_FOR_PROCESSOR

public static final ExceptionKey LAYOUT_INVALID_FOR_PROCESSOR

Layout [{0}] is invalid to be used with processor [{1}]. See log errors for more information.

LAYOUT_ITEM_NOT_FOUND

public static final ExceptionKey LAYOUT_ITEM_NOT_FOUND

The property {2} could not be found for the type {1} in specified layout {0}

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Return's the key name of the bundle.

Overrides:

toString in class Enum<ExceptionKey>

See Also:

Enum.toString()