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

Interface IIntegerValueDescriptorBuilder

All Superinterfaces:

org.apache.commons.lang3.builder.Builder<IIntegerValueDescriptor>, IValueDescriptorBuilder<Number,IIntegerValueBuilder,IIntegerValueDescriptor>

public interface IIntegerValueDescriptorBuilder
extends IValueDescriptorBuilder<Number,IIntegerValueBuilder,IIntegerValueDescriptor>

A IValueDescriptorBuilder for creating a 64-bit integer value descriptor.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

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

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

build

Method Detail

addAttribute

@CanIgnoreReturnValue
IIntegerValueDescriptorBuilder 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,IIntegerValueBuilder,IIntegerValueDescriptor>

Parameters:

key - The attribute key.

value - The attribute value.

Returns:

This builder instance for chaining method calls.

See Also:

StandardValueDescriptorAttributes

addAttributes

@CanIgnoreReturnValue
IIntegerValueDescriptorBuilder 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,IIntegerValueBuilder,IIntegerValueDescriptor>

Returns:

This builder instance for chaining method calls.

See Also:

StandardValueDescriptorAttributes

attributes

@CanIgnoreReturnValue
IIntegerValueDescriptorBuilder 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,IIntegerValueBuilder,IIntegerValueDescriptor>

Returns:

This builder instance for chaining method calls.

See Also:

StandardValueDescriptorAttributes

defaultValue

@CanIgnoreReturnValue
IIntegerValueDescriptorBuilder defaultValue(long defaultValue)

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

Parameters:

defaultValue - Value to use as the default when creating an integer value.

Returns:

This descriptor builder for chaining method calls.

defaultValue

@CanIgnoreReturnValue
default IIntegerValueDescriptorBuilder defaultValue(Number defaultValue)

Parameters:

defaultValue - Value to use as the default when creating an integer value.

Returns:

This descriptor builder for chaining method calls.

description

@CanIgnoreReturnValue
@Deprecated
IIntegerValueDescriptorBuilder 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,IIntegerValueBuilder,IIntegerValueDescriptor>

Parameters:

description - The description for the value.

Returns:

This builder instance for chaining method calls.

range

@CanIgnoreReturnValue
IIntegerValueDescriptorBuilder range(com.google.common.collect.Range<Long> range)

Parameters:

range - Range of integer value allowed when creating a value.

Returns:

This descriptor builder for chaining method calls.