com.whitestein.lsps.vaadin.util

Class Variant.RecordVariant

java.lang.Object

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

com.whitestein.lsps.vaadin.util.Variant.RecordVariant

All Implemented Interfaces:

Serializable

Enclosing class:

Variant<T>

public static class Variant.RecordVariant
extends Variant<RecordHolder>

Accesses RecordHolder properties.

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 inherited from class com.whitestein.lsps.vaadin.util.Variant

context, definitionType, NULL, origin

Constructor Summary

Constructors

Constructor and Description
RecordVariant(RecordHolder data, Type valueType, Variant.Origin origin, LspsContextHolder context) Creates the variant.

Method Summary

Modifier and Type	Method and Description
Variant<Object>	call(Namespace namespace, String methodName, Object... args) Calls given class method and returns the result.
Variant<Object>	call(Namespace namespace, String methodName, Type[] parameterTypes, Object... args) Calls given class method and returns the result.
Variant.RecordVariant	checkPresent() Fails if the value is absent.
Variant.RecordVariant	checkSubtypeOf(String type) Checks that the record is of given type or is its subtype.
Variant.RecordVariant	checkSubtypeOf(String type, String message) Checks that the record is of given type or is its subtype.
Variant.RecordVariant	checkType(String type) Checks that the record is of given type.
Variant<Object>	getPropertyValue(String propName) Returns given property value.
Variant<Object>	getPropertyValue(String propName, boolean nullIfMissing) Returns given property value.
String	getTypeFullName() Returns NamedClassType.getFullName().
boolean	hasProperty(String propName) Checks whether the record has given property defined.
Variant.RecordVariant	inLevel(ContextWrapper context)
boolean	isGCd() Checks whether the underlying RecordHolder has been garbage-collected.
boolean	isSubtypeOf(String type) Checks that the record is of given type or is its subtype.
Variant.RecordVariant	orVariant(RecordHolder defaultValue) Returns this instance if it is present; a new variant with the defaultValue otherwise.
void	setPropertyValue(String propertyName, Object value) Sets given property value.
Variant.RecordVariant	toValue(RecordHolder newValue) Creates a new variant of same type and origin, but with given value.

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

bool, cast, 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, param, path, property, propertyPath, record, reference, requireDefined, set, setHolder, setOf, setReferencedValue, setReferencedValueCollection, startTransaction, string, toNull, toString, toUpperCase, valueOrNull, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordVariant

public RecordVariant(RecordHolder data,
                     Type valueType,
                     Variant.Origin origin,
                     LspsContextHolder context)

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". Must not be null.

context -

Method Detail

checkType

public Variant.RecordVariant checkType(String type)

Checks that the record is of given type. Does nothing if the value is absent (the record is null).

Parameters:

type - the type, e.g. "ui::CalendarItem". Not null.

Returns:

this

Throws:

IllegalStateException - if the record type does not match.

isSubtypeOf

public boolean isSubtypeOf(String type)

Checks that the record is of given type or is its subtype.

Parameters:

type - the full name of the type, e.g. "ui::CalendarItem". Not null.

Returns:

true if Variant.record() is of given type or is a subtype of given type.

Throws:

IllegalStateException - if the record type does not match or if the record is absent (null).

checkSubtypeOf

public Variant.RecordVariant checkSubtypeOf(String type)

Checks that the record is of given type or is its subtype. Supports interfaces.

Parameters:

type - the full name of the type, e.g. "ui::CalendarItem". Not null. This record must either be of given type, extend given type, or in case of interfaces, must be an implementor of given interface.

Returns:

this

Throws:

IllegalStateException - if the record type does not match or the record is absent (null).

checkSubtypeOf

public Variant.RecordVariant checkSubtypeOf(String type,
                                            String message)

Checks that the record is of given type or is its subtype.

Parameters:

type - the full name of the type, e.g. "ui::CalendarItem". Not null.

message - optional additional message, may be null.

Returns:

this

Throws:

IllegalStateException - if the record type does not match or the record is absent.

getTypeFullName

public String getTypeFullName()

Returns NamedClassType.getFullName().

Returns:

the record full name, never null. Fails if the value is absent.

getPropertyValue

public Variant<Object> getPropertyValue(String propName)

Returns given property value. Returns null if the property value is null. Fails if there is no property with given name.

Parameters:

propName - the property name, not null.

Returns:

the variant containing the value, never null.

isGCd

public boolean isGCd()

Checks whether the underlying RecordHolder has been garbage-collected. If yes, all fields are set to null and the holder is no longer valid.

Returns:

true if the record has been GCed, false if it is still valid and present in the model instance.

getPropertyValue

public Variant<Object> getPropertyValue(String propName,
                                        boolean nullIfMissing)

Returns given property value. Returns null if the property value is null. Fails if there is no property with given name.

Parameters:

propName - the property name, not null.

nullIfMissing - if this is true and there is no such property, do not fail - return null instead.

Returns:

the variant containing the value, never null.

checkPresent

public Variant.RecordVariant checkPresent()

Fails if the value is absent.

Overrides:

checkPresent in class Variant<RecordHolder>

Returns:

this

Throws:

IllegalStateException - if the value is absent (value is null)

hasProperty

public boolean hasProperty(String propName)

Checks whether the record has given property defined.

Parameters:

propName - the property name, not null.

Returns:

true if the record has given property defined (the value may be null though), false otherwise.

toValue

public Variant.RecordVariant toValue(RecordHolder newValue)

Creates a new variant of same type and origin, but with given value.

Overrides:

toValue in class Variant<RecordHolder>

Parameters:

newValue - the new value, may be null.

Returns:

a new variant, never null.

orVariant

public Variant.RecordVariant orVariant(RecordHolder defaultValue)

Description copied from class: Variant

Returns this instance if it is present; a new variant with the defaultValue otherwise. If no default value should be required because the instance is known to be present, use Variant.get() instead. For a default value of null, use Variant.valueOrNull().

Overrides:

orVariant in class Variant<RecordHolder>

Parameters:

defaultValue - the default value, may be null.

Returns:

the value or the default value if the value is null.

inLevel

public Variant.RecordVariant inLevel(ContextWrapper context)

Parameters:

context -

Returns:

Returns contained instance in the evaluation level of the context.

call

public Variant<Object> call(Namespace namespace,
                            String methodName,
                            Object... args)

Calls given class method and returns the result.

Parameters:

namespace -

methodName - the name of the method, not null.

args - parameters of the method, may be null if the method does not take any parameters.

Returns:

the result value, wrapped in a Variant, never null.

call

public Variant<Object> call(Namespace namespace,
                            String methodName,
                            Type[] parameterTypes,
                            Object... args)

Calls given class method and returns the result.

Parameters:

namespace -

methodName - the name of the method, not null.

parameterTypes - the types of the method parameters as defined in the method signature. This parameter allows to specify what method should be called if the method is overloaded

args - parameters of the method, may be null if the method does not take any parameters.

Returns:

the result value, wrapped in a Variant, never null.

setPropertyValue

public void setPropertyValue(String propertyName,
                             Object value)

Sets given property value. Fails if there is no property with given name.

Parameters:

propertyName - the property name, not null.

value - to be set to the property.