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

Interface IListValueDescriptor<V>

Type Parameters:

V - Type of the list elements.

All Superinterfaces:

IValueDescriptor<List<V>,IListValueBuilder<V>>, Serializable

public interface IListValueDescriptor<V>
extends IValueDescriptor<List<V>,IListValueBuilder<V>>

A IValueDescriptor for a list value. The value must be a list of elements. Optionally, the length of the list can be restricted.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IListValueDescriptorBuilder<V>	configure()	Creates a new builder pre-configured with the settings of this descriptor.
default EValueType	getBaseType()
IValueDescriptor<V,? extends IValueBuilder<V>>	getItemValueDescriptor()
default Class<?>	getJavaClass()
com.google.common.collect.Range<Integer>	getLength()
IListValueDescriptor<V>	withDefaultValue(Object defaultValue)
IListValueDescriptor<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, getKnownProperties, getKnownProperties, intersect, is, unwrap

Method Detail

configure

IListValueDescriptorBuilder<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<List<V>,IListValueBuilder<V>>

Returns:

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

getBaseType

default EValueType getBaseType()

Specified by:

getBaseType in interface IValueDescriptor<List<V>,IListValueBuilder<V>>

Returns:

The basic type of value described by this value descriptor.

getItemValueDescriptor

IValueDescriptor<V,? extends IValueBuilder<V>> getItemValueDescriptor()

Returns:

The value descriptor for the list elements. Each list element must conform to this descriptor.

getJavaClass

default Class<?> getJavaClass()

Specified by:

getJavaClass in interface IValueDescriptor<List<V>,IListValueBuilder<V>>

Returns:

The Java class of the values described by this descriptor.

getLength

com.google.common.collect.Range<Integer> getLength()

Returns:

The range allowed for the length of the list.

withDefaultValue

IListValueDescriptor<V> withDefaultValue(Object defaultValue)

Specified by:

withDefaultValue in interface IValueDescriptor<List<V>,IListValueBuilder<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

IListValueDescriptor<V> withDescription(String description)

Specified by:

withDescription in interface IValueDescriptor<List<V>,IListValueBuilder<V>>

Parameters:

description - The new description.

Returns:

A new descriptor with the given description.