Module gov.nist.secauto.metaschema.databind

Package gov.nist.secauto.metaschema.databind.model

Interface IBoundInstanceModelAssembly

All Superinterfaces:

IAssembly, IAssemblyInstance, IAssemblyInstanceAbsolute, IAttributable, IBoundInstance<IBoundObject>, IBoundInstanceModel<IBoundObject>, IBoundInstanceModelNamed<IBoundObject>, IBoundModelElement, IBoundModelObject<IBoundObject>, IBoundProperty<IBoundObject>, IDefaultable, IDescribable, IFeatureComplexItemValueHandler, IFeatureJavaField, IGroupable, IInstance, IInstanceAbsolute, IItemValueHandler<IBoundObject>, IJsonNamed, IModelElement, IModelInstance, IModelInstanceAbsolute, INamed, INamedInstance, INamedModelElement, INamedModelInstance, INamedModelInstanceAbsolute, IValued, IValuedMutable

public interface IBoundInstanceModelAssembly
extends IBoundInstanceModelNamed<IBoundObject>, IAssemblyInstanceAbsolute, IFeatureComplexItemValueHandler

Represents an assembly instance bound to Java field.

Nested Class Summary

Nested classes/interfaces inherited from interface gov.nist.secauto.metaschema.core.model.IAttributable

IAttributable.Key

Field Summary

Fields inherited from interface gov.nist.secauto.metaschema.core.model.IAttributable

DEFAULT_PROPERY_NAMESPACE

Fields inherited from interface gov.nist.secauto.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 void	callAfterDeserialize(IBoundObject targetObject, IBoundObject parentObject)
default void	callBeforeDeserialize(IBoundObject targetObject, IBoundObject parentObject)
default IBoundObject	deepCopyItem(IBoundObject item, IBoundObject parentInstance)	Create and return a deep copy of the provided item.
default Class<? extends IBoundObject>	getBoundClass()	The class this binding is to.
IBoundDefinitionModelAssembly	getDefinition()	Get the Metaschema definition representing the bound complex data.
static IBoundInstanceModelAssembly	newInstance(Field field, IBoundDefinitionModelAssembly containingDefinition)	Create a new bound assembly 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 gov.nist.secauto.metaschema.core.model.IAssembly

getModelType

Methods inherited from interface gov.nist.secauto.metaschema.core.model.IAssemblyInstance

isEffectiveValueWrappedInXml

Methods inherited from interface gov.nist.secauto.metaschema.core.model.IAttributable

getProperties, getPropertyValues, hasProperty, hasPropertyValue

Methods inherited from interface gov.nist.secauto.metaschema.databind.model.IBoundInstance

getContainingModule, getValue, setValue

Methods inherited from interface gov.nist.secauto.metaschema.databind.model.IBoundInstanceModel

getCollectionInfo, getContainingDefinition, getResolvedDefaultValue

Methods inherited from interface gov.nist.secauto.metaschema.databind.model.IBoundInstanceModelNamed

canHandleXmlQName, getEffectiveJsonKey, getIndex, getItemJsonKey, getItemValues, getJsonKey, getName

Methods inherited from interface gov.nist.secauto.metaschema.databind.model.IBoundProperty

deepCopy

Methods inherited from interface gov.nist.secauto.metaschema.core.model.IDefaultable

getDefaultValue, getEffectiveDefaultValue

Methods inherited from interface gov.nist.secauto.metaschema.core.model.IDescribable

getDescription, getEffectiveDescription, getEffectiveFormalName, getFormalName

Methods inherited from interface gov.nist.secauto.metaschema.databind.model.info.IFeatureComplexItemValueHandler

getJsonProperties, newInstance

Methods inherited from interface gov.nist.secauto.metaschema.databind.model.IFeatureJavaField

getField, getItemType, getType

Methods inherited from interface gov.nist.secauto.metaschema.core.model.IGroupable

getEffectiveGroupAsNamespace, getEffectiveXmlGroupAsQName, getGroupAsName, getGroupAsXmlNamespace, getJsonGroupAsBehavior, getMaxOccurs, getMinOccurs, getXmlGroupAsBehavior

Methods inherited from interface gov.nist.secauto.metaschema.core.model.IInstance

toCoordinates

Methods inherited from interface gov.nist.secauto.metaschema.core.model.IModelElement

getRemarks

Methods inherited from interface gov.nist.secauto.metaschema.core.model.IModelInstance

getContainingDefinition, getParentContainer

Methods inherited from interface gov.nist.secauto.metaschema.core.model.INamed

getEffectiveIndex, getEffectiveName, getUseIndex, getUseName, getXmlNamespace

Methods inherited from interface gov.nist.secauto.metaschema.core.model.INamedModelInstance

getReferencedDefinitionQName, getXmlQName, hasJsonKey

Methods inherited from interface gov.nist.secauto.metaschema.core.model.INamedModelInstanceAbsolute

getJsonName

Method Details

newInstance

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

Create a new bound assembly instance.

Parameters:

field - the Java field the instance is bound to

containingDefinition - the definition containing the instance

Returns:

the new instance

getDefinition

@NonNull
IBoundDefinitionModelAssembly getDefinition()

Description copied from interface: IFeatureComplexItemValueHandler

Get the Metaschema definition representing the bound complex data.

Specified by:

getDefinition in interface IAssemblyInstance

Specified by:

getDefinition in interface IBoundInstanceModelNamed<IBoundObject>

Specified by:

getDefinition in interface IFeatureComplexItemValueHandler

Specified by:

getDefinition in interface INamedInstance

Specified by:

getDefinition in interface INamedModelInstance

Returns:

the definition

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 IFeatureComplexItemValueHandler

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

getBoundClass

default Class<? extends IBoundObject> getBoundClass()

Description copied from interface: IFeatureComplexItemValueHandler

The class this binding is to.

Specified by:

getBoundClass in interface IFeatureComplexItemValueHandler

Returns:

the bound class

callBeforeDeserialize

default void callBeforeDeserialize(IBoundObject targetObject,
 IBoundObject parentObject)
                            throws BindingException

Specified by:

callBeforeDeserialize in interface IFeatureComplexItemValueHandler

Throws:

BindingException

callAfterDeserialize

default void callAfterDeserialize(IBoundObject targetObject,
 IBoundObject parentObject)
                           throws BindingException

Specified by:

callAfterDeserialize in interface IFeatureComplexItemValueHandler

Throws:

BindingException