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

Interface IMapValueDescriptorBuilder<V>

Type Parameters:

V - Type of the map values.

All Superinterfaces:

org.apache.commons.lang3.builder.Builder<IMapValueDescriptor<V>>, IValueDescriptorBuilder<Map<String,V>,IMapValueBuilder<V>,IMapValueDescriptor<V>>

public interface IMapValueDescriptorBuilder<V>
extends IValueDescriptorBuilder<Map<String,V>,IMapValueBuilder<V>,IMapValueDescriptor<V>>

A IValueDescriptorBuilder for creating a map value descriptor. Use IValueDescriptorFactory.mapBuilder(IValueDescriptor) to create a builder.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IMapValueDescriptorBuilder<V>	defaultValue(String key, IValueCreator<V> creator)	Sets the default value for the element at the given key.
default IMapValueDescriptorBuilder<V>	defaultValue(String key, V value)	Sets the default value for the element at the given key.
IMapValueDescriptorBuilder<V>	description(String description)

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

build

Method Detail

defaultValue

IMapValueDescriptorBuilder<V> defaultValue(String key,
                                           IValueCreator<V> creator)

Sets the default value for the element at the given key. The default value is taken from the map element value descriptor when no explicit default is provided.

Parameters:

key - Key in the map.

creator - Value creator for the value to use for the value at the given key as the default when creating a map value.

Returns:

This descriptor builder for chaining method calls.

defaultValue

default IMapValueDescriptorBuilder<V> defaultValue(String key,
                                                   V value)

Sets the default value for the element at the given key. The default value is taken from the map element value descriptor when no explicit default is provided.

Parameters:

key - Key in the map.

value - Value to use for the value at the given key as the default when creating a map value.

Returns:

This descriptor builder for chaining method calls.

description

IMapValueDescriptorBuilder<V> description(String description)

Specified by:

description in interface IValueDescriptorBuilder<Map<String,V>,IMapValueBuilder<V>,IMapValueDescriptor<V>>

Parameters:

description - The description for the value. May be either a localized message or an I18N key.

Returns:

This builder instance for chaining method calls.