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

Interface IValueDescriptorBuilder<V,TBuilder extends IValueBuilder<V>,TDesc extends IValueDescriptor<V,TBuilder>>

Type Parameters:

V - Type of the Java object representing the data.

TBuilder - Type of the builder for creating a new instance of the data type described by the descriptor created by this builder.

TDesc - Type of the value descriptor created by this builder.

All Superinterfaces:

org.apache.commons.lang3.builder.Builder<TDesc>

All Known Subinterfaces:

IAnyValueDescriptorBuilder, IBooleanValueDescriptorBuilder, IConstValueDescriptorBuilder<V>, IFloatValueDescriptorBuilder, IIntegerValueDescriptorBuilder, ILargeStringValueDescriptorBuilder, IListValueDescriptorBuilder<V>, IMapValueDescriptorBuilder<V>, INullValueDescriptorBuilder, IRecordValueDescriptorBuilder, IStringValueDescriptorBuilder, ITupleValueDescriptorBuilder, IUnionValueDescriptorBuilder

public interface IValueDescriptorBuilder<V,TBuilder extends IValueBuilder<V>,TDesc extends IValueDescriptor<V,TBuilder>>
extends org.apache.commons.lang3.builder.Builder<TDesc>

Base interface for builders that create a IValueDescriptor which imposes certain restrictions on the values it allows.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IValueDescriptorBuilder<V,TBuilder,TDesc>	addAttribute(String key, Object value)	Adds a custom attribute to the value descriptor.
IValueDescriptorBuilder<V,TBuilder,TDesc>	addAttributes(Map<String,Object> attributes)	Adds custom attributes to the value descriptor.
IValueDescriptorBuilder<V,TBuilder,TDesc>	attributes(Map<String,Object> attributes)	Set the custom attributes for the value descriptor.
IValueDescriptorBuilder<V,TBuilder,TDesc>	description(String description)	Deprecated. Use addAttribute(String, Object) with the key StandardValueDescriptorAttributes.VALUE_DESCRIPTOR_ATTR_DESCRIPTION instead.

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

build

Method Detail

addAttribute

@CanIgnoreReturnValue
IValueDescriptorBuilder<V,TBuilder,TDesc> addAttribute(String key,
                                                                   Object value)

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.

Parameters:

key - The attribute key.

value - The attribute value.

Returns:

This builder instance for chaining method calls.

See Also:

StandardValueDescriptorAttributes

addAttributes

@CanIgnoreReturnValue
IValueDescriptorBuilder<V,TBuilder,TDesc> addAttributes(Map<String,Object> attributes)

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.

Returns:

This builder instance for chaining method calls.

See Also:

StandardValueDescriptorAttributes

attributes

@CanIgnoreReturnValue
IValueDescriptorBuilder<V,TBuilder,TDesc> attributes(Map<String,Object> attributes)

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.

Returns:

This builder instance for chaining method calls.

See Also:

StandardValueDescriptorAttributes

description

@CanIgnoreReturnValue
IValueDescriptorBuilder<V,TBuilder,TDesc> description(String description)

Deprecated.

Use addAttribute(String, Object) with the key StandardValueDescriptorAttributes.VALUE_DESCRIPTOR_ATTR_DESCRIPTION instead.

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.

Parameters:

description - The description for the value.

Returns:

This builder instance for chaining method calls.