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

Interface IMapValueDescriptor<V>

Type Parameters:

V - Type of the mapped values.

All Superinterfaces:

IValueDescriptor<Map<String,V>,IMapValueBuilder<V>>, Serializable

public interface IMapValueDescriptor<V>
extends IValueDescriptor<Map<String,V>,IMapValueBuilder<V>>

A IValueDescriptor for a map value. The value must be a map from string to values. The key is always a string, and all values must conform to the same type of values. Compared with IRecordValueDescriptor, a map value descriptor requires all values to be of the same type, but allows arbitrary keys.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IMapValueDescriptorBuilder<V>	configure()	Creates a new builder pre-configured with the settings of this descriptor.
default EValueType	getBaseType()
default Class<?>	getJavaClass()
IValueDescriptor<V,? extends IValueBuilder<V>>	getMapValueDescriptor()
IMapValueDescriptor<V>	withDefaultValue(Object defaultValue)
IMapValueDescriptor<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

IMapValueDescriptorBuilder<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<Map<String,V>,IMapValueBuilder<V>>

Returns:

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

getBaseType

default EValueType getBaseType()

Specified by:

getBaseType in interface IValueDescriptor<Map<String,V>,IMapValueBuilder<V>>

Returns:

The basic type of value described by this value descriptor.

getJavaClass

default Class<?> getJavaClass()

Specified by:

getJavaClass in interface IValueDescriptor<Map<String,V>,IMapValueBuilder<V>>

Returns:

The Java class of the values described by this descriptor.

getMapValueDescriptor

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

Returns:

The value descriptor for the map values. Each value in the map must conform to this descriptor.

withDefaultValue

IMapValueDescriptor<V> withDefaultValue(Object defaultValue)

Specified by:

withDefaultValue in interface IValueDescriptor<Map<String,V>,IMapValueBuilder<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

IMapValueDescriptor<V> withDescription(String description)

Specified by:

withDescription in interface IValueDescriptor<Map<String,V>,IMapValueBuilder<V>>

Parameters:

description - The new description.

Returns:

A new descriptor with the given description.