com.whitestein.lsps.vaadin.util

Class SetVariant<V>

java.lang.Object

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

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

com.whitestein.lsps.vaadin.util.SetVariant<V>

Type Parameters:

V -

All Implemented Interfaces:

Serializable, Iterable<Variant<V>>

public final class SetVariant<V>
extends Variant.CollectionVariant<Set<V>,V>

A set variant, allows access to set items. Cannot iterate nor access null set - 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
SetVariant(Set<V> data, Type valueType, Variant.Origin origin, Class<V> itemType, LspsContextHolder context) Creates the variant.

Method Summary

Modifier and Type	Method and Description
SetVariant<V>	checkPresent() Fails if the value is absent.
SetVariant<V>	orEmptySet()
SetVariant<V>	orVariant(Set<V> defaultValue) Returns this instance if it is present; a new variant with the defaultValue otherwise.
SetVariant<V>	toNull() Creates a new variant of same type and origin, but with null value.
SetVariant<V>	toValue(Set<V> newValue) Creates a new variant of same type and origin, but with given value.
Set<Variant<V>>	toVariantSet() Converts this list to a list of variants.

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

addAllTo, isNullOrEmpty, iterator, 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

SetVariant

public SetVariant(Set<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 - - see super class

context - - see super class

Method Detail

toNull

public SetVariant<V> toNull()

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

Overrides:

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

Returns:

a new variant, never null.

toValue

public SetVariant<V> toValue(Set<V> newValue)

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

Overrides:

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

Parameters:

newValue - the new value, may be null.

Returns:

a new variant, never null.

checkPresent

public SetVariant<V> checkPresent()

Description copied from class: Variant

Fails if the value is absent.

Overrides:

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

Returns:

this

orVariant

public SetVariant<V> orVariant(Set<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<Set<V>,V>

Parameters:

defaultValue - the default value, may be null.

Returns:

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

orEmptySet

public SetVariant<V> orEmptySet()

Returns:

contained set. If not set is contained, returns an empty est.

toVariantSet

public Set<Variant<V>> toVariantSet()

Converts this list to a list of variants.

Returns:

a list of variants, never null.

Throws:

IllegalStateException - if the list is null.