com.edorasware.commons.core.persistence.entity

Class EntityConverterUtils

java.lang.Object

com.edorasware.commons.core.persistence.entity.EntityConverterUtils

public final class EntityConverterUtils
extends Object

Provides utility methods related to dealing with converters.

Method Summary

Modifier and Type	Method and Description
static String	convertEntityId(EntityId id, ConverterProvider converterProvider) Converts the given entity id to its typed entity id value using the matching id converter.
static EntityId	convertToEntityId(String typedIdValue, ConverterProvider converterProvider) Converts the given typed entity id value using the matching id converter.
static EntityId	convertToEntityId(String idValue, String typeName, ConverterProvider converterProvider) Converts the given entity id value using the matching id converter.
static EntityId	convertToEntityId(String idValue, String typeName, ConverterProvider converterProvider, EntityManager<?,?,?,?,?,?,?,?,?> manager) Converts the given entity id value to an entity id.
static <S,T> ValueConverter<S,T>	getConverterByName(String converterName, List<? extends ValueConverter<S,T>> converters) Returns the converter with the given name.
static <S,T> ValueConverter<S,T>	getConverterBySourceValue(Object sourceValue, List<? extends ValueConverter<S,T>> converters) Returns the converter that can handle the given source value.
static com.google.common.base.Optional<? extends ValueConverter<EntityId,String>>	getEntityIdConverter(EntityId id, ConverterProvider converterProvider) Returns the first matching id converter for the given entity id.
static com.google.common.base.Optional<? extends ValueConverter<EntityId,String>>	getEntityIdConverter(String typedIdValue, ConverterProvider converterProvider) Returns the first matching id converter for the given typed entity id value.
static com.google.common.base.Optional<? extends ValueConverter<EntityId,String>>	getEntityIdConverter(String idValue, String typeName, ConverterProvider converterProvider) Returns the first matching id converter for the given entity id value.
static com.google.common.collect.ImmutableList<? extends ValueConverter<EntityId,String>>	getEntityIdConverters(ConverterProvider converterProvider) Returns all id converters.
static com.google.common.collect.ImmutableList<? extends ValueConverter<Id,String>>	getIdentityLinkConverters(ConverterProvider converterProvider) Returns all identity link converters.
static com.google.common.collect.ImmutableList<? extends ValueConverter<String,Object>>	getPropertyConverters(ConverterProvider converterProvider) Returns all property converters.
static com.google.common.collect.ImmutableList<? extends ValueConverter<Object,Object>>	getVariableConverters(ConverterProvider converterProvider) Returns all variable converters.

Methods inherited from class java.lang.Object

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

Method Detail

convertToEntityId

public static EntityId convertToEntityId(String idValue,
                                         String typeName,
                                         ConverterProvider converterProvider)

Converts the given entity id value using the matching id converter.

Parameters:

idValue - the entity id value to convert

typeName - the name of type of the entity for which to create the entity id

converterProvider - the provider from which to retrieve the converters

Returns:

the converted entity id

Throws:

IllegalArgumentException - thrown if no matching provider can be found

convertToEntityId

public static EntityId convertToEntityId(String typedIdValue,
                                         ConverterProvider converterProvider)

Converts the given typed entity id value using the matching id converter.

Parameters:

typedIdValue - the typed entity id value to convert

converterProvider - the provider from which to retrieve the converters

Returns:

the converted entity id

Throws:

IllegalArgumentException - thrown if no matching provider can be found

convertEntityId

public static String convertEntityId(EntityId id,
                                     ConverterProvider converterProvider)

Converts the given entity id to its typed entity id value using the matching id converter.

Parameters:

id - the entity id to convert

converterProvider - the provider from which to retrieve the converters

Returns:

the converted entity id value

Throws:

IllegalStateException - thrown if no matching provider can be found

convertToEntityId

public static EntityId convertToEntityId(String idValue,
                                         String typeName,
                                         ConverterProvider converterProvider,
                                         EntityManager<?,?,?,?,?,?,?,?,?> manager)

Converts the given entity id value to an entity id.

Parameters:

idValue - the entity id value to convert

typeName - the type name of the entity for which to create the entity id

converterProvider - the converter providers that are used as the primary source to convert the entity id value

manager - the manager that is used as a fallback when there is no matching converter to do the conversion of the entity id value

Returns:

the entity id

getEntityIdConverter

public static com.google.common.base.Optional<? extends ValueConverter<EntityId,String>> getEntityIdConverter(String idValue,
                                                                                                              String typeName,
                                                                                                              ConverterProvider converterProvider)

Returns the first matching id converter for the given entity id value.

Parameters:

idValue - the entity id value to match against

typeName - the name of type of the entity to match against

converterProvider - the provider from which to retrieve the converters

Returns:

the matching id converter

getEntityIdConverter

public static com.google.common.base.Optional<? extends ValueConverter<EntityId,String>> getEntityIdConverter(String typedIdValue,
                                                                                                              ConverterProvider converterProvider)

Returns the first matching id converter for the given typed entity id value.

Parameters:

typedIdValue - the typed entity id value to match against

converterProvider - the provider from which to retrieve the converters

Returns:

the matching id converter

getEntityIdConverter

public static com.google.common.base.Optional<? extends ValueConverter<EntityId,String>> getEntityIdConverter(EntityId id,
                                                                                                              ConverterProvider converterProvider)

Returns the first matching id converter for the given entity id.

Parameters:

id - the entity id to match against

converterProvider - the provider from which to retrieve the converters

Returns:

the matching id converter

getEntityIdConverters

public static com.google.common.collect.ImmutableList<? extends ValueConverter<EntityId,String>> getEntityIdConverters(ConverterProvider converterProvider)

Returns all id converters.

Parameters:

converterProvider - the provider from which to retrieve the converters

Returns:

the id converters

getVariableConverters

public static com.google.common.collect.ImmutableList<? extends ValueConverter<Object,Object>> getVariableConverters(ConverterProvider converterProvider)

Returns all variable converters.

Parameters:

converterProvider - the provider from which to retrieve the converters

Returns:

the variable converters

getIdentityLinkConverters

public static com.google.common.collect.ImmutableList<? extends ValueConverter<Id,String>> getIdentityLinkConverters(ConverterProvider converterProvider)

Returns all identity link converters.

Parameters:

converterProvider - the provider from which to retrieve the converters

Returns:

the identity link converters

getPropertyConverters

public static com.google.common.collect.ImmutableList<? extends ValueConverter<String,Object>> getPropertyConverters(ConverterProvider converterProvider)

Returns all property converters.

Parameters:

converterProvider - the provider from which to retrieve the converters

Returns:

the property converters

getConverterByName

public static <S,T> ValueConverter<S,T> getConverterByName(String converterName,
                                                           List<? extends ValueConverter<S,T>> converters)

Returns the converter with the given name.

Type Parameters:

S - the source type

T - the target type

Parameters:

converterName - the converter name to match against, must not be null

converters - the candidate converters

Returns:

the matching converter

getConverterBySourceValue

public static <S,T> ValueConverter<S,T> getConverterBySourceValue(Object sourceValue,
                                                                  List<? extends ValueConverter<S,T>> converters)

Returns the converter that can handle the given source value.

Type Parameters:

S - the source type

T - the target type

Parameters:

sourceValue - the source value to handle, must not be null

converters - the candidate converters

Returns:

the matching converter