org.fuin.ddd4j.ddd

Class IntegerEntityId

java.lang.Object

org.fuin.ddd4j.ddd.IntegerEntityId

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IntegerEntityId>, EntityId, TechnicalId, org.fuin.objects4j.vo.ValueObject, org.fuin.objects4j.vo.ValueObjectWithBaseType<java.lang.Integer>

public abstract class IntegerEntityId
extends java.lang.Object
implements EntityId, java.lang.Comparable<IntegerEntityId>, org.fuin.objects4j.vo.ValueObjectWithBaseType<java.lang.Integer>

Integer based entity identifier.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IntegerEntityId.IntegerEntityIdStr Ensures that the integer can be converted into the type.
static class	IntegerEntityId.Validator Validates if a string is compliant with the type.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MIN Minimum valid value (inclusive).

Constructor Summary

Constructors

Constructor and Description
IntegerEntityId(@NotNull EntityType entityType, @NotNull java.lang.Integer id) Constructor with Integer.

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	asBaseType()
java.lang.String	asString() Returns the entity identifier as string.
java.lang.String	asTypedString() Returns the entity identifier as string with type and identifier.
int	compareTo(IntegerEntityId other)
boolean	equals(java.lang.Object obj)
java.lang.Class<java.lang.Integer>	getBaseType()
EntityType	getType() Returns the type represented by this identifier.
int	hashCode()
static boolean	isValid(java.lang.Integer value) Verifies that a given string can be converted into the type.
static void	requireArgValid(@NotNull java.lang.String name, @NotNull java.lang.Integer value) Verifies if the argument is valid and throws an exception if this is not the case.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MIN

public static final int MIN

Minimum valid value (inclusive).

See Also:

Constant Field Values

Constructor Detail

IntegerEntityId

public IntegerEntityId(@NotNull
                       @NotNull EntityType entityType,
                       @NotNull
                       @NotNull java.lang.Integer id)

Constructor with Integer.

Parameters:

entityType - Entity type.

id - Integer.

Method Detail

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

compareTo

public final int compareTo(IntegerEntityId other)

Specified by:

compareTo in interface java.lang.Comparable<IntegerEntityId>

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

asString

public final java.lang.String asString()

Description copied from interface: EntityId

Returns the entity identifier as string.

Specified by:

asString in interface EntityId

Returns:

Entity identifier.

asTypedString

public final java.lang.String asTypedString()

Description copied from interface: EntityId

Returns the entity identifier as string with type and identifier.

Specified by:

asTypedString in interface EntityId

Returns:

Type and identifier.

getType

public final EntityType getType()

Description copied from interface: EntityId

Returns the type represented by this identifier.

Specified by:

getType in interface EntityId

Returns:

Type of entity.

getBaseType

public final java.lang.Class<java.lang.Integer> getBaseType()

Specified by:

getBaseType in interface org.fuin.objects4j.vo.ValueObjectWithBaseType<java.lang.Integer>

asBaseType

public final java.lang.Integer asBaseType()

Specified by:

asBaseType in interface org.fuin.objects4j.vo.ValueObjectWithBaseType<java.lang.Integer>

isValid

public static boolean isValid(java.lang.Integer value)

Verifies that a given string can be converted into the type.

Parameters:

value - Value to validate.

Returns:

Returns true if it's a valid type else false.

requireArgValid

public static void requireArgValid(@NotNull
                                   @NotNull java.lang.String name,
                                   @NotNull
                                   @NotNull java.lang.Integer value)
                            throws org.fuin.objects4j.common.ConstraintViolationException

Verifies if the argument is valid and throws an exception if this is not the case.

Parameters:

name - Name of the value for a possible error message.

value - Value to check.

Throws:

org.fuin.objects4j.common.ConstraintViolationException - The value was not valid.