UnionField (EclipseLink Core 3.0.3-RC1 API)

All Superinterfaces:

CoreField, Field<CONVERSION_MANAGER,NAMESPACE_RESOLVER>

All Known Implementing Classes:

XMLUnionField
```
public interface UnionField<CONVERSION_MANAGER extends ConversionManager,NAMESPACE_RESOLVER extends NamespaceResolver>
extends Field<CONVERSION_MANAGER,NAMESPACE_RESOLVER>
```
Subclass of Field for fields that are mapped to unions. Maintains a list of schema types instead of just one single schema type. Schema types can be added using the addSchemaType API. Constants has a list of useful constants including a list of QNames for built-in schema types that can be used when adding schema types.
When reading and writing an element that is mapped with an UnionField, a conversion to each of the schema types on the field (in the order they are specified ) is tried until a conversion is successful. The Java type to convert to is based on the list of schema type to Java conversion pairs specified on the field.

See Also:

Field, Constants

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addSchemaType(QName value)`	Adds the new type value to the list of types
`List<QName>`	`getSchemaTypes()`	Return the list of schema types

Methods inherited from interface org.eclipse.persistence.internal.core.helper.CoreField
setName, setType

Methods inherited from interface org.eclipse.persistence.internal.oxm.mappings.Field
convertValueBasedOnSchemaType, getJavaClass, getLastXPathFragment, getLeafElementType, getName, getNamespaceResolver, getSchemaType, getSchemaTypeForValue, getType, getXMLType, getXPath, getXPathFragment, hasLastXPathFragment, initialize, isCDATA, isNestedArray, isRequired, isSchemaType, isSelfField, isTypedTextField, isUnionField, setIsCDATA, setIsTypedTextField, setNamespaceResolver, setNestedArray, setRequired, setSchemaType, setUsesSingleNode, setXPath, usesSingleNode

- Method Detail
  - addSchemaType
```
void addSchemaType(QName value)
```
    Adds the new type value to the list of types
    
    Parameters:
    
    value - QName to be added to the list of schema types
  - getSchemaTypes
```
List<QName> getSchemaTypes()
```
    Return the list of schema types
    
    Returns:
    
    the list of types