io.werval.util

Class MultiValueMapMultiValued<K,V>

java.lang.Object

io.werval.util.MultiValueMapMultiValued<K,V>

Type Parameters:

K - Key type

V - Value type

All Implemented Interfaces:

MultiValued<K,V>, Serializable

public class MultiValueMapMultiValued<K,V>
extends Object
implements MultiValued<K,V>, Serializable

MultiValueMap MultiValued.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static Function<String,? extends RuntimeException>	DEFAULT_CONSTRAINT_EX_BUILDER
protected MultiValueMap<K,V>	mvmap

Constructor Summary

Constructors

Constructor and Description
MultiValueMapMultiValued()
MultiValueMapMultiValued(MultiValueMap<K,V> mvmap)
MultiValueMapMultiValued(MultiValueMap<K,V> mvmap, Function<String,? extends RuntimeException> constraintExBuilder)

Method Summary

Modifier and Type	Method and Description
Map<K,List<V>>	allValues() Get all values.
V	firstValue(K key) Get first value, ensuring there's one.
Optional<V>	firstValueOptional(K key) Get first value.
Map<K,V>	firstValues() Get all first values.
boolean	has(K key) Check if this MultiValued has at least one value for a given key.
boolean	isEmpty() Check if this MultiValued has any value.
Set<K>	keys() Get all keys.
protected String	keyTypeDisplayName() Key type display name.
V	lastValue(K key) Get last value, ensuring there's one.
Optional<V>	lastValueOptional(K key) Get last value.
Map<K,V>	lastValues() Get all last values.
V	singleValue(K key) Get single value, ensuring it has only one value.
Optional<V>	singleValueOptional(K key) Get single value.
Map<K,V>	singleValues() Get all single values, ensuring each has only one value.
List<V>	values(K key) Get all values.
protected String	valueTypeDisplayName() Value type display name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_CONSTRAINT_EX_BUILDER

protected static final Function<String,? extends RuntimeException> DEFAULT_CONSTRAINT_EX_BUILDER

mvmap

protected final MultiValueMap<K,V> mvmap

Constructor Detail

MultiValueMapMultiValued

public MultiValueMapMultiValued()

MultiValueMapMultiValued

public MultiValueMapMultiValued(MultiValueMap<K,V> mvmap)

MultiValueMapMultiValued

public MultiValueMapMultiValued(MultiValueMap<K,V> mvmap,
                                Function<String,? extends RuntimeException> constraintExBuilder)

Method Detail

isEmpty

public boolean isEmpty()

Description copied from interface: MultiValued

Check if this MultiValued has any value.

Specified by:

isEmpty in interface MultiValued<K,V>

Returns:

return true if this MultiValued contains no value at all, false otherwise

has

public boolean has(K key)

Description copied from interface: MultiValued

Check if this MultiValued has at least one value for a given key.

Specified by:

has in interface MultiValued<K,V>

Parameters:

key - Key

Returns:

return true if this MultiValued has at least one value for the given key, false otherwise

singleValue

public V singleValue(K key)
              throws MultiValuedConstraintException

Description copied from interface: MultiValued

Get single value, ensuring it has only one value.

Specified by:

singleValue in interface MultiValued<K,V>

Parameters:

key - Key

Returns:

Single value for this key

Throws:

MultiValuedConstraintException - if there is no or multiple values for this key

firstValue

public V firstValue(K key)
             throws MultiValuedConstraintException

Description copied from interface: MultiValued

Get first value, ensuring there's one.

Specified by:

firstValue in interface MultiValued<K,V>

Parameters:

key - Key

Returns:

First value for this key

Throws:

MultiValuedConstraintException - if there are no value for this key

lastValue

public V lastValue(K key)
            throws MultiValuedConstraintException

Description copied from interface: MultiValued

Get last value, ensuring there's one.

Specified by:

lastValue in interface MultiValued<K,V>

Parameters:

key - Key

Returns:

Last value for this key

Throws:

MultiValuedConstraintException - if there are no value for this key

singleValueOptional

public Optional<V> singleValueOptional(K key)

Description copied from interface: MultiValued

Get single value.

Specified by:

singleValueOptional in interface MultiValued<K,V>

Parameters:

key - Key

Returns:

Single value for this key, optional

firstValueOptional

public Optional<V> firstValueOptional(K key)

Description copied from interface: MultiValued

Get first value.

Specified by:

firstValueOptional in interface MultiValued<K,V>

Parameters:

key - Key

Returns:

First value for this key, optional

lastValueOptional

public Optional<V> lastValueOptional(K key)

Description copied from interface: MultiValued

Get last value.

Specified by:

lastValueOptional in interface MultiValued<K,V>

Parameters:

key - Key

Returns:

Last value for this key, optional

keys

public Set<K> keys()

Description copied from interface: MultiValued

Get all keys.

Specified by:

keys in interface MultiValued<K,V>

Returns:

All keys as immutable Set.

values

public List<V> values(K key)

Description copied from interface: MultiValued

Get all values.

Specified by:

values in interface MultiValued<K,V>

Parameters:

key - Key

Returns:

All values for the given key as immutable List, or an immutable empty one.

singleValues

public Map<K,V> singleValues()

Description copied from interface: MultiValued

Get all single values, ensuring each has only one value.

Specified by:

singleValues in interface MultiValued<K,V>

Returns:

Every single values for all keys as immutable Map, or an empty immutable one.

firstValues

public Map<K,V> firstValues()

Description copied from interface: MultiValued

Get all first values.

Specified by:

firstValues in interface MultiValued<K,V>

Returns:

Every first values for all keys as immutable Map, or an empty immutable one.

lastValues

public Map<K,V> lastValues()

Description copied from interface: MultiValued

Get all last values.

Specified by:

lastValues in interface MultiValued<K,V>

Returns:

Every last values for all keys as immutable Map, or an empty immutable one.

allValues

public Map<K,List<V>> allValues()

Description copied from interface: MultiValued

Get all values.

Specified by:

allValues in interface MultiValued<K,V>

Returns:

Every all values for all keys as immutable Map, or an empty immutable one.

keyTypeDisplayName

protected String keyTypeDisplayName()

Key type display name.

Defaults to key, override to provide better error messages.

Returns:

the key type display name.

valueTypeDisplayName

protected String valueTypeDisplayName()

Value type display name.

Defaults to value, override to provide better error messages.

Returns:

the value type display name.