IUnionValueDescriptor (formcycle: bom 8.1.2 API)

Type Parameters:: D - Type of the union discriminator.

All Superinterfaces:: IValueDescriptor<Object,IUnionValueBuilder<D>>, Serializable

public interface IUnionValueDescriptor<D> extends IValueDescriptor<Object,IUnionValueBuilder<D>>

A IValueDescriptor for a union value. The value must conform to the restrictions of at least one value descriptor.

Since:: 7.0.0
Author:: XIMA MEDIA GmbH

Method Summary

Modifier and Type

Method

Description

default EValueType

getBaseType()

default Class<?>

getJavaClass()

Map<D,IValueDescriptor<?,?>>

getUnionValueDescriptors()

Methods inherited from interface de.xima.fc.interfaces.workflow.value.IValueDescriptor
acceptsValue, asBoolean, asConst, asFloat, asInteger, asList, asMap, asNull, asRecord, asString, asTuple, asUnion, asVoid, builder, getDefaultValue, getDescription, getFullType, getKnownProperties, is, unwrap

Method Details
- getBaseType
  
  default EValueType getBaseType()
  
  Specified by:
  
  getBaseType in interface IValueDescriptor<Object,IUnionValueBuilder<D>>
  
  Returns:
  
  The basic type of value described by this value descriptor.
- getJavaClass
  
  default Class<?> getJavaClass()
  
  Specified by:
  
  getJavaClass in interface IValueDescriptor<Object,IUnionValueBuilder<D>>
  
  Returns:
  
  The Java class of the values described by this descriptor.
- getUnionValueDescriptors
  
  Map<D,IValueDescriptor<?,?>> getUnionValueDescriptors()
  
  Returns:
  
  A map between each union discriminator and the value descriptor for the its value.