com.whitestein.lsps.vaadin.util

Class Variant.ClosureVariant

java.lang.Object

com.whitestein.lsps.vaadin.util.Variant<ClosureHolder>

com.whitestein.lsps.vaadin.util.Variant.ClosureVariant

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Variant.ScopedClosureVariant

Enclosing class:

Variant<T>

public static class Variant.ClosureVariant
extends Variant<ClosureHolder>

Wraps a closure and forces you to specify the scope in which the closure is executed.

See Also:

Serialized Form

Property Summary

Properties inherited from class com.whitestein.lsps.vaadin.util.Variant

isProperty

Nested Class Summary

Nested classes/interfaces inherited from class com.whitestein.lsps.vaadin.util.Variant

Variant.ClosureResultOrigin, Variant.ClosureVariant, Variant.CollectionVariant<T extends Collection<V>,V>, Variant.DereferenceOrigin, Variant.ListVariant<V>, Variant.MapVariant<K,V>, Variant.MethodResultOrigin, Variant.Origin, Variant.PropertyOrigin, Variant.RecordOrigin, Variant.RecordVariant, Variant.ReferenceOrigin, Variant.ScopedClosureVariant

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	requireNonnullClosure

Fields inherited from class com.whitestein.lsps.vaadin.util.Variant

context, definitionType, NULL, origin

Constructor Summary

Constructors

Constructor and Description
ClosureVariant(ClosureHolder data, Type valueType, Variant.Origin origin, boolean requireNonnullClosure, LspsContextHolder contextHolder) Creates the variant.

Method Summary

Modifier and Type	Method and Description
Variant.ScopedClosureVariant	inScope(UIComponent scope) Sets the scope of the variant.
Variant.ScopedClosureVariant	inScope(UIComponentData scope) Sets the scope of the variant.
Variant.ScopedClosureVariant	noScope() The new Forms UI has no scopes :) Do not call from the old UI code - every UI component has a scope which must be set with inScope(UIComponent).
Variant.ClosureVariant	requireNonnullClosure() If the closure is null, closure execution fails.

Methods inherited from class com.whitestein.lsps.vaadin.util.Variant

bool, cast, checkPresent, closure, collection, collectionOf, date, decimal, definitionOf, definitionOf, dereference, enumerationConstant, enumValueOf, enumValueOfIgnoreCase, equals, fail, fail, get, getHandle, getInstanceType, getOrigin, hasHandle, hashCode, instanceOf, integer, isAbsent, isClosure, isPath, isPresent, isProperty, isPropertyPath, isRecord, list, listHolder, listOf, map, mapHolder, mapOf, ofOrigin, ofUnknownOrigin, ofUnknownOrigin, or, orVariant, param, path, property, propertyPath, record, reference, requireDefined, set, setHolder, setOf, setReferencedValue, setReferencedValueCollection, startTransaction, string, toNull, toString, toUpperCase, toValue, valueOrNull, wrap

Methods inherited from class java.lang.Object

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

Field Detail

requireNonnullClosure

protected boolean requireNonnullClosure

Constructor Detail

ClosureVariant

public ClosureVariant(ClosureHolder data,
                      Type valueType,
                      Variant.Origin origin,
                      boolean requireNonnullClosure,
                      LspsContextHolder contextHolder)

Creates the variant.

Parameters:

data - the value, may be null.

valueType - The type of the value, either the record property type, or the closure result type. null: see Variant.requireDefined().

origin - The value origin, such as "ui::Geolocation.latitude".

requireNonnullClosure -

contextHolder - used to serialize ValueHolders.

Method Detail

inScope

public Variant.ScopedClosureVariant inScope(UIComponentData scope)

Sets the scope of the variant.

Parameters:

scope - optional scope in which the closure should be executed. May not be null.

Returns:

scoped variant which can be executed.

noScope

public Variant.ScopedClosureVariant noScope()

The new Forms UI has no scopes :) Do not call from the old UI code - every UI component has a scope which must be set with inScope(UIComponent).

Returns:

"scoped" variant which can be executed.

inScope

public Variant.ScopedClosureVariant inScope(UIComponent scope)

Sets the scope of the variant.

Parameters:

scope - optional scope in which the closure should be executed. May not be null.

Returns:

scoped variant which can be executed.

requireNonnullClosure

public Variant.ClosureVariant requireNonnullClosure()

If the closure is null, closure execution fails. The default behavior for Variant.ScopedClosureVariant.call(Object...) is to return null.

Returns:

this