io.werval.util

Interface MultiValued<K,V>

Type Parameters:

K - Key type

V - Value type

All Known Subinterfaces:

FormAttributes, FormUploads, Headers, MutableHeaders, QueryString

All Known Implementing Classes:

MultiValueMapMultiValued

public interface MultiValued<K,V>

MultiValued.

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

Method Detail

isEmpty

boolean isEmpty()

Check if this MultiValued has any value.

Returns:

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

has

boolean has(K key)

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

Parameters:

key - Key

Returns:

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

singleValue

V singleValue(K key)
       throws MultiValuedConstraintException

Get single value, ensuring it has only one value.

Parameters:

key - Key

Returns:

Single value for this key

Throws:

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

firstValue

V firstValue(K key)
      throws MultiValuedConstraintException

Get first value, ensuring there's one.

Parameters:

key - Key

Returns:

First value for this key

Throws:

MultiValuedConstraintException - if there are no value for this key

lastValue

V lastValue(K key)
     throws MultiValuedConstraintException

Get last value, ensuring there's one.

Parameters:

key - Key

Returns:

Last value for this key

Throws:

MultiValuedConstraintException - if there are no value for this key

singleValueOptional

Optional<V> singleValueOptional(K key)

Get single value.

Parameters:

key - Key

Returns:

Single value for this key, optional

firstValueOptional

Optional<V> firstValueOptional(K key)

Get first value.

Parameters:

key - Key

Returns:

First value for this key, optional

lastValueOptional

Optional<V> lastValueOptional(K key)

Get last value.

Parameters:

key - Key

Returns:

Last value for this key, optional

keys

Set<K> keys()

Get all keys.

Returns:

All keys as immutable Set.

values

List<V> values(K key)

Get all values.

Parameters:

key - Key

Returns:

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

singleValues

Map<K,V> singleValues()
               throws MultiValuedConstraintException

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

Returns:

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

Throws:

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

firstValues

Map<K,V> firstValues()

Get all first values.

Returns:

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

lastValues

Map<K,V> lastValues()

Get all last values.

Returns:

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

allValues

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

Get all values.

Returns:

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