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

Interface ITupleValueDescriptor

All Superinterfaces:

IValueDescriptor<List<?>,ITupleValueBuilder>, Serializable

public interface ITupleValueDescriptor
extends IValueDescriptor<List<?>,ITupleValueBuilder>

A IValueDescriptor for a tuple value. The value must be a a fixed list of elements. Each element may be of a different type.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
ITupleValueDescriptorBuilder	configure()	Creates a new builder pre-configured with the settings of this descriptor.
default EValueType	getBaseType()
default Class<?>	getJavaClass()
List<IValueDescriptor<?,?>>	getTupleValueDescriptors()
ITupleValueDescriptor	withDefaultValue(Object defaultValue)
ITupleValueDescriptor	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, getKnownProperties, getKnownProperties, intersect, is, unwrap

Method Detail

configure

ITupleValueDescriptorBuilder 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<List<?>,ITupleValueBuilder>

Returns:

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

getBaseType

default EValueType getBaseType()

Specified by:

getBaseType in interface IValueDescriptor<List<?>,ITupleValueBuilder>

Returns:

The basic type of value described by this value descriptor.

getJavaClass

default Class<?> getJavaClass()

Specified by:

getJavaClass in interface IValueDescriptor<List<?>,ITupleValueBuilder>

Returns:

The Java class of the values described by this descriptor.

getTupleValueDescriptors

List<IValueDescriptor<?,?>> getTupleValueDescriptors()

Returns:

The value descriptors for each tuple element. The size of this list is equal to the fixed length of the tuple.

withDefaultValue

ITupleValueDescriptor withDefaultValue(Object defaultValue)

Specified by:

withDefaultValue in interface IValueDescriptor<List<?>,ITupleValueBuilder>

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

ITupleValueDescriptor withDescription(String description)

Specified by:

withDescription in interface IValueDescriptor<List<?>,ITupleValueBuilder>

Parameters:

description - The new description.

Returns:

A new descriptor with the given description.