net.sf.mmm.util.exception.api

Class DuplicateObjectException

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DuplicateObjectUserException

public class DuplicateObjectException
extends NlsRuntimeException

An DuplicateObjectException is thrown if an object was rejected because it is a duplicate. This typically happens if objects are registered (e.g. in a Map) and two objects should be associated with the same key.

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

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	DuplicateObjectException() The constructor for de-serialization in GWT.
	DuplicateObjectException(Object object) The constructor.
	DuplicateObjectException(Object object, Object key) The constructor.
	DuplicateObjectException(Object object, Object key, Object existing) 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.
static <KEY,VALUE> void	put(Map<KEY,VALUE> map, KEY key, VALUE value) This method puts the given value into the given map using the given key.

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

DuplicateObjectException

protected DuplicateObjectException()

The constructor for de-serialization in GWT.

DuplicateObjectException

public DuplicateObjectException(Object object)

The constructor.

Parameters:

object - is the object that was rejected because it is a duplicate.

DuplicateObjectException

public DuplicateObjectException(Object object,
                                Object key)

The constructor.

Parameters:

object - is the object that was rejected because it is a duplicate.

key - is the key the object could NOT be associated with because it already leads to another object.

DuplicateObjectException

public DuplicateObjectException(Object object,
                                Object key,
                                Object existing)

The constructor.

Parameters:

object - is the object that was rejected because it is a duplicate.

key - is the key the object could NOT be associated with because it already leads to another object.

existing - is the object that is already registered for the given key.

Since:

3.0.0

Method Detail

put

public static <KEY,VALUE> void put(Map<KEY,VALUE> map,
                                   KEY key,
                                   VALUE value)
                            throws DuplicateObjectException

This method puts the given value into the given map using the given key.

Type Parameters:

KEY - is the generic type of the key.

VALUE - is the generic type of the value.

Parameters:

map - is the Map.

key - is the key.

value - is the value to put.

Throws:

DuplicateObjectException - if the given map already contains a value for the given key that is NOT equal to the given value.

Since:

3.0.0

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