com.whitestein.lsps.vaadin.util

Class Variant.CollectionVariant<T extends Collection<V>,V>

java.lang.Object

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

com.whitestein.lsps.vaadin.util.Variant.CollectionVariant<T,V>

Type Parameters:

T -

V -

All Implemented Interfaces:

Serializable, Iterable<Variant<V>>

Direct Known Subclasses:

SetVariant, Variant.ListVariant

Enclosing class:

Variant<T>

public static class Variant.CollectionVariant<T extends Collection<V>,V>
extends Variant<T>
implements Iterable<Variant<V>>

A set variant, allows iterating over collections. Cannot iterate nor access null list - it is better that prior iteration, an explicit null check is performed (Variant.isPresent() or Variant.get()).

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 Class<V>	itemClass

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

context, definitionType, NULL, origin

Constructor Summary

Constructors

Constructor and Description
CollectionVariant(T data, Type valueType, Variant.Origin origin, Class<V> itemClass, LspsContextHolder context) Creates the variant.

Method Summary

Modifier and Type	Method and Description
Variant.CollectionVariant<T,V>	addAllTo(Collection<Variant<V>> targetCollection) Adds all items from this collection to the target collection.
Variant.CollectionVariant<T,V>	checkPresent() Fails if the value is absent.
boolean	isNullOrEmpty() Checks whether the list is absent or empty (does not contain any items).
Iterator<Variant<V>>	iterator() Item iterator which provides items as variants with correct "origin".
Variant.CollectionVariant<T,V>	orVariant(T defaultValue) Returns this instance if it is present; a new variant with the defaultValue otherwise.
int	size() Returns the list size.
Variant.CollectionVariant<T,V>	toNull() Creates a new variant of same type and origin, but with null value.
Variant.CollectionVariant<T,V>	toValue(T 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, toString, toUpperCase, valueOrNull, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

itemClass

protected final Class<V> itemClass

Constructor Detail

CollectionVariant

public CollectionVariant(T data,
                         Type valueType,
                         Variant.Origin origin,
                         Class<V> itemClass,
                         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".

itemClass -

context - used for value serialization/deserialization, may be null in special cases.

Method Detail

size

public int size()

Returns the list size. Fails if the list is null.

Returns:

the list size.

iterator

public Iterator<Variant<V>> iterator()

Item iterator which provides items as variants with correct "origin". Fails if the underlying list is null.

Specified by:

iterator in interface Iterable<Variant<V>>

Returns:

iterator, never null.

Throws:

IllegalStateException - if underlying list is null.

toNull

public Variant.CollectionVariant<T,V> toNull()

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

Overrides:

toNull in class Variant<T extends Collection<V>>

Returns:

a new variant, never null.

toValue

public Variant.CollectionVariant<T,V> toValue(T newValue)

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

Overrides:

toValue in class Variant<T extends Collection<V>>

Parameters:

newValue - the new value, may be null.

Returns:

a new variant, never null.

checkPresent

public Variant.CollectionVariant<T,V> checkPresent()

Description copied from class: Variant

Fails if the value is absent.

Overrides:

checkPresent in class Variant<T extends Collection<V>>

Returns:

this

isNullOrEmpty

public boolean isNullOrEmpty()

Checks whether the list is absent or empty (does not contain any items).

Returns:

true if the list is absent or empty.

orVariant

public Variant.CollectionVariant<T,V> orVariant(T 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<T extends Collection<V>>

Parameters:

defaultValue - the default value, may be null.

Returns:

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

addAllTo

public Variant.CollectionVariant<T,V> addAllTo(Collection<Variant<V>> targetCollection)

Adds all items from this collection to the target collection. All items are cast prior adding. If Variant.isAbsent(), nothing is done.

Parameters:

targetCollection - the target collection, not null.

Returns:

this