Module io.github.mmm.base

Package io.github.mmm.base.exception

Class ObjectNotFoundException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.github.mmm.base.exception.ApplicationException

io.github.mmm.base.exception.ObjectNotFoundException

All Implemented Interfaces:

Localizable, LocalizableObject, Serializable

public class ObjectNotFoundException
extends ApplicationException

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 consider carefully if you should return null or throw an ObjectNotFoundException.

Since:

1.0.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MESSAGE_CODE

Fields inherited from interface io.github.mmm.base.i18n.Localizable

BUNDLE_PREFIX

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ObjectNotFoundException(Localizable message, Throwable cause)	The constructor.
	ObjectNotFoundException(Object object)	The constructor.
	ObjectNotFoundException(Object object, Object key)	The constructor.
	ObjectNotFoundException(Object object, Object key, Object options, Throwable cause)	The constructor.
	ObjectNotFoundException(Object object, Object key, Throwable cause)	The constructor.

Method Summary

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

Methods inherited from class io.github.mmm.base.exception.ApplicationException

createUuid, getLocalizedMessage, getLocalizedMessage, getLocalizedMessage, getMessage, getNlsMessage, getNlsMessage, getUuid, isForUser, isTechnical, printStackTrace, 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 io.github.mmm.base.i18n.Localizable

getArgument, toLocalizable

Field Details

MESSAGE_CODE

public static final String MESSAGE_CODE

See Also:

• getCode()
• Constant Field Values

Constructor Details

ObjectNotFoundException

public ObjectNotFoundException(Object object)

The constructor.

Parameters:

object - the 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 - the description (e.g. the classname) of the object that was required but could NOT be found.

key - the key to the required object.

ObjectNotFoundException

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

The constructor.

Parameters:

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

key - the key to the required object.

cause - the cause of this exception.

ObjectNotFoundException

public ObjectNotFoundException(Object object,
 Object key,
 Object options,
 Throwable cause)

The constructor.

Parameters:

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

key - the key to the required object.

options - the available options (e.g. Collection of comma separated String of the available keys).

cause - the cause of this exception.

ObjectNotFoundException

protected ObjectNotFoundException(Localizable message,
 Throwable cause)

The constructor.

Parameters:

message - the NLS message.

cause - the cause of this exception. May be null.

Method Details

getCode

public String getCode()

Description copied from class: ApplicationException

This method gets the code that identifies the detailed type of this object. While UUID is unique per instance of a ApplicationException this code is a short and readable identifier representing the ApplicationException Class. The default implementation returns the simple name. 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.

Overrides:

getCode in class ApplicationException

Returns:

the error code.