Package com.exedio.cope.pattern

Class CompositeField<E extends Composite>

java.lang.Object

com.exedio.cope.Feature

com.exedio.cope.Pattern

com.exedio.cope.pattern.CompositeField<E>

All Implemented Interfaces:

TemplatedField<E>, Settable<E>, Serializable

public final class CompositeField<E extends Composite>
extends Pattern
implements Settable<E>, TemplatedField<E>

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
static <E extends Composite> CompositeField<E>	create(Class<E> valueClass)
SetValue[]	execute(E value, Item exceptionItem)
E	get(Item item)
<X extends FunctionField<?>> X	getComponent(X template)	Deprecated. Use of(FunctionField) instead
List<? extends FunctionField<?>>	getComponents()
Set<Class<? extends Throwable>>	getInitialExceptions()	Returns the exceptions possibly thrown, when setting a value for this settable.
Class<?>	getInitialType()
<X extends FunctionField<?>> X	getTemplate(X component)	Returns the template the given component was created for.
List<? extends FunctionField<?>>	getTemplates()
CheckConstraint	getUnison()
Class<E>	getValueClass()
CompositeType<E>	getValueType()
boolean	isFinal()	Returns true, if a value for the settable can be specified on the creation of an item only, thus cannot be modified later.
boolean	isInitial()	Returns true, if a value for the settable should be specified on the creation of an item.
boolean	isMandatory()
IsNullCondition<?>	isNotNull()
Condition	isNotNull(Join join)
IsNullCondition<?>	isNull()
Condition	isNull(Join join)
static <E extends Composite> CompositeField<E>	newComposite(Class<E> valueClass)	Deprecated. Use create(Class) instead
E	newValue(SetValue<?>... setValues)
<X extends FunctionField<?>> X	of(X template)	Returns the component created for the given template within this CompositeField.
CompositeField<E>	optional()
void	set(Item item, E value)
CompositeField<E>	toFinal()

Methods inherited from class com.exedio.cope.Pattern

addSource, addSource, addSource, addSource, addSourceFeature, addSourceFeature, addSourceFeature, annotationField, equals, getGeneratedTypes, getSourceFeatures, getSourceFeaturesGather, getSourceFields, getSources, getSourceTypes, getType, hashCode, initialize, newSourceType, newSourceType, newSourceType, newSourceType, newSourceType, newSourceType, newType, newType, onMount, registerSource

Methods inherited from class com.exedio.cope.Feature

afterModelCreated, getAbstractType, getAnnotation, getID, getLocalizationKeys, getName, getPattern, isAnnotationPresent, isSourceAlready, mount, readResolve, requireMounted, toString, toString, writeReplace

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.exedio.cope.Settable

map

Method Detail

create

public static <E extends Composite> CompositeField<E> create(Class<E> valueClass)

toFinal

public CompositeField<E> toFinal()

optional

public CompositeField<E> optional()

of

public <X extends FunctionField<?>> X of(X template)

Returns the component created for the given template within this CompositeField. The reverse operation is getTemplate(FunctionField).

getTemplate

public <X extends FunctionField<?>> X getTemplate(X component)

Returns the template the given component was created for. The reverse operation is of(FunctionField).

of

public <X extends Feature> X of(X template)

Specified by:

of in interface TemplatedField<E extends Composite>

getTemplate

public <X extends Feature> X getTemplate(X component)

Specified by:

getTemplate in interface TemplatedField<E extends Composite>

getTemplates

public List<? extends FunctionField<?>> getTemplates()

getComponents

public List<? extends FunctionField<?>> getComponents()

Specified by:

getComponents in interface TemplatedField<E extends Composite>

getUnison

public CheckConstraint getUnison()

get

public E get(@Nonnull
             Item item)

Specified by:

get in interface TemplatedField<E extends Composite>

newValue

public E newValue(SetValue<?>... setValues)

set

public void set(@Nonnull
                Item item,
                E value)

execute

public SetValue[] execute(E value,
                          Item exceptionItem)

Specified by:

execute in interface Settable<E extends Composite>

getInitialExceptions

public Set<Class<? extends Throwable>> getInitialExceptions()

Description copied from interface: Settable

Returns the exceptions possibly thrown, when setting a value for this settable.

Specified by:

getInitialExceptions in interface Settable<E extends Composite>

isFinal

public boolean isFinal()

Description copied from interface: Settable

Returns true, if a value for the settable can be specified on the creation of an item only, thus cannot be modified later.

Specified by:

isFinal in interface Settable<E extends Composite>

isInitial

public boolean isInitial()

Description copied from interface: Settable

Returns true, if a value for the settable should be specified on the creation of an item.

Specified by:

isInitial in interface Settable<E extends Composite>

isMandatory

public boolean isMandatory()

Specified by:

isMandatory in interface Settable<E extends Composite>

getInitialType

public Class<?> getInitialType()

Specified by:

getInitialType in interface Settable<E extends Composite>

getValueType

public CompositeType<E> getValueType()

Specified by:

getValueType in interface TemplatedField<E extends Composite>

getValueClass

public Class<E> getValueClass()

Specified by:

getValueClass in interface TemplatedField<E extends Composite>

isNull

public IsNullCondition<?> isNull()

isNull

public Condition isNull(Join join)

isNotNull

public IsNullCondition<?> isNotNull()

isNotNull

public Condition isNotNull(Join join)

getComponent

@Deprecated
public <X extends FunctionField<?>> X getComponent(X template)

Deprecated.

Use of(FunctionField) instead

newComposite

@Deprecated
public static <E extends Composite> CompositeField<E> newComposite(Class<E> valueClass)

Deprecated.

Use create(Class) instead