org.fuin.ddd4j.ddd

Class EntityIdConverter

java.lang.Object

javax.xml.bind.annotation.adapters.XmlAdapter<java.lang.String,EntityId>

org.fuin.ddd4j.ddd.EntityIdConverter

All Implemented Interfaces:

javax.json.bind.adapter.JsonbAdapter<EntityId,java.lang.String>

@ThreadSafe
public final class EntityIdConverter
extends javax.xml.bind.annotation.adapters.XmlAdapter<java.lang.String,EntityId>
implements javax.json.bind.adapter.JsonbAdapter<EntityId,java.lang.String>

JAXB and JSON converter for an entity identifier.

Constructor Summary

Constructors

Constructor and Description
EntityIdConverter(EntityIdFactory factory) Constructor with factory.

Method Summary

Modifier and Type	Method and Description
EntityId	adaptFromJson(java.lang.String str)
java.lang.String	adaptToJson(EntityId obj)
java.lang.String	fromVO(EntityId value) Converts the value object into a String.
boolean	isValid(java.lang.String value) Verifies that the given value can be converted into a value object using the factory.
java.lang.String	marshal(EntityId value)
void	requireArgValid(@NotNull java.lang.String name, @NotNull java.lang.String value) Verifies if the argument is valid and throws an exception if this is not the case.
EntityId	toVO(java.lang.String value) Converts a string into an entity identifier.
EntityId	unmarshal(java.lang.String value)

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityIdConverter

public EntityIdConverter(EntityIdFactory factory)

Constructor with factory.

Parameters:

factory - Factory to use.

Method Detail

isValid

public final boolean isValid(java.lang.String value)

Verifies that the given value can be converted into a value object using the factory. A null parameter will return true.

Parameters:

value - Value to check.

Returns:

true if the value can be converted, else false.

requireArgValid

public final void requireArgValid(@NotNull
                                  @NotNull java.lang.String name,
                                  @NotNull
                                  @NotNull java.lang.String 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.

toVO

public final EntityId toVO(java.lang.String value)

Converts a string into an entity identifier. A null parameter will return null.

Parameters:

value - Representation of the entity identifier as string.

Returns:

Value object.

fromVO

public final java.lang.String fromVO(EntityId value)

Converts the value object into a String. A null parameter will return null.

Parameters:

value - Value object.

Returns:

Base type.

marshal

public final java.lang.String marshal(EntityId value)
                               throws java.lang.Exception

Specified by:

marshal in class javax.xml.bind.annotation.adapters.XmlAdapter<java.lang.String,EntityId>

Throws:

java.lang.Exception

unmarshal

public final EntityId unmarshal(java.lang.String value)
                         throws java.lang.Exception

Specified by:

unmarshal in class javax.xml.bind.annotation.adapters.XmlAdapter<java.lang.String,EntityId>

Throws:

java.lang.Exception

adaptToJson

public final java.lang.String adaptToJson(EntityId obj)
                                   throws java.lang.Exception

Specified by:

adaptToJson in interface javax.json.bind.adapter.JsonbAdapter<EntityId,java.lang.String>

Throws:

java.lang.Exception

adaptFromJson

public final EntityId adaptFromJson(java.lang.String str)
                             throws java.lang.Exception

Specified by:

adaptFromJson in interface javax.json.bind.adapter.JsonbAdapter<EntityId,java.lang.String>

Throws:

java.lang.Exception