net.sf.mmm.util.exception.api

Class NlsParseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

net.sf.mmm.util.exception.api.NlsRuntimeException

net.sf.mmm.util.exception.api.NlsParseException

All Implemented Interfaces:

Serializable, Cloneable, NlsThrowable, AttributeReadMessage, AttributeReadMessageCode, AttributeReadUuid, NlsObject

public class NlsParseException
extends NlsRuntimeException

The NlsParseException is thrown if some data could NOT be parsed because it does NOT match the according format (pattern or grammar).

Since:

1.1.1

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGE_CODE
private static long	serialVersionUID

Fields inherited from interface net.sf.mmm.util.nls.api.NlsObject

KEY_ANNOTATION, KEY_ARGUMENT, KEY_CAPACITY, KEY_CONTAINER, KEY_DEFAULT, KEY_DIRECTORY, KEY_ERROR, KEY_EXISTING, KEY_EXPECTED, KEY_FILE, KEY_FUNCTION, KEY_ID, KEY_KEY, KEY_LOCATION, KEY_MAX, KEY_MIN, KEY_MODE, KEY_NAME, KEY_OBJECT, KEY_OPERAND, KEY_OPERATION, KEY_OPTION, KEY_PATH, KEY_PROPERTY, KEY_QUERY, KEY_RESOURCE, KEY_SIZE, KEY_SOURCE, KEY_TARGET_TYPE, KEY_TITLE, KEY_TYPE, KEY_URI, KEY_USER, KEY_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NlsParseException() The constructor for de-serialization in GWT.
	NlsParseException(CharSequence value, CharSequence expected) The constructor.
	NlsParseException(CharSequence value, CharSequence requiredFormat, Object type) The constructor.
	NlsParseException(CharSequence value, CharSequence requiredFormat, Object type, Object valueSource) The constructor.
	NlsParseException(Object value, Type targetType) The constructor.
	NlsParseException(Object value, Type targetType, Object valueSource) The constructor.
	NlsParseException(Throwable nested, CharSequence value, CharSequence expected) The constructor.
	NlsParseException(Throwable nested, CharSequence value, CharSequence requiredFormat, Object type) The constructor.
	NlsParseException(Throwable nested, CharSequence value, CharSequence requiredFormat, Object type, Object valueSource) The constructor.
	NlsParseException(Throwable nested, Object value, Type targetType) The constructor.
	NlsParseException(Throwable nested, Object value, Type targetType, Object valueSource) The constructor.

Method Summary

Modifier and Type	Method and Description
String	getCode() This method gets the code that identifies the detailed type of this object.

Methods inherited from class net.sf.mmm.util.exception.api.NlsRuntimeException

createBundle, createCopy, createCopyViaClone, createUuid, getLocalizedMessage, getLocalizedMessage, getLocalizedMessage, getMessage, getNlsMessage, getUuid, isForUser, isTechnical, printStackTrace, printStackTrace, toNlsMessage, toString, toString, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.mmm.util.exception.api.NlsThrowable

getCause, getStackTrace

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

MESSAGE_CODE

public static final String MESSAGE_CODE

See Also:

getCode(), Constant Field Values

Constructor Detail

NlsParseException

protected NlsParseException()

The constructor for de-serialization in GWT.

NlsParseException

public NlsParseException(CharSequence value,
                         CharSequence expected)

The constructor.

Parameters:

value - is the value that could NOT be parsed.

expected - is the string or character that was expected but not found at the end of value.

NlsParseException

public NlsParseException(Throwable nested,
                         CharSequence value,
                         CharSequence expected)

The constructor.

Parameters:

nested - is the cause of this exception.

value - is the value that could NOT be parsed.

expected - is the string or character that was expected but not found at the end of value.

Since:

3.0.0

NlsParseException

public NlsParseException(CharSequence value,
                         CharSequence requiredFormat,
                         Object type)

The constructor.

Parameters:

value - is the value that could NOT be parsed.

requiredFormat - describes the expected format (e.g. "[+-][0-9]*[.][0-9]+")

type - is type the given value should be converted to.

NlsParseException

public NlsParseException(CharSequence value,
                         CharSequence requiredFormat,
                         Object type,
                         Object valueSource)

The constructor.

Parameters:

value - is the value that could NOT be parsed.

requiredFormat - describes the expected format (e.g. "[+-][0-9]*[.][0-9]+")

type - is type the given value should be converted to.

valueSource - describes the source of the value. This may be the filename where the value was read from, an XPath where the value was located in an XML document, etc. It is used in exceptions thrown if something goes wrong. This will help to find the problem easier.

NlsParseException

public NlsParseException(Throwable nested,
                         CharSequence value,
                         CharSequence requiredFormat,
                         Object type)

The constructor.

Parameters:

nested - is the cause of this exception.

value - is the value that could NOT be parsed.

requiredFormat - describes the expected format (e.g. "[+-][0-9]*[.][0-9]+")

type - is type the given value should be converted to.

NlsParseException

public NlsParseException(Throwable nested,
                         CharSequence value,
                         CharSequence requiredFormat,
                         Object type,
                         Object valueSource)

The constructor.

Parameters:

nested - is the cause of this exception.

value - is the value that could NOT be parsed.

requiredFormat - describes the expected format (e.g. "[+-][0-9]*[.][0-9]+")

type - is type the given value should be converted to.

valueSource - describes the source of the value. This may be the filename where the value was read from, an XPath where the value was located in an XML document, etc. It is used in exceptions thrown if something goes wrong. This will help to find the problem easier.

NlsParseException

public NlsParseException(Object value,
                         Type targetType,
                         Object valueSource)

The constructor.

Parameters:

value - is the value that could NOT be parsed.

targetType - is type the given value should be converted to.

valueSource - describes the source of the value. This may be the filename where the value was read from, an XPath where the value was located in an XML document, etc. It is used in exceptions thrown if something goes wrong. This will help to find the problem easier.

NlsParseException

public NlsParseException(Throwable nested,
                         Object value,
                         Type targetType,
                         Object valueSource)

The constructor.

Parameters:

nested - is the cause of this exception.

value - is the value that could NOT be parsed.

targetType - is type the given value should be converted to.

valueSource - describes the source of the value. This may be the filename where the value was read from, an XPath where the value was located in an XML document, etc. It is used in exceptions thrown if something goes wrong. This will help to find the problem easier.

NlsParseException

public NlsParseException(Object value,
                         Type targetType)

The constructor.

Parameters:

value - is the value that could NOT be parsed.

targetType - is type the given value should be converted to.

NlsParseException

public NlsParseException(Throwable nested,
                         Object value,
                         Type targetType)

The constructor.

Parameters:

nested - is the cause of this exception.

value - is the value that could NOT be parsed.

targetType - is type the given value should be converted to.

Method Detail

getCode

public String getCode()

Description copied from interface: AttributeReadMessageCode

This method gets the code that identifies the detailed type of this object. While UUID or ID are typically unique per instance of an object the code is unique for all instances of the exact same kind. So e.g. a particular kind of exception or ValidationFailure can be identified by its code. A simple generic implementation may return the classname or the key of the NLS message. However, the code should remain stable after refactoring (so at least after the rename the previous code should be returned as String literal). This code may be used as a compact identifier to reference the related problem or information as well as for automatic tests of error situations that should remain stable even if the message text gets improved or the locale is unknown.

Specified by:

getCode in interface AttributeReadMessageCode

Overrides:

getCode in class NlsRuntimeException

Returns:

the message text.

See Also:

Throwable.getMessage(), NlsThrowable, Message