Module dev.metaschema.databind

Package dev.metaschema.databind.model

Interface IBoundInstanceModelField<ITEM>

Type Parameters:

ITEM - the Java type for associated bound objects

All Superinterfaces:

IAttributable, IBoundInstance<ITEM>, IBoundInstanceModel<ITEM>, IBoundInstanceModelNamed<ITEM>, IBoundModelElement, IBoundModelObject<ITEM>, IBoundProperty<ITEM>, IDefaultable, IDescribable, IFeatureJavaField, IField, IFieldInstance, IFieldInstanceAbsolute, IGroupable, IInstance, IInstanceAbsolute, IItemValueHandler<ITEM>, IJsonInstance, IJsonNamed, IModelElement, IModelElementVisitable, IModelInstance, IModelInstanceAbsolute, INamed, INamedInstance, INamedModelElement, INamedModelInstance, INamedModelInstanceAbsolute, IValued, IValuedInstance, IValuedMutable

All Known Subinterfaces:

IBoundInstanceModelFieldComplex, IBoundInstanceModelFieldScalar

public interface IBoundInstanceModelField<ITEM>
extends IBoundInstanceModelNamed<ITEM>, IFieldInstanceAbsolute

Represents a field instance bound to a Java field.

This interface handles both scalar (simple type) and complex (class-bound) field instances.

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
default boolean	canHandleXmlQName(IEnhancedQName qname)	Determine if the provided XML qualified name is associated with this property.
IBoundDefinitionModelField<ITEM>	getDefinition()	Retrieve the definition of this instance.
static IBoundInstanceModelField<?>	newInstance(Field field, IBoundDefinitionModelAssembly containingDefinition)	Create a new bound field instance.

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

getProperties, getPropertyValues, hasProperty, hasPropertyValue

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

getContainingModule, getValue, setValue

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

deepCopy, getCollectionInfo, getContainingDefinition, getResolvedDefaultValue

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

getEffectiveJsonKey, getIndex, getItemJsonKey, getItemValues, getJsonKey, getName

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

getDefaultValue, getEffectiveDefaultValue

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

getDescription, getEffectiveDescription, getEffectiveFormalName, getFormalName

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

getField, getItemType, getType

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

getModelType

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

isInXmlWrapped

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

accept, isEffectiveValueWrappedInXml

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

getEffectiveXmlGroupAsQName, getGroupAsName, getJsonGroupAsBehavior, getMaxOccurs, getMinOccurs, getXmlGroupAsBehavior

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

toCoordinates

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

deepCopyItem, readItem, writeItem

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

getRemarks

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

getContainingDefinition, getParentContainer

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

getEffectiveIndex, getEffectiveName, getQName, getUseIndex, getUseName

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

getReferencedDefinitionQName, isInlineDefinition

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

hasJsonKey

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

getJsonName

Method Details

getDefinition

IBoundDefinitionModelField<ITEM> getDefinition()

Description copied from interface: INamedInstance

Retrieve the definition of this instance.

Specified by:

getDefinition in interface IBoundInstanceModelNamed<ITEM>

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

newInstance

@NonNull
static IBoundInstanceModelField<?> newInstance(@NonNull
 Field field,
 @NonNull
 IBoundDefinitionModelAssembly containingDefinition)

Create a new bound field instance.

Parameters:

field - the Java field the instance is bound to

containingDefinition - the definition containing the instance

Returns:

the new instance

canHandleXmlQName

default boolean canHandleXmlQName(IEnhancedQName qname)

Description copied from interface: IBoundModelObject

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

Specified by:

canHandleXmlQName in interface IBoundInstanceModelNamed<ITEM>

Specified by:

canHandleXmlQName in interface IBoundModelObject<ITEM>

Parameters:

qname - the XML qualified name of the property being parsed

Returns:

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