com.whitestein.lsps.vaadin.util

Class Variant.MapVariant<K,V>

java.lang.Object

com.whitestein.lsps.vaadin.util.Variant<Map<K,V>>

com.whitestein.lsps.vaadin.util.Variant.MapVariant<K,V>

Type Parameters:

K - key type

V - value type

All Implemented Interfaces:

Serializable, Iterable<Map.Entry<K,Variant<V>>>

Enclosing class:

Variant<T>

public static class Variant.MapVariant<K,V>
extends Variant<Map<K,V>>
implements Iterable<Map.Entry<K,Variant<V>>>

A map variant, allows access to map items. Cannot iterate nor access null map. Iterates map entries.

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
MapVariant(Map<K,V> data, Type valueType, Variant.Origin origin, Class<K> keyClass, Class<V> valueClass, LspsContextHolder context) Creates the variant.

Method Summary

Modifier and Type	Method and Description
Variant.MapVariant<K,V>	checkPresent() Fails if the value is absent.
boolean	containsKey(K key) Checks whether given key is present in the map.
Variant<V>	get(K key) Returns the value from the map as a Variant.
boolean	isNullOrEmpty()
Iterator<Map.Entry<K,Variant<V>>>	iterator() Unmodifiable iterator.
Variant.MapVariant<K,V>	orEmpty() Returns variant which is always present.
Variant.MapVariant<K,V>	orVariant(Map<K,V> defaultValue) Returns this instance if it is present; a new variant with the defaultValue otherwise.
int	size() Returns the list size.
Variant.MapVariant<K,V>	toNull() Creates a new variant of same type and origin, but with null map.
Variant.MapVariant<K,V>	toValue(Map<K,V> 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

Constructor Detail

MapVariant

public MapVariant(Map<K,V> data,
                  Type valueType,
                  Variant.Origin origin,
                  Class<K> keyClass,
                  Class<V> valueClass,
                  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".

keyClass -

valueClass -

context -

Method Detail

size

public int size()

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

Returns:

the list size.

get

public Variant<V> get(K key)

Returns the value from the map as a Variant.

Parameters:

key - the key.

Returns:

variant, never null.

toNull

public Variant.MapVariant<K,V> toNull()

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

Overrides:

toNull in class Variant<Map<K,V>>

Returns:

a new variant, never null.

toValue

public Variant.MapVariant<K,V> toValue(Map<K,V> newValue)

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

Overrides:

toValue in class Variant<Map<K,V>>

Parameters:

newValue - the new value, may be null.

Returns:

a new variant, never null.

iterator

public Iterator<Map.Entry<K,Variant<V>>> iterator()

Unmodifiable iterator. Fails if the underlying map is null.

Specified by:

iterator in interface Iterable<Map.Entry<K,Variant<V>>>

Returns:

iterator, never null.

Throws:

IllegalStateException - if underlying list is map.

containsKey

public boolean containsKey(K key)

Checks whether given key is present in the map.

Parameters:

key - the key, may be null.

Returns:

true if key is present in the map (the value may be null though), false if the map is null or the key is not present.

checkPresent

public Variant.MapVariant<K,V> checkPresent()

Description copied from class: Variant

Fails if the value is absent.

Overrides:

checkPresent in class Variant<Map<K,V>>

Returns:

this

orVariant

public Variant.MapVariant<K,V> orVariant(Map<K,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<Map<K,V>>

Parameters:

defaultValue - the default value, may be null.

Returns:

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

orEmpty

public Variant.MapVariant<K,V> orEmpty()

Returns variant which is always present.

Returns:

the variant, never null. If the variant was absent, a new variant with an empty map is returned.

isNullOrEmpty

public boolean isNullOrEmpty()

Returns:

true if there is no contained value or if the contained map is empty.