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

Interface IStringValueDescriptorBuilder

All Superinterfaces:

org.apache.commons.lang3.builder.Builder<IStringValueDescriptor>, IValueDescriptorBuilder<String,IStringValueBuilder,IStringValueDescriptor>

public interface IStringValueDescriptorBuilder
extends IValueDescriptorBuilder<String,IStringValueBuilder,IStringValueDescriptor>

A IValueDescriptorBuilder for creating a string value descriptors.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IStringValueDescriptorBuilder	addAttribute(String key, Object value)	Adds a custom attribute to the value descriptor.
IStringValueDescriptorBuilder	addAttributes(Map<String,Object> attributes)	Adds custom attributes to the value descriptor.
IStringValueDescriptorBuilder	attributes(Map<String,Object> attributes)	Set the custom attributes for the value descriptor.
IStringValueDescriptorBuilder	defaultValue(String defaultValue)	Sets the default string used when no value is provided.
IStringValueDescriptorBuilder	description(String description)	Deprecated.
IStringValueDescriptorBuilder	length(com.google.common.collect.Range<Integer> length)	Restricts the length of the string value to a certain range.

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

build

Method Detail

addAttribute

@CanIgnoreReturnValue
IStringValueDescriptorBuilder 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<String,IStringValueBuilder,IStringValueDescriptor>

Parameters:

key - The attribute key.

value - The attribute value.

Returns:

This builder instance for chaining method calls.

See Also:

StandardValueDescriptorAttributes

addAttributes

@CanIgnoreReturnValue
IStringValueDescriptorBuilder 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<String,IStringValueBuilder,IStringValueDescriptor>

Returns:

This builder instance for chaining method calls.

See Also:

StandardValueDescriptorAttributes

attributes

@CanIgnoreReturnValue
IStringValueDescriptorBuilder 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<String,IStringValueBuilder,IStringValueDescriptor>

Returns:

This builder instance for chaining method calls.

See Also:

StandardValueDescriptorAttributes

defaultValue

@CanIgnoreReturnValue
IStringValueDescriptorBuilder defaultValue(@Nonnull
                                           String defaultValue)

Sets the default string used when no value is provided. The default value is the empty string when no explicit default is provided.

Parameters:

defaultValue - Default value to use.

Returns:

This descriptor builder for chaining method calls.

description

@CanIgnoreReturnValue
@Deprecated
IStringValueDescriptorBuilder 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<String,IStringValueBuilder,IStringValueDescriptor>

Parameters:

description - The description for the value.

Returns:

This builder instance for chaining method calls.

length

@CanIgnoreReturnValue
IStringValueDescriptorBuilder length(com.google.common.collect.Range<Integer> length)

Restricts the length of the string value to a certain range.

Parameters:

length - Range for the allowed length of the string.

Returns:

This descriptor builder for chaining method calls.