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

Interface ITupleValueDescriptorBuilder

All Superinterfaces:

org.apache.commons.lang3.builder.Builder<ITupleValueDescriptor>, IValueDescriptorBuilder<List<?>,ITupleValueBuilder,ITupleValueDescriptor>

public interface ITupleValueDescriptorBuilder
extends IValueDescriptorBuilder<List<?>,ITupleValueBuilder,ITupleValueDescriptor>

A IValueDescriptorBuilder for creating a tuple value descriptor. Use IValueDescriptorFactory.tupleBuilder() to create a builder.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
default ITupleValueDescriptorBuilder	add(IValueDescriptor<?,?> descriptor)	Adds an element of a certain type to the tuple.
ITupleValueDescriptorBuilder	add(IValueDescriptorCreator creator)	Adds an element of a certain type to the tuple.
ITupleValueDescriptorBuilder	addAttribute(String key, Object value)	Adds a custom attribute to the value descriptor.
ITupleValueDescriptorBuilder	addAttributes(Map<String,Object> attributes)	Adds custom attributes to the value descriptor.
ITupleValueDescriptorBuilder	attributes(Map<String,Object> attributes)	Set the custom attributes for the value descriptor.
ITupleValueDescriptorBuilder	description(String description)	Deprecated.

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

build

Method Detail

add

@CanIgnoreReturnValue
ITupleValueDescriptorBuilder add(IValueDescriptorCreator creator)

Adds an element of a certain type to the tuple. Uses the default value of the configured descriptor.

Parameters:

creator - Creator for the value descriptor of the tuple element.

Returns:

This value descriptor builder for chaining method calls.

add

@CanIgnoreReturnValue
default ITupleValueDescriptorBuilder add(IValueDescriptor<?,?> descriptor)

Adds an element of a certain type to the tuple. Uses the default value of the given descriptor.

Parameters:

descriptor - Value descriptor of the tuple element.

Returns:

This value descriptor builder for chaining method calls.

addAttribute

@CanIgnoreReturnValue
ITupleValueDescriptorBuilder 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<List<?>,ITupleValueBuilder,ITupleValueDescriptor>

Parameters:

key - The attribute key.

value - The attribute value.

Returns:

This builder instance for chaining method calls.

See Also:

StandardValueDescriptorAttributes

addAttributes

@CanIgnoreReturnValue
ITupleValueDescriptorBuilder 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<List<?>,ITupleValueBuilder,ITupleValueDescriptor>

Returns:

This builder instance for chaining method calls.

See Also:

StandardValueDescriptorAttributes

attributes

@CanIgnoreReturnValue
ITupleValueDescriptorBuilder 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<List<?>,ITupleValueBuilder,ITupleValueDescriptor>

Returns:

This builder instance for chaining method calls.

See Also:

StandardValueDescriptorAttributes

description

@CanIgnoreReturnValue
@Deprecated
ITupleValueDescriptorBuilder 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<List<?>,ITupleValueBuilder,ITupleValueDescriptor>

Parameters:

description - The description for the value.

Returns:

This builder instance for chaining method calls.