org.jtransfo

Class AbstractSetTypeConverter

java.lang.Object

org.jtransfo.AbstractSetTypeConverter

All Implemented Interfaces:

Named, NeedsJTransfo, TypeConverter<Set,Set>

Direct Known Subclasses:

AutomaticSetTypeConverter, SetTypeConverter

public abstract class AbstractSetTypeConverter
extends Object
implements TypeConverter<Set,Set>, Named, NeedsJTransfo

Abstract type converter for Set objects. You need to define the to object contents for the set.

Constructor Summary

Constructors

Constructor and Description
AbstractSetTypeConverter(String name, Class<?> toType) Construct type converter for converting a set, assign given name and use given transfer object type.

Method Summary

Modifier and Type	Method and Description
boolean	canConvert(Type realToType, Type realDomainType) Can this type converter handle conversions between the given transfer and domain object types?
Set	convert(Set toObjects, SyntheticField domainField, Object domainObject, String... tags) Convert a transfer object field value to the value for the domain object.
abstract Object	doConvertOne(JTransfo jTransfo, Object toObject, Class<?> domainObjectType, String... tags) Do the actual conversion of one object.
Object	doReverseOne(JTransfo jTransfo, Object domainObject, SyntheticField toField, Class<?> toType, String... tags) Do the actual reverse conversion of one object.
String	getName() Get name for the object.
Set	reverse(Set domainObjects, SyntheticField toField, Object toObject, String... tags) Convert a domain object field value to the value for the transfer object.
void	setAlwaysNewSet(boolean alwaysNewSet) Set whether a new set should be used as container for the values.
void	setEmptySetSupplier(Supplier<Set> emptySetSupplier) Define a supplier for empty sets.
void	setJTransfo(JTransfo jTransfo) Set jTransfo instance which can be used recursively.
void	setKeepNullSet(boolean keepNullSet) Set whether null values should be kept (true).

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSetTypeConverter

public AbstractSetTypeConverter(String name,
                                Class<?> toType)

Construct type converter for converting a set, assign given name and use given transfer object type.

Parameters:

name - name for type converter, for use in MappedBy.typeConverter()

toType - transfer object type

Method Detail

getName

public String getName()

Description copied from interface: Named

Get name for the object.

Specified by:

getName in interface Named

Returns:

object name

setJTransfo

public void setJTransfo(JTransfo jTransfo)

Description copied from interface: NeedsJTransfo

Set jTransfo instance which can be used recursively.

Specified by:

setJTransfo in interface NeedsJTransfo

Parameters:

jTransfo - jTransfo instance

canConvert

public boolean canConvert(Type realToType,
                          Type realDomainType)

Description copied from interface: TypeConverter

Can this type converter handle conversions between the given transfer and domain object types?

Specified by:

canConvert in interface TypeConverter<Set,Set>

Parameters:

realToType - real class for the type in the transfer object

realDomainType - real class for the type in the domain object

Returns:

true is this type converter can handle the type conversions

doConvertOne

public abstract Object doConvertOne(JTransfo jTransfo,
                                    Object toObject,
                                    Class<?> domainObjectType,
                                    String... tags)
                             throws JTransfoException

Do the actual conversion of one object.

Parameters:

jTransfo - jTransfo instance in use

toObject - transfer object

domainObjectType - domain object type

tags - tags which indicate which fields can be converted based on MapOnly annotations.

Returns:

domain object

Throws:

JTransfoException - oops, cannot convert

convert

public Set convert(Set toObjects,
                   SyntheticField domainField,
                   Object domainObject,
                   String... tags)
            throws JTransfoException

Description copied from interface: TypeConverter

Convert a transfer object field value to the value for the domain object.

Specified by:

convert in interface TypeConverter<Set,Set>

Parameters:

toObjects - object to convert

domainField - target domain field

domainObject - target domain object

tags - tags which indicate which fields can be converted based on MapOnly annotations.

Returns:

converted object

Throws:

JTransfoException - problem during type conversion

doReverseOne

public Object doReverseOne(JTransfo jTransfo,
                           Object domainObject,
                           SyntheticField toField,
                           Class<?> toType,
                           String... tags)
                    throws JTransfoException

Do the actual reverse conversion of one object.

Parameters:

jTransfo - jTransfo instance in use

domainObject - domain object

toField - field definition on the transfer object

toType - configured to type for list

tags - tags which indicate which fields can be converted based on MapOnly annotations.

Returns:

domain object

Throws:

JTransfoException - oops, cannot convert

reverse

public Set reverse(Set domainObjects,
                   SyntheticField toField,
                   Object toObject,
                   String... tags)
            throws JTransfoException

Description copied from interface: TypeConverter

Convert a domain object field value to the value for the transfer object.

Specified by:

reverse in interface TypeConverter<Set,Set>

Parameters:

domainObjects - object to convert

toField - target transfer object field

toObject - target transfer object

tags - tags which indicate which fields can be converted based on MapOnly annotations.

Returns:

converted object

Throws:

JTransfoException - problem during type conversion

setKeepNullSet

public void setKeepNullSet(boolean keepNullSet)

Set whether null values should be kept (true). When false (which is the default value), an empty set is set.

Parameters:

keepNullSet - should null be kept as value or replaced by an empty set.

setAlwaysNewSet

public void setAlwaysNewSet(boolean alwaysNewSet)

Set whether a new set should be used as container for the values. When false the set is reused if not null.

Parameters:

alwaysNewSet - should null be kept as value or replaced by an empty list.

setEmptySetSupplier

public void setEmptySetSupplier(Supplier<Set> emptySetSupplier)

Define a supplier for empty sets. By default HashSet is used but this allows overriding that default.

Parameters:

emptySetSupplier - empty set supplier