net.sf.mmm.util.exception.api

Class ObjectNotFoundException

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ObjectNotFoundUserException

public class ObjectNotFoundException
extends NlsRuntimeException

An ObjectNotFoundException is thrown if an object was requested but does NOT exist or could NOT be found.
This typically happens in situations where required objects are requested by a key (e.g. in a registry- Map) but an expected object was NOT registered or the key is wrong for some reason.
If you design your API please always consider if you should return null or throw an ObjectNotFoundException.

Since:

1.0.2

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

Modifier	Constructor and Description
protected	ObjectNotFoundException() The constructor for de-serialization in GWT.
	ObjectNotFoundException(Object object) The constructor.
	ObjectNotFoundException(Object object, Object key) The constructor.
	ObjectNotFoundException(Throwable nested, Object object) The constructor.
	ObjectNotFoundException(Throwable nested, Object object, Object key) 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

ObjectNotFoundException

protected ObjectNotFoundException()

The constructor for de-serialization in GWT.

ObjectNotFoundException

public ObjectNotFoundException(Object object)

The constructor.

Parameters:

object - is a description (e.g. the classname) of the object that was required but could NOT be found.

ObjectNotFoundException

public ObjectNotFoundException(Object object,
                               Object key)

The constructor.

Parameters:

object - is a description (e.g. the classname) of the object that was required but could NOT be found.

key - is the key to the required object.

ObjectNotFoundException

public ObjectNotFoundException(Throwable nested,
                               Object object)

The constructor.

Parameters:

nested - is the cause of this exception.

object - is a description (e.g. the classname) of the object that was required but could NOT be found.

Since:

3.0.0

ObjectNotFoundException

public ObjectNotFoundException(Throwable nested,
                               Object object,
                               Object key)

The constructor.

Parameters:

nested - is the cause of this exception.

object - is a description (e.g. the classname) of the object that was required but could NOT be found.

key - is the key to the required object.

Since:

3.0.0

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