Package org.fuin.ddd4j.ddd

Class EntityNotFoundException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.fuin.ddd4j.ddd.EntityNotFoundException

All Implemented Interfaces:

Serializable, org.fuin.objects4j.common.ExceptionShortIdentifable, org.fuin.objects4j.common.MarshalInformation<EntityNotFoundException.Data>

public final class EntityNotFoundException
extends Exception
implements org.fuin.objects4j.common.ExceptionShortIdentifable, org.fuin.objects4j.common.MarshalInformation<EntityNotFoundException.Data>

Signals that an entity was not found.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EntityNotFoundException.Data	Specific exception data.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ELEMENT_NAME	Unique name of the element to use for XML and JSON marshalling/unmarshalling.
static String	SHORT_ID	Unique short identifier of this exception.

Constructor Summary

Constructors

Constructor	Description
EntityNotFoundException(@NotNull EntityIdPath entityIdPath)	Constructor with entity identifier path.
EntityNotFoundException(EntityIdPath parentIdPath, @NotNull EntityId entityId)	Constructor with all data.

Method Summary

Modifier and Type	Method	Description
EntityNotFoundException.Data	getData()	Returns the exception specific data.
Class<EntityNotFoundException.Data>	getDataClass()
String	getDataElement()
@NotNull String	getEntityId()	Returns the unique identifier of the entity.
@NotNull String	getParentIdPath()	Returns the path from root to parent.
String	getShortId()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

SHORT_ID

public static final String SHORT_ID

Unique short identifier of this exception.

See Also:

Constant Field Values

ELEMENT_NAME

public static final String ELEMENT_NAME

Unique name of the element to use for XML and JSON marshalling/unmarshalling.

See Also:

Constant Field Values

Constructor Detail

EntityNotFoundException

public EntityNotFoundException(@Nullable
                               EntityIdPath parentIdPath,
                               @NotNull
                               @NotNull EntityId entityId)

Constructor with all data.

Parameters:

parentIdPath - Path from root to parent or null if the entity identifier is a root aggregate ID.

entityId - Unique identifier of the entity that was not found.

EntityNotFoundException

public EntityNotFoundException(@NotNull
                               @NotNull EntityIdPath entityIdPath)

Constructor with entity identifier path.

Parameters:

entityIdPath - Entity identifier path (from root to entity).

Method Detail

getShortId

public final String getShortId()

Specified by:

getShortId in interface org.fuin.objects4j.common.ExceptionShortIdentifable

getParentIdPath

@NotNull
public final @NotNull String getParentIdPath()

Returns the path from root to parent.

Returns:

Path.

getEntityId

@NotNull
public final @NotNull String getEntityId()

Returns the unique identifier of the entity.

Returns:

Unknown entity identifier.

getData

public final EntityNotFoundException.Data getData()

Returns the exception specific data.

Specified by:

getData in interface org.fuin.objects4j.common.MarshalInformation<EntityNotFoundException.Data>

Returns:

Data structure that can be marshalled/unmarshalled.

getDataClass

public Class<EntityNotFoundException.Data> getDataClass()

Specified by:

getDataClass in interface org.fuin.objects4j.common.MarshalInformation<EntityNotFoundException.Data>

getDataElement

public String getDataElement()

Specified by:

getDataElement in interface org.fuin.objects4j.common.MarshalInformation<EntityNotFoundException.Data>