com.whitestein.lsps.vaadin.util

Class Variant.ListVariant<V>

java.lang.Object

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

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

com.whitestein.lsps.vaadin.util.Variant.ListVariant<V>

Type Parameters:

V - entry type

All Implemented Interfaces:

Serializable, Iterable<Variant<V>>

Enclosing class:

Variant<T>

public static class Variant.ListVariant<V>
extends Variant.CollectionVariant<List<V>,V>

A list variant, allows access to list items. 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 inherited from class com.whitestein.lsps.vaadin.util.Variant.CollectionVariant

itemClass

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

context, definitionType, NULL, origin

Constructor Summary

Constructors

Constructor and Description
ListVariant(List<V> data, Type valueType, Variant.Origin origin, Class<V> itemType, LspsContextHolder context) Creates the variant.

Method Summary

Modifier and Type	Method and Description
Variant.ListVariant<V>	checkPresent() Fails if the value is absent.
Variant<V>	get(int index) Returns i-th item from the list as a Variant.
Iterator<Variant<V>>	iterator() Item iterator which provides items as variants with correct "origin".
Variant.ListVariant<V>	orEmptyList()
Variant.ListVariant<V>	orVariant(List<V> defaultValue) Returns this instance if it is present; a new variant with the defaultValue otherwise.
Variant.ListVariant<V>	toNull() Creates a new variant of same type and origin, but with null value.
Variant.ListVariant<V>	toValue(List<V> newValue) Creates a new variant of same type and origin, but with given value.
List<Variant<V>>	toVariantList() Converts this list to a list of variants.

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

addAllTo, isNullOrEmpty, size

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

Constructor Detail

ListVariant

public ListVariant(List<V> data,
                   Type valueType,
                   Variant.Origin origin,
                   Class<V> itemType,
                   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".

itemType -

context -

Method Detail

get

public Variant<V> get(int index)

Returns i-th item from the list as a Variant.

Parameters:

index - the index, 0-based.

Returns:

variant, never null.

Throws:

IllegalStateException - if the index is invalid.

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>>

Overrides:

iterator in class Variant.CollectionVariant<List<V>,V>

Returns:

iterator, never null.

Throws:

IllegalStateException - if underlying list is null.

toNull

public Variant.ListVariant<V> toNull()

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

Overrides:

toNull in class Variant.CollectionVariant<List<V>,V>

Returns:

a new variant, never null.

toValue

public Variant.ListVariant<V> toValue(List<V> newValue)

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

Overrides:

toValue in class Variant.CollectionVariant<List<V>,V>

Parameters:

newValue - the new value, may be null.

Returns:

a new variant, never null.

checkPresent

public Variant.ListVariant<V> checkPresent()

Description copied from class: Variant

Fails if the value is absent.

Overrides:

checkPresent in class Variant.CollectionVariant<List<V>,V>

Returns:

this

orVariant

public Variant.ListVariant<V> orVariant(List<V> 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.CollectionVariant<List<V>,V>

Parameters:

defaultValue - the default value, may be null.

Returns:

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

orEmptyList

public Variant.ListVariant<V> orEmptyList()

Returns:

contained list. If not list is contained, returns an empty list.

toVariantList

public List<Variant<V>> toVariantList()

Converts this list to a list of variants.

Returns:

a list of variants, never null.

Throws:

IllegalStateException - if the list is null.