Module dev.metaschema.databind

Package dev.metaschema.databind.model

Interface IBoundInstanceModelGroupedField

All Superinterfaces:

IAttributable, IBoundInstanceModelGroupedNamed, IDefaultable, IDescribable, IFeatureComplexItemValueHandler, IField, IFieldInstance, IFieldInstanceGrouped, IGroupable, IInstance, IItemValueHandler<IBoundObject>, IJsonNamed, IModelElement, IModelElementVisitable, IModelInstance, INamed, INamedInstance, INamedModelElement, INamedModelInstance, INamedModelInstanceGrouped, IValuedInstance

public interface IBoundInstanceModelGroupedField
extends IBoundInstanceModelGroupedNamed, IFieldInstanceGrouped

Represents a field model instance that is a member of a choice group instance.

Nested Class Summary

Nested classes/interfaces inherited from interface dev.metaschema.core.model.IAttributable

IAttributable.Key

Field Summary

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

DEFAULT_PROPERY_NAMESPACE

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

DEFAULT_FIELD_IN_XML_WRAPPED

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
IBoundDefinitionModelFieldComplex	getDefinition()	Retrieve the definition of this instance.
static IBoundInstanceModelGroupedField	newInstance(BoundGroupedField annotation, IBoundInstanceModelChoiceGroup container)	Create a new field model instance instance that is a member of a 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.core.model.IAttributable

getProperties, getPropertyValues, hasProperty, hasPropertyValue

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

callAfterDeserialize, callBeforeDeserialize, deepCopyItem, getContainingDefinition, getEffectiveJsonKey, getJsonKey, getName, getParentContainer

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

getDefaultValue, getEffectiveDefaultValue, getResolvedDefaultValue

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

getDescription, getEffectiveDescription, getEffectiveFormalName, getFormalName

Methods inherited from interface dev.metaschema.databind.model.info.IFeatureComplexItemValueHandler

getBoundClass, getJsonProperties, newInstance

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

getModelType

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

accept, isEffectiveValueWrappedInXml, isInXmlWrapped

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

getEffectiveXmlGroupAsQName, getGroupAsName, getItemValues, getJsonGroupAsBehavior, getXmlGroupAsBehavior

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

toCoordinates

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

getContainingModule, getRemarks

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

getEffectiveIndex, getEffectiveName, getIndex, getQName, getUseIndex, getUseName

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

getReferencedDefinitionQName, isInlineDefinition

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

getJsonName

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

hasJsonKey

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

getDiscriminatorValue, getEffectiveDisciminatorValue, getMaxOccurs, getMinOccurs

Method Details

newInstance

@NonNull
static IBoundInstanceModelGroupedField newInstance(@NonNull
 BoundGroupedField annotation,
 @NonNull
 IBoundInstanceModelChoiceGroup container)

Create a new field model instance instance that is a member of a choice group instance.

Parameters:

annotation - the Java annotation the instance is bound to

container - the choice group instance containing the instance

Returns:

the new instance

getDefinition

IBoundDefinitionModelFieldComplex getDefinition()

Description copied from interface: INamedInstance

Retrieve the definition of this instance.

Specified by:

getDefinition in interface IBoundInstanceModelGroupedNamed

Specified by:

getDefinition in interface IFeatureComplexItemValueHandler

Specified by:

getDefinition in interface IFieldInstance

Specified by:

getDefinition in interface INamedInstance

Specified by:

getDefinition in interface INamedModelInstance

Specified by:

getDefinition in interface IValuedInstance

Returns:

the corresponding definition

readItem

default IBoundObject readItem(IBoundObject parent,
 @NonNull
 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