de.sandkastenliga.tools.projector.core

Enum ProjectionType

java.lang.Object

java.lang.Enum<ProjectionType>

de.sandkastenliga.tools.projector.core.ProjectionType

All Implemented Interfaces:

Serializable, Comparable<ProjectionType>

public enum ProjectionType
extends Enum<ProjectionType>

Tells the Projector which strategy to use for the projection of the annotated property.

Author:

Guido Laures

See Also:

Projector, Projection.value()

Enum Constant Summary

Enum Constants

Enum Constant and Description
asIs Project this property as is from the source object onto the target object.
none Ignore this property in tthe projection even if there is a property on the source object with the same name.
projection Project the projection of the source object's non-simple property.
projectionCollection Analogue to projectionCollection but using the projection instead of a property value.
property The projection of this property will not use the source object's property value but a property of it.
propertyCollection Project only a property of the entries of a source object's collection property into a new collection of properties of the source object's non-simple property value.

Method Summary

Modifier and Type	Method and Description
static ProjectionType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ProjectionType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

none

public static final ProjectionType none

Ignore this property in tthe projection even if there is a property on the source object with the same name.

asIs

public static final ProjectionType asIs

Project this property as is from the source object onto the target object. This is the default behavior and can be omitted if source and target property share the same name.

property

public static final ProjectionType property

The projection of this property will not use the source object's property value but a property of it. This is useful if you do not want full copies of non-simple property types leading to huge object hierarchies but rather project a property as reference only which can be used for further processing as needed. You will have to specify the property name of the source target's property object to let Projector know what property to use as reference.

See Also:

Projection.referencePropertyName()

projection

public static final ProjectionType projection

Project the projection of the source object's non-simple property. Projector will use the target object's property type as projection. This is useful to project object hierarchies as projected objects (e.g. use a DTO presentation of the property instead of the original type)

propertyCollection

public static final ProjectionType propertyCollection

Project only a property of the entries of a source object's collection property into a new collection of properties of the source object's non-simple property value. Example: a property of type java.util.List<Address> can be projected on java.util.List<String> where the elements of the list are the city names of the addresses from the source object.

projectionCollection

public static final ProjectionType projectionCollection

Analogue to projectionCollection but using the projection instead of a property value.

Method Detail

values

public static ProjectionType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ProjectionType c : ProjectionType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ProjectionType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null