Value (jooby 2.0.0.RC2 API)

All Superinterfaces:

Iterable<Value>

All Known Subinterfaces:

Body, FileUpload, Formdata, Multipart, QueryString
```
public interface Value
extends Iterable<Value>
```
Unified API for HTTP value. This API plays two role: - unify access to HTTP values, like query, path, form and header parameter - works as validation API, because it is able to check for required and type-safe values The value API is composed by three types: - Single value - Object value - Sequence of values (array) Single value are can be converted to string, int, boolean, enum like values. Object value is a key:value structure (like a hash). Sequence of values are index based structure. All these 3 types are modeled into a single Value class. At any time you can treat a value as 1) single, 2) hash or 3) array of them.

Since:

2.0.0

Author:

edgar

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static Value`	`array(String name, List<String> values)` Creates a sequence/array of values.
`default boolean`	`booleanValue()` Convert this value to boolean (if possible).
`default boolean`	`booleanValue(boolean defaultValue)` Convert this value to boolean (if possible) or fallback to given value when missing.
`default byte`	`byteValue()` Convert this value to byte (if possible).
`default byte`	`byteValue(byte defaultValue)` Convert this value to byte (if possible) or fallback to given value when missing.
`static Value`	`create(String name, List<String> values)` Creates a value that fits better with the given values.
`default double`	`doubleValue()` Convert this value to double (if possible).
`default double`	`doubleValue(double defaultValue)` Convert this value to double (if possible) or fallback to given value when missing.
`default FileUpload`	`fileUpload()` Get a file upload from this value.
`default float`	`floatValue()` Convert this value to float (if possible).
`default float`	`floatValue(float defaultValue)` Convert this value to float (if possible) or fallback to given value when missing.
`Value`	`get(int index)` Get a value at the given position.
`Value`	`get(String name)` Get a value that matches the given name.
`static Value`	`hash(Map<String,Collection<String>> values)` Create a hash/object value using the map values.
`default int`	`intValue()` Convert this value to int (if possible).
`default int`	`intValue(int defaultValue)` Convert this value to int (if possible) or fallback to given value when missing.
`default boolean`	`isArray()` True if this value is an array/sequence (not single or hash).
`default boolean`	`isMissing()` True for missing values.
`default boolean`	`isObject()` True if this is a hash/object value (not single or array).
`default boolean`	`isSingle()` True if this is a single value (not a hash or array).
`default boolean`	`isUpload()` True if this is a file upload (not single, not array, not hash).
`default Iterator<Value>`	`iterator()` Value iterator.
`default long`	`longValue()` Convert this value to long (if possible).
`default long`	`longValue(long defaultValue)` Convert this value to long (if possible) or fallback to given value when missing.
`static Value`	`missing(String name)` Creates a missing value.
`String`	`name()` Name of this value or `null`.
`default String`	`resolve(String expression)` Process the given expression and resolve value references.
`default String`	`resolve(String expression, boolean ignoreMissing)` Process the given expression and resolve value references.
`default String`	`resolve(String expression, boolean ignoreMissing, String startDelim, String endDelim)` Process the given expression and resolve value references.
`default String`	`resolve(String expression, String startDelim, String endDelim)` Process the given expression and resolve value references.
`default int`	`size()` The number of values this one has.
`default <T> T`	`to(Class<T> type)` Convert this value to the given type.
`default <T> T`	`to(Reified<T> type)` Convert this value to the given type.
`default <T> T`	`to(Type type)` Convert this value to the given type.
`default <T extends Enum<T>> T`	`toEnum(Throwing.Function<String,T> fn)` Convert this value to an Enum.
`default <T extends Enum<T>> T`	`toEnum(Throwing.Function<String,T> fn, Function<String,String> nameProvider)` Convert this value to an Enum.
`default List<String>`	`toList()` Get list of values.
`default <T> List<T>`	`toList(Class<T> type)` Get list of the given type.
`default Map<String,String>`	`toMap()` Value as single-value map.
`Map<String,List<String>>`	`toMultimap()` Value as multi-value map.
`default Optional<String>`	`toOptional()` Get a value or empty optional.
`default <T> Optional<T>`	`toOptional(Class<T> type)` Get a value or empty optional.
`default Set<String>`	`toSet()` Get set of values.
`default <T> Set<T>`	`toSet(Class<T> type)` Get set of the given type.
`String`	`value()` Get string value.
`default String`	`value(String defaultValue)` Convert this value to String (if possible) or fallback to given value when missing.
`static Value`	`value(String name, String value)` Creates a single value.
`default <T> T`	`value(Throwing.Function<String,T> fn)` Convert value using the given function.
`default String`	`valueOrNull()` Convert this value to String (if possible) or `null` when missing.

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - longValue
```
default long longValue()
```
    Convert this value to long (if possible).
    
    Returns:
    
    Long value.
  - longValue
```
default long longValue(long defaultValue)
```
    Convert this value to long (if possible) or fallback to given value when missing.
    
    Parameters:
    
    defaultValue - Default value.
    
    Returns:
    
    Convert this value to long (if possible) or fallback to given value when missing.
  - intValue
```
default int intValue()
```
    Convert this value to int (if possible).
    
    Returns:
    
    Int value.
  - intValue
```
default int intValue(int defaultValue)
```
    Convert this value to int (if possible) or fallback to given value when missing.
    
    Parameters:
    
    defaultValue - Default value.
    
    Returns:
    
    Convert this value to int (if possible) or fallback to given value when missing.
  - byteValue
```
default byte byteValue()
```
    Convert this value to byte (if possible).
    
    Returns:
    
    Convert this value to byte (if possible).
  - byteValue
```
default byte byteValue(byte defaultValue)
```
    Convert this value to byte (if possible) or fallback to given value when missing.
    
    Parameters:
    
    defaultValue - Default value.
    
    Returns:
    
    Convert this value to byte (if possible) or fallback to given value when missing.
  - floatValue
```
default float floatValue()
```
    Convert this value to float (if possible).
    
    Returns:
    
    Convert this value to float (if possible).
  - floatValue
```
default float floatValue(float defaultValue)
```
    Convert this value to float (if possible) or fallback to given value when missing.
    
    Parameters:
    
    defaultValue - Default value.
    
    Returns:
    
    Convert this value to float (if possible) or fallback to given value when missing.
  - doubleValue
```
default double doubleValue()
```
    Convert this value to double (if possible).
    
    Returns:
    
    Convert this value to double (if possible).
  - doubleValue
```
default double doubleValue(double defaultValue)
```
    Convert this value to double (if possible) or fallback to given value when missing.
    
    Parameters:
    
    defaultValue - Default value.
    
    Returns:
    
    Convert this value to double (if possible) or fallback to given value when missing.
  - booleanValue
```
default boolean booleanValue()
```
    Convert this value to boolean (if possible).
    
    Returns:
    
    Convert this value to boolean (if possible).
  - booleanValue
```
default boolean booleanValue(boolean defaultValue)
```
    Convert this value to boolean (if possible) or fallback to given value when missing.
    
    Parameters:
    
    defaultValue - Default value.
    
    Returns:
    
    Convert this value to boolean (if possible) or fallback to given value when missing.
  - value
```
@Nonnull
default String value(@Nonnull
                              String defaultValue)
```
    Convert this value to String (if possible) or fallback to given value when missing.
    
    Parameters:
    
    defaultValue - Default value.
    
    Returns:
    
    Convert this value to String (if possible) or fallback to given value when missing.
  - valueOrNull
```
@Nonnull
default String valueOrNull()
```
    Convert this value to String (if possible) or null when missing.
    
    Returns:
    
    Convert this value to String (if possible) or null when missing.
  - isArray
```
default boolean isArray()
```
    True if this value is an array/sequence (not single or hash).
    
    Returns:
    
    True if this value is an array/sequence.
  - isSingle
```
default boolean isSingle()
```
    True if this is a single value (not a hash or array).
    
    Returns:
    
    True if this is a single value (not a hash or array).
  - isObject
```
default boolean isObject()
```
    True if this is a hash/object value (not single or array).
    
    Returns:
    
    True if this is a hash/object value (not single or array).
  - isUpload
```
default boolean isUpload()
```
    True if this is a file upload (not single, not array, not hash).
    
    Returns:
    
    True for file upload.
  - isMissing
```
default boolean isMissing()
```
    True for missing values.
    
    Returns:
    
    True for missing values.
  - value
```
@Nonnull
default <T> T value(@Nonnull
                             Throwing.Function<String,T> fn)
```
    Convert value using the given function.
    
    Type Parameters:
    
    T - Target type.
    
    Parameters:
    
    fn - Function.
    
    Returns:
    
    Converted value.
  - value
```
@Nonnull
String value()
```
    Get string value.
    
    Returns:
    
    String value.
  - toList
```
@Nonnull
default List<String> toList()
```
    Get list of values.
    
    Returns:
    
    List of values.
  - toSet
```
@Nonnull
default Set<String> toSet()
```
    Get set of values.
    
    Returns:
    
    set of values.
  - toList
```
@Nonnull
default <T> List<T> toList(@Nonnull
                                    Class<T> type)
```
    Get list of the given type.
    
    Type Parameters:
    
    T - Item type.
    
    Parameters:
    
    type - Type to convert.
    
    Returns:
    
    List of items.
  - toSet
```
@Nonnull
default <T> Set<T> toSet(@Nonnull
                                  Class<T> type)
```
    Get set of the given type.
    
    Type Parameters:
    
    T - Item type.
    
    Parameters:
    
    type - Type to convert.
    
    Returns:
    
    Set of items.
  - toEnum
```
@Nonnull
default <T extends Enum<T>> T toEnum(@Nonnull
                                              Throwing.Function<String,T> fn)
```
    Convert this value to an Enum.
    
    Type Parameters:
    
    T - Enum type.
    
    Parameters:
    
    fn - Mapping function.
    
    Returns:
    
    Enum.
  - toEnum
```
@Nonnull
default <T extends Enum<T>> T toEnum(@Nonnull
                                              Throwing.Function<String,T> fn,
                                              @Nonnull
                                              Function<String,String> nameProvider)
```
    Convert this value to an Enum.
    
    Type Parameters:
    
    T - Enum type.
    
    Parameters:
    
    fn - Mapping function.
    
    nameProvider - Enum name provider.
    
    Returns:
    
    Enum.
  - toOptional
```
@Nonnull
default Optional<String> toOptional()
```
    Get a value or empty optional.
    
    Returns:
    
    Value or empty optional.
  - toOptional
```
@Nonnull
default <T> Optional<T> toOptional(@Nonnull
                                            Class<T> type)
```
    Get a value or empty optional.
    
    Type Parameters:
    
    T - Item type.
    
    Parameters:
    
    type - Item type.
    
    Returns:
    
    Value or empty optional.
  - fileUpload
```
default FileUpload fileUpload()
```
    Get a file upload from this value.
    
    Returns:
    
    A file upload.
  - get
```
@Nonnull
Value get(@Nonnull
                   int index)
```
    Get a value at the given position.
    
    Parameters:
    
    index - Position.
    
    Returns:
    
    A value at the given position.
  - get
```
@Nonnull
Value get(@Nonnull
                   String name)
```
    Get a value that matches the given name.
    
    Parameters:
    
    name - Field name.
    
    Returns:
    
    Field value.
  - size
```
default int size()
```
    The number of values this one has. For single values size is 0.
    
    Returns:
    
    Number of values. Mainly for array and hash values.
  - to
```
@Nonnull
default <T> T to(@Nonnull
                          Class<T> type)
```
    Convert this value to the given type. Support values are single-value, array-value and object-value. Object-value can be converted to a JavaBean type.
    
    Type Parameters:
    
    T - Element type.
    
    Parameters:
    
    type - Type to convert.
    
    Returns:
    
    Instance of the type.
  - to
```
@Nonnull
default <T> T to(@Nonnull
                          Type type)
```
    Convert this value to the given type. Support values are single-value, array-value and object-value. Object-value can be converted to a JavaBean type.
    
    Type Parameters:
    
    T - Element type.
    
    Parameters:
    
    type - Type to convert.
    
    Returns:
    
    Instance of the type.
  - to
```
@Nonnull
default <T> T to(@Nonnull
                          Reified<T> type)
```
    Convert this value to the given type. Support values are single-value, array-value and object-value. Object-value can be converted to a JavaBean type.
    
    Type Parameters:
    
    T - Element type.
    
    Parameters:
    
    type - Type to convert.
    
    Returns:
    
    Instance of the type.
  - iterator
```
@Nonnull
default Iterator<Value> iterator()
```
    Value iterator.
    
    Specified by:
    
    iterator in interface Iterable<Value>
    
    Returns:
    
    Value iterator.
  - name
```
@Nullable
String name()
```
    Name of this value or null.
    
    Returns:
    
    Name of this value or null.
  - toMultimap
```
@Nullable
Map<String,List<String>> toMultimap()
```
    Value as multi-value map.
    
    Returns:
    
    Value as multi-value map.
  - toMap
```
@Nonnull
default Map<String,String> toMap()
```
    Value as single-value map.
    
    Returns:
    
    Value as single-value map.
  - resolve
```
@Nonnull
default String resolve(@Nonnull
                                String expression)
```
    Process the given expression and resolve value references.
```
   Value value = Value.single("foo", "bar");

   String output = value.resolve("${foo}");
   System.out.println(output);
 
```
    Parameters:
    
    expression - Text expression.
    
    Returns:
    
    Resolved text.
  - resolve
```
@Nonnull
default String resolve(@Nonnull
                                String expression,
                                boolean ignoreMissing)
```
    Process the given expression and resolve value references.
```
   Value value = Value.single("foo", "bar");

   String output = value.resolve("${missing}", true);
   System.out.println(output);
 
```
    Parameters:
    
    expression - Text expression.
    
    ignoreMissing - On missing values, keep the expression as it is.
    
    Returns:
    
    Resolved text.
  - resolve
```
@Nonnull
default String resolve(@Nonnull
                                String expression,
                                @Nonnull
                                String startDelim,
                                @Nonnull
                                String endDelim)
```
    Process the given expression and resolve value references.
```
   Value value = Value.single("foo", "bar");

   String output = value.resolve("<%missing%>", "<%", "%>");
   System.out.println(output);
 
```
    Parameters:
    
    expression - Text expression.
    
    startDelim - Start delimiter.
    
    endDelim - End delimiter.
    
    Returns:
    
    Resolved text.
  - resolve
```
@Nonnull
default String resolve(@Nonnull
                                String expression,
                                boolean ignoreMissing,
                                @Nonnull
                                String startDelim,
                                @Nonnull
                                String endDelim)
```
    Process the given expression and resolve value references.
```
   Value value = Value.single("foo", "bar");

   String output = value.resolve("<%missing%>", "<%", "%>");
   System.out.println(output);
 
```
    Parameters:
    
    expression - Text expression.
    
    ignoreMissing - On missing values, keep the expression as it is.
    
    startDelim - Start delimiter.
    
    endDelim - End delimiter.
    
    Returns:
    
    Resolved text.
  - missing
```
@Nonnull
static Value missing(@Nonnull
                              String name)
```
    Creates a missing value.
    
    Parameters:
    
    name - Name of missing value.
    
    Returns:
    
    Missing value.
  - value
```
@Nonnull
static Value value(@Nonnull
                            String name,
                            @Nonnull
                            String value)
```
    Creates a single value.
    
    Parameters:
    
    name - Name of value.
    
    value - Value.
    
    Returns:
    
    Single value.
  - array
```
@Nonnull
static Value array(@Nonnull
                            String name,
                            @Nonnull
                            List<String> values)
```
    Creates a sequence/array of values.
    
    Parameters:
    
    name - Name of array.
    
    values - Field values.
    
    Returns:
    
    Array value.
  - create
```
@Nonnull
static Value create(@Nonnull
                             String name,
                             @Nullable
                             List<String> values)
```
    Creates a value that fits better with the given values. - For null/empty values. It produces a missing value. - For single element (size==1). It produces a single value - For multi-value elements (size>1). It produces an array value.
    
    Parameters:
    
    name - Field name.
    
    values - Field values.
    
    Returns:
    
    A value.
  - hash
```
@Nonnull
static Value hash(@Nonnull
                           Map<String,Collection<String>> values)
```
    Create a hash/object value using the map values.
    
    Parameters:
    
    values - Map values.
    
    Returns:
    
    A hash/object value.

Interface Value

Method Summary

Methods inherited from interface java.lang.Iterable

Method Detail

longValue

longValue

intValue

intValue

byteValue

byteValue

floatValue

floatValue

doubleValue

doubleValue

booleanValue

booleanValue

value

valueOrNull

isArray

isSingle

isObject

isUpload

isMissing

value

value

toList

toSet

toList

toSet

toEnum

toEnum

toOptional

toOptional

fileUpload

get

get

size

to

to

to

iterator

name

toMultimap

toMap

resolve

resolve

resolve

resolve

missing

value

array

create

hash