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

Interface IConstValueDescriptor<V>

Type Parameters:

V - Type of the constant value.

All Superinterfaces:

IValueDescriptor<V,IConstValueBuilder<V>>, Serializable

public interface IConstValueDescriptor<V>
extends IValueDescriptor<V,IConstValueBuilder<V>>

A IValueDescriptor for a constant value. The value must be equal to a certain constant value.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IConstValueDescriptorBuilder<V>	configure()	Creates a new builder pre-configured with the settings of this descriptor.
default EValueType	getBaseType()
V	getValue()
EValueType	getValueType()
IConstValueDescriptor<V>	withDefaultValue(Object defaultValue)
IConstValueDescriptor<V>	withDescription(String description)

Methods inherited from interface de.xima.fc.interfaces.workflow.value.IValueDescriptor

acceptsValue, asAny, asBoolean, asConst, asFloat, asInteger, asLargeString, asList, asList, asMap, asMap, asNull, asRecord, asString, asTuple, asUnion, asUnion, asVoid, builder, getDefaultValue, getDescription, getFullType, getJavaClass, getKnownProperties, getKnownProperties, intersect, is, unwrap

Method Detail

configure

IConstValueDescriptorBuilder<V> configure()

Description copied from interface: IValueDescriptor

Creates a new builder pre-configured with the settings of this descriptor. Lets you e.g. add additional properties.

Specified by:

configure in interface IValueDescriptor<V,IConstValueBuilder<V>>

Returns:

A new builder pre-configured with the settings of this descriptor.

getBaseType

default EValueType getBaseType()

Specified by:

getBaseType in interface IValueDescriptor<V,IConstValueBuilder<V>>

Returns:

The basic type of value described by this value descriptor.

getValue

V getValue()

Returns:

The constant to which the value described by this descriptor must be equal to.

getValueType

EValueType getValueType()

Returns:

The type of the wrapped constant value.

Since:

8.1.0

withDefaultValue

IConstValueDescriptor<V> withDefaultValue(Object defaultValue)

Specified by:

withDefaultValue in interface IValueDescriptor<V,IConstValueBuilder<V>>

Parameters:

defaultValue - The new default value. May be changed when it does not conform to the restrictions imposed by this descriptor.

Returns:

A new descriptor with the default value.

withDescription

IConstValueDescriptor<V> withDescription(String description)

Specified by:

withDescription in interface IValueDescriptor<V,IConstValueBuilder<V>>

Parameters:

description - The new description.

Returns:

A new descriptor with the given description.