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

Interface IFloatValueDescriptorBuilder

All Superinterfaces:

org.apache.commons.lang3.builder.Builder<IFloatValueDescriptor>, IValueDescriptorBuilder<Number,IFloatValueBuilder,IFloatValueDescriptor>

public interface IFloatValueDescriptorBuilder
extends IValueDescriptorBuilder<Number,IFloatValueBuilder,IFloatValueDescriptor>

A IValueDescriptorBuilder for creating a 64-bit floating point value descriptor.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IFloatValueDescriptorBuilder	addAttribute(String key, Object value)	Adds a custom attribute to the value descriptor.
IFloatValueDescriptorBuilder	addAttributes(Map<String,Object> attributes)	Adds custom attributes to the value descriptor.
IFloatValueDescriptorBuilder	attributes(Map<String,Object> attributes)	Set the custom attributes for the value descriptor.
IFloatValueDescriptorBuilder	defaultValue(double defaultValue)	Sets the default floating point value used when no value is provided.
default IFloatValueDescriptorBuilder	defaultValue(Number defaultValue)
IFloatValueDescriptorBuilder	description(String description)	Deprecated.
IFloatValueDescriptorBuilder	range(com.google.common.collect.Range<Double> range)

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

build

Method Detail

addAttribute

@CanIgnoreReturnValue
IFloatValueDescriptorBuilder 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<Number,IFloatValueBuilder,IFloatValueDescriptor>

Parameters:

key - The attribute key.

value - The attribute value.

Returns:

This builder instance for chaining method calls.

See Also:

StandardValueDescriptorAttributes

addAttributes

@CanIgnoreReturnValue
IFloatValueDescriptorBuilder 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<Number,IFloatValueBuilder,IFloatValueDescriptor>

Returns:

This builder instance for chaining method calls.

See Also:

StandardValueDescriptorAttributes

attributes

@CanIgnoreReturnValue
IFloatValueDescriptorBuilder 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<Number,IFloatValueBuilder,IFloatValueDescriptor>

Returns:

This builder instance for chaining method calls.

See Also:

StandardValueDescriptorAttributes

defaultValue

@CanIgnoreReturnValue
IFloatValueDescriptorBuilder defaultValue(double defaultValue)

Sets the default floating point value used when no value is provided. The default value is 0 when no explicit default is provided.

Parameters:

defaultValue - Value to use as the default when creating a floating point value.

Returns:

This descriptor builder for chaining method calls.

defaultValue

@CanIgnoreReturnValue
default IFloatValueDescriptorBuilder defaultValue(Number defaultValue)

Parameters:

defaultValue - Value to use as the default when creating a floating point value.

Returns:

This descriptor builder for chaining method calls.

description

@CanIgnoreReturnValue
@Deprecated
IFloatValueDescriptorBuilder 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<Number,IFloatValueBuilder,IFloatValueDescriptor>

Parameters:

description - The description for the value.

Returns:

This builder instance for chaining method calls.

range

@CanIgnoreReturnValue
IFloatValueDescriptorBuilder range(com.google.common.collect.Range<Double> range)

Parameters:

range - Range of floating point value allowed when creating a value.

Returns:

This descriptor builder for chaining method calls.