net.sf.mmm.util.exception.api

Class NlsUnsupportedOperationException

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.NlsUnsupportedOperationException

All Implemented Interfaces:

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

public class NlsUnsupportedOperationException
extends NlsRuntimeException

An NlsUnsupportedOperationException is thrown if an operation was invoked that is NOT implemented or generally NOT supported.
ATTENTION:
Please always consider to avoid APIs that throw such exception and use inheritance instead (e.g. if there was a ReadOnlyIterator such as Enumeration that Iterator extends).

Since:

1.0.2

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

UnsupportedOperationException, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGE_CODE
private static long	serialVersionUID UID for serialization.

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

Constructor and Description
NlsUnsupportedOperationException() The constructor.
NlsUnsupportedOperationException(Object operation) The constructor.
NlsUnsupportedOperationException(Object operation, Object source) 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

UID for serialization.

See Also:

Constant Field Values

MESSAGE_CODE

public static final String MESSAGE_CODE

See Also:

getCode(), Constant Field Values

Constructor Detail

NlsUnsupportedOperationException

public NlsUnsupportedOperationException()

The constructor.

NlsUnsupportedOperationException

public NlsUnsupportedOperationException(Object operation)

The constructor.

Parameters:

operation - is a description (e.g. the Method or a string with the name of the class and method) of the operation that is NOT supported.

NlsUnsupportedOperationException

public NlsUnsupportedOperationException(Object operation,
                                        Object source)

The constructor.

Parameters:

operation - is a description (e.g. the Method or a string with the name of the class and method) of the operation that is NOT supported.

source - is the source object that does not support the operation.

Method Detail

getCode

public String getCode()

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