com.whitestein.lsps.vaadin.util

Class Variant.ScopedClosureVariant

java.lang.Object

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

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

com.whitestein.lsps.vaadin.util.Variant.ScopedClosureVariant

All Implemented Interfaces:

Serializable

Enclosing class:

Variant<T>

public static class Variant.ScopedClosureVariant
extends Variant.ClosureVariant

Wraps a closure and an execution scope. Call call(Object...) to run the closure.

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
UIComponentData	scope The scope to call the closure in.

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

requireNonnullClosure

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

context, definitionType, NULL, origin

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Variant<Object>	call(Object... params) Executes closure within context of the given component.
Variant.ScopedClosureVariant	requireNonnullClosure() If the closure is null, closure execution fails.

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

inScope, inScope, noScope

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

scope

public final UIComponentData scope

The scope to call the closure in. May be null when in UI2.

Constructor Detail

ScopedClosureVariant

public ScopedClosureVariant(ClosureHolder data,
                            Type valueType,
                            Variant.Origin origin,
                            boolean requireNonnullClosure,
                            UIComponentData scope,
                            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 -

scope - the scope in which the closure should be executed, may be null.

contextHolder -

Method Detail

requireNonnullClosure

public Variant.ScopedClosureVariant requireNonnullClosure()

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

Overrides:

requireNonnullClosure in class Variant.ClosureVariant

Returns:

this

call

public Variant<Object> call(Object... params)

Executes closure within context of the given component. Does not execute the closure if the closure itself is null - instead returns null (unless requireNonnullClosure() has been called).

Parameters:

params - optional closure parameters, may be null.

Returns:

variant containing result of the execution. Never null, may contain null value. Variant.definitionType is the result of the closure (ClosureType.getReturnType()) unless the closure is null - in that case the type is null.