Package de.xima.fc.interfaces.workflow.value

Interface IMapValueBuilder<V>

Type Parameters:

V - Type of the map values.

All Superinterfaces:

org.apache.commons.lang3.builder.Builder<Map<String,V>>, ISubTypeValueBuilder<Map<String,V>,IMapValueBuilder<V>>, IValueBuilder<Map<String,V>>, IValueConfigurator

public interface IMapValueBuilder<V>
extends ISubTypeValueBuilder<Map<String,V>,IMapValueBuilder<V>>

A IValueBuilder for creating a map value.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
default IMapValueBuilder<V>	asThis()
IMapValueBuilder<V>	put(String key, IValueCreator creator)	Sets the value in the map at the given key to the given value.
default IMapValueBuilder<V>	put(String key, Object value)	Sets the value in the map at the given key to the given value.
default IMapValueBuilder<V>	value(Object value)	Applies the given value to this builder.

Methods inherited from interface org.apache.commons.lang3.builder.Builder

build

Methods inherited from interface de.xima.fc.interfaces.workflow.value.ISubTypeValueBuilder

whenBoolean, whenConst, whenFloat, whenInteger, whenList, whenMap, whenNull, whenRecord, whenString, whenTuple, whenUnion, whenVoid

Methods inherited from interface de.xima.fc.interfaces.workflow.value.IValueBuilder

asBoolean, asConst, asFloat, asInteger, asList, asMap, asNull, asRecord, asString, asTuple, asUnion, asVoid, is, unwrap, whenUnion

Method Detail

asThis

default IMapValueBuilder<V> asThis()

Specified by:

asThis in interface ISubTypeValueBuilder<Map<String,V>,IMapValueBuilder<V>>

Returns:

This instance.

put

IMapValueBuilder<V> put(String key,
                        IValueCreator creator)

Sets the value in the map at the given key to the given value.

Parameters:

key - A key in the map.

creator - Value creator for the value at the given key.

Returns:

This value builder for chaining method calls.

put

default IMapValueBuilder<V> put(String key,
                                Object value)

Sets the value in the map at the given key to the given value.

Parameters:

key - A key in the map.

value - The value at the given key.

Returns:

This value builder for chaining method calls.

value

default IMapValueBuilder<V> value(Object value)

Description copied from interface: IValueConfigurator

Applies the given value to this builder. Implementations are allowed to perform validity checks on the passed value and reject the given value or parts of it (in case of lists etc.) when they do not conform to the restrictions imposed by this builder.

Specified by:

value in interface ISubTypeValueBuilder<Map<String,V>,IMapValueBuilder<V>>

Specified by:

value in interface IValueBuilder<V>

Specified by:

value in interface IValueConfigurator

Parameters:

value - Sets the value created by this builder.

Returns:

getThis() builder instance for chaining method calls.