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>	addAttribute(String key, Object value)	Adds a custom attribute to the value descriptor.
IMapValueDescriptorBuilder<V>	addAttributes(Map<String,Object> attributes)	Adds custom attributes to the value descriptor.
IMapValueDescriptorBuilder<V>	attributes(Map<String,Object> attributes)	Set the custom attributes for the value descriptor.
IMapValueDescriptorBuilder<V>	defaultValue(String key, IValueCreator creator)	Sets the default value for the element at the given key.
default IMapValueDescriptorBuilder<V>	defaultValue(String key, Object value)	Sets the default value for the element at the given key.
IMapValueDescriptorBuilder<V>	description(String description)	Deprecated.

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

build

Method Detail

addAttribute

@CanIgnoreReturnValue
IMapValueDescriptorBuilder<V> addAttribute(String key,
                                           Object value)

Description copied from interface: IValueDescriptorBuilder

Adds a custom attribute to the value descriptor. This can be used to store additional metadata about the value that is not covered by the standard properties of the descriptor. The exact meaning of the attributes depends on the context in which the descriptor is used.

See StandardValueDescriptorAttributes for some standard attribute keys and values you can use.

Specified by:

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

Parameters:

key - The attribute key.

value - The attribute value.

Returns:

This builder instance for chaining method calls.

See Also:

StandardValueDescriptorAttributes

addAttributes

@CanIgnoreReturnValue
IMapValueDescriptorBuilder<V> addAttributes(Map<String,Object> attributes)

Description copied from interface: IValueDescriptorBuilder

Adds custom attributes to the value descriptor. These can be used to store additional metadata about the value that is not covered by the standard properties of the descriptor. The exact meaning of the attributes depends on the context in which the descriptor is used.

See StandardValueDescriptorAttributes for some standard attribute keys and values you can use.

Specified by:

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

Returns:

This builder instance for chaining method calls.

See Also:

StandardValueDescriptorAttributes

attributes

@CanIgnoreReturnValue
IMapValueDescriptorBuilder<V> attributes(Map<String,Object> attributes)

Description copied from interface: IValueDescriptorBuilder

Set the custom attributes for the value descriptor. These can be used to store additional metadata about the value that is not covered by the standard properties of the descriptor. The exact meaning of the attributes depends on the context in which the descriptor is used.

See StandardValueDescriptorAttributes for some standard attribute keys and values you can use.

Specified by:

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

Returns:

This builder instance for chaining method calls.

See Also:

StandardValueDescriptorAttributes

defaultValue

@CanIgnoreReturnValue
IMapValueDescriptorBuilder<V> defaultValue(String key,
                                           IValueCreator 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

@CanIgnoreReturnValue
default IMapValueDescriptorBuilder<V> defaultValue(String key,
                                                   Object 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

@CanIgnoreReturnValue
@Deprecated
IMapValueDescriptorBuilder<V> description(String description)

Deprecated.

Description copied from interface: IValueDescriptorBuilder

Sets the description for the value. This description can be used in UIs to provide additional information about the value to users. It can be either a localized message or an I18N key that will be resolved at runtime.

Specified by:

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

Parameters:

description - The description for the value.

Returns:

This builder instance for chaining method calls.