Module dev.metaschema.databind

Package dev.metaschema.databind.model

Interface IBoundInstanceModelChoiceGroup

All Superinterfaces:

IBoundInstance<IBoundObject>, IBoundInstanceModel<IBoundObject>, IBoundModelElement, IBoundModelObject<IBoundObject>, IBoundProperty<IBoundObject>, IChoiceGroupInstance, IContainer, IContainerModel, IContainerModelGrouped, IDefaultable, IFeatureContainerModelGrouped<IBoundInstanceModelGroupedNamed,IBoundInstanceModelGroupedField,IBoundInstanceModelGroupedAssembly>, IFeatureJavaField, IGroupable, IInstance, IInstanceAbsolute, IItemValueHandler<IBoundObject>, IJsonInstance, IJsonNamed, IModelElement, IModelElementVisitable, IModelInstance, IModelInstanceAbsolute, IValued, IValuedMutable

public interface IBoundInstanceModelChoiceGroup
extends IBoundInstanceModel<IBoundObject>, IFeatureContainerModelGrouped<IBoundInstanceModelGroupedNamed,IBoundInstanceModelGroupedField,IBoundInstanceModelGroupedAssembly>, IChoiceGroupInstance

Represents a choice group instance bound to Java field.

Field Summary

Fields inherited from interface dev.metaschema.core.model.IChoiceGroupInstance

DEFAULT_CHOICE_GROUP_GROUP_AS_MAX_OCCURS, DEFAULT_JSON_DISCRIMINATOR_PROPERTY_NAME

Fields inherited from interface dev.metaschema.core.model.IGroupable

DEFAULT_GROUP_AS_MAX_OCCURS, DEFAULT_GROUP_AS_MIN_OCCURS, DEFAULT_JSON_GROUP_AS_BEHAVIOR, DEFAULT_XML_GROUP_AS_BEHAVIOR

Method Summary

Modifier and Type	Method	Description
default boolean	canHandleXmlQName(IEnhancedQName qname)	Determine if the provided XML qualified name is associated with this property.
default IBoundObject	deepCopyItem(IBoundObject item, IBoundObject parentInstance)	Create and return a deep copy of the provided item.
default IBoundDefinitionModelAssembly	getContainingDefinition()	Retrieve the Metaschema module definition on which the instance was declared.
IBoundInstanceModelGroupedNamed	getGroupedModelInstance(IEnhancedQName name)	Get the bound grouped model instance associated with the provided XML qualified name.
IBoundInstanceModelGroupedNamed	getGroupedModelInstance(Class<?> clazz)	Get the bound grouped model instance associated with the provided Java class.
IBoundInstanceModelGroupedNamed	getGroupedModelInstance(String discriminator)	Get the bound grouped model instance associated with the provided JSON discriminator value.
default IBoundInstanceModelGroupedNamed	getItemInstance(Object item)	Get the bound grouped model instance associated with the provided item.
default String	getJsonName()	Get the name used for the associated property in JSON/YAML serialization-related operations.
IBoundDefinitionModelAssembly	getOwningDefinition()	Retrieve the Metaschema module definition containing this container.
static IBoundInstanceModelChoiceGroup	newInstance(Field field, IBoundDefinitionModelAssembly containingDefinition)	Create a new bound choice group instance.
default IBoundObject	readItem(IBoundObject parent, IItemReadHandler handler)	Parse and return an item.
default void	writeItem(IBoundObject item, IItemWriteHandler handler)	Write the provided item.

Methods inherited from interface dev.metaschema.databind.model.IBoundInstance

getContainingModule, getValue, setValue

Methods inherited from interface dev.metaschema.databind.model.IBoundInstanceModel

deepCopy, getCollectionInfo, getItemJsonKey, getItemValues, getResolvedDefaultValue

Methods inherited from interface dev.metaschema.core.model.IChoiceGroupInstance

accept, getJsonDiscriminatorProperty, getJsonKeyFlagInstanceName, getMaxOccurs, getModelType, getRemarks, isEffectiveValueWrappedInXml, toCoordinates

Methods inherited from interface dev.metaschema.core.model.IDefaultable

getDefaultValue, getEffectiveDefaultValue

Methods inherited from interface dev.metaschema.core.model.IFeatureContainerModelGrouped

getAssemblyInstanceByName, getAssemblyInstances, getFieldInstanceByName, getFieldInstances, getModelContainer, getModelInstances, getNamedModelInstanceByName, getNamedModelInstances, hasChildren

Methods inherited from interface dev.metaschema.databind.model.IFeatureJavaField

getField, getItemType, getType

Methods inherited from interface dev.metaschema.core.model.IGroupable

getEffectiveXmlGroupAsQName, getGroupAsName, getJsonGroupAsBehavior, getMinOccurs, getXmlGroupAsBehavior

Methods inherited from interface dev.metaschema.core.model.IModelInstance

getParentContainer

Method Details

newInstance

@NonNull
static IBoundInstanceModelChoiceGroup newInstance(@NonNull
 Field field,
 @NonNull
 IBoundDefinitionModelAssembly containingDefinition)

Create a new bound choice group instance.

Parameters:

field - the Java field the instance is bound to

containingDefinition - the definition containing the instance

Returns:

the new instance

getJsonName

default String getJsonName()

Description copied from interface: IJsonNamed

Get the name used for the associated property in JSON/YAML serialization-related operations.

Specified by:

getJsonName in interface IChoiceGroupInstance

Specified by:

getJsonName in interface IJsonInstance

Specified by:

getJsonName in interface IJsonNamed

Returns:

the JSON property name

getOwningDefinition

@NonNull
IBoundDefinitionModelAssembly getOwningDefinition()

Description copied from interface: IContainerModel

Retrieve the Metaschema module definition containing this container.

Specified by:

getOwningDefinition in interface IContainerModel

Specified by:

getOwningDefinition in interface IContainerModelGrouped

Returns:

the containing Metaschema module definition

getContainingDefinition

default IBoundDefinitionModelAssembly getContainingDefinition()

Description copied from interface: IInstance

Retrieve the Metaschema module definition on which the instance was declared.

Specified by:

getContainingDefinition in interface IBoundInstance<IBoundObject>

Specified by:

getContainingDefinition in interface IBoundInstanceModel<IBoundObject>

Specified by:

getContainingDefinition in interface IInstance

Specified by:

getContainingDefinition in interface IModelInstance

Returns:

the Metaschema module definition on which the instance was declared

getGroupedModelInstance

@Nullable
IBoundInstanceModelGroupedNamed getGroupedModelInstance(@NonNull
 Class<?> clazz)

Get the bound grouped model instance associated with the provided Java class.

Parameters:

clazz - the Java class which should be bound to a grouped model instance

Returns:

the grouped model instance or {code null} if no instance was bound to the requested class

getGroupedModelInstance

@Nullable
IBoundInstanceModelGroupedNamed getGroupedModelInstance(@NonNull
 IEnhancedQName name)

Get the bound grouped model instance associated with the provided XML qualified name.

Parameters:

name - the XML qualified name which should be bound to a grouped model instance

Returns:

the grouped model instance or {code null} if no instance was bound to the requested XML qualified name

getGroupedModelInstance

@Nullable
IBoundInstanceModelGroupedNamed getGroupedModelInstance(@NonNull
 String discriminator)

Get the bound grouped model instance associated with the provided JSON discriminator value.

Parameters:

discriminator - the JSON discriminator value which should be bound to a grouped model instance

Returns:

the grouped model instance or {code null} if no instance was bound to the requested JSON discriminator value

getItemInstance

@NonNull
default IBoundInstanceModelGroupedNamed getItemInstance(Object item)

Get the bound grouped model instance associated with the provided item.

Specified by:

getItemInstance in interface IChoiceGroupInstance

Parameters:

item - the item which should be bound to a grouped model instance

Returns:

the grouped model instance or {code null} if no instance was bound to the requested item

readItem

default IBoundObject readItem(IBoundObject parent,
 IItemReadHandler handler)
                       throws IOException

Description copied from interface: IItemValueHandler

Parse and return an item.

Specified by:

readItem in interface IItemValueHandler<IBoundObject>

Parameters:

parent - the parent Java object to use for serialization callbacks, or null if there is no parent

handler - the item parsing handler

Returns:

the Java object representing the parsed item

Throws:

IOException - if an error occurred while parsing

writeItem

default void writeItem(IBoundObject item,
 IItemWriteHandler handler)
                throws IOException

Description copied from interface: IItemValueHandler

Write the provided item.

Specified by:

writeItem in interface IItemValueHandler<IBoundObject>

Parameters:

item - the data to write

handler - the item writing handler

Throws:

IOException - if an error occurred while writing

deepCopyItem

default IBoundObject deepCopyItem(IBoundObject item,
 IBoundObject parentInstance)
                           throws BindingException

Description copied from interface: IItemValueHandler

Create and return a deep copy of the provided item.

Specified by:

deepCopyItem in interface IItemValueHandler<IBoundObject>

Parameters:

item - the item to copy

parentInstance - an optional parent object to use for serialization callbacks

Returns:

the new deep copy

Throws:

BindingException - if an error occurred while analyzing the bound objects

canHandleXmlQName

default boolean canHandleXmlQName(@NonNull
 IEnhancedQName qname)

Description copied from interface: IBoundModelObject

Determine if the provided XML qualified name is associated with this property.

Specified by:

canHandleXmlQName in interface IBoundModelObject<IBoundObject>

Parameters:

qname - the XML qualified name of the property being parsed

Returns:

true if the instance will handle this name, or false otherwise