Module gov.nist.secauto.metaschema.databind

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

Interface IBoundDefinitionModelAssembly

All Superinterfaces:

IAssembly, IAssemblyDefinition, IAttributable, IBoundDefinition, IBoundDefinitionModel<IBoundObject>, IBoundDefinitionModelComplex, IBoundModelElement, IBoundModelObject<IBoundObject>, IContainer, IContainerModel, IContainerModelAbsolute, IContainerModelAssembly, IDefaultable, IDefinition, IDescribable, IFeatureComplexItemValueHandler, IFeatureContainerFlag<IBoundInstanceFlag>, IFeatureContainerModelAbsolute<IBoundInstanceModel<?>,IBoundInstanceModelNamed<?>,IBoundInstanceModelField<?>,IBoundInstanceModelAssembly>, IFeatureContainerModelAssembly<IBoundInstanceModel<?>,IBoundInstanceModelNamed<?>,IBoundInstanceModelField<?>,IBoundInstanceModelAssembly,IChoiceInstance,IBoundInstanceModelChoiceGroup>, IFeatureModelConstrained, IFeatureValueConstrained, IItemValueHandler<IBoundObject>, IJsonNamed, IModelConstrained, IModelDefinition, IModelElement, INamed, INamedModelElement, IValueConstrained

public interface IBoundDefinitionModelAssembly
extends IBoundDefinitionModelComplex, IAssemblyDefinition, IFeatureContainerModelAssembly<IBoundInstanceModel<?>,IBoundInstanceModelNamed<?>,IBoundInstanceModelField<?>,IBoundInstanceModelAssembly,IChoiceInstance,IBoundInstanceModelChoiceGroup>

Represents an assembly definition bound to a Java class.

Nested Class Summary

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

IAttributable.Key

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

IDefinition.ModuleScope

Field Summary

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

MODEL_QNAME

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

DEFAULT_PROPERY_NAMESPACE

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

DEFAULT_MODULE_SCOPE

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 List<IChoiceInstance>	getChoiceInstances()
default IBoundDefinitionModelAssembly	getDefinition()	Get the Metaschema definition representing the bound complex data.
default IBoundInstanceModelAssembly	getInlineInstance()
default Map<String,IBoundProperty<?>>	getJsonProperties(Predicate<IBoundInstanceFlag> flagFilter)
default IBoundDefinitionModelAssembly	getOwningDefinition()
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.IAssemblyDefinition

getRootIndex, getRootJsonName, getRootName, getRootQName, hasChildren, isInline, isRoot

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.IBoundDefinitionModel

getBindingContext

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

callAfterDeserialize, callBeforeDeserialize, getAfterDeserializeMethod, getBeforeDeserializeMethod

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

getContainingModule

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

hasChildren

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

getDefaultValue, getEffectiveDefaultValue, getResolvedDefaultValue

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

getDefinitionQName, getLocation, getModuleScope, toCoordinates

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

deepCopyItem, getBoundClass, getJsonProperties, newInstance

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

getFlagContainer, getFlagInstanceByName, getFlagInstances, getJsonKey

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

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

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

getChoiceGroupInstanceByName, getChoiceGroupInstances, getModelContainer

Methods inherited from interface gov.nist.secauto.metaschema.core.model.constraint.IFeatureModelConstrained

addConstraint, addConstraint, addConstraint, getConstraintSupport, getHasCardinalityConstraints, getIndexConstraints, getUniqueConstraints

Methods inherited from interface gov.nist.secauto.metaschema.core.model.constraint.IFeatureValueConstrained

addConstraint, addConstraint, addConstraint, addConstraint, addLetExpression, getAllowedValuesConstraints, getConstraints, getExpectConstraints, getIndexHasKeyConstraints, getLetExpressions, getMatchesConstraints

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

getRemarks

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

getEffectiveIndex, getEffectiveName, getIndex, getName, getQName, getUseIndex, getUseName

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

getJsonName

Method Details

getOwningDefinition

@NonNull
default IBoundDefinitionModelAssembly getOwningDefinition()

Specified by:

getOwningDefinition in interface IAssemblyDefinition

Specified by:

getOwningDefinition in interface IContainerModel

getDefinition

@NonNull
default IBoundDefinitionModelAssembly getDefinition()

Description copied from interface: IFeatureComplexItemValueHandler

Get the Metaschema definition representing the bound complex data.

Specified by:

getDefinition in interface IFeatureComplexItemValueHandler

Returns:

the definition

getInlineInstance

@Nullable
default IBoundInstanceModelAssembly getInlineInstance()

Specified by:

getInlineInstance in interface IAssemblyDefinition

Specified by:

getInlineInstance in interface IBoundDefinitionModel<IBoundObject>

Specified by:

getInlineInstance in interface IDefinition

getChoiceInstances

@NonNull
default List<IChoiceInstance> getChoiceInstances()

Specified by:

getChoiceInstances in interface IContainerModelAssembly

Specified by:

getChoiceInstances in interface IFeatureContainerModelAssembly<IBoundInstanceModel<?>,IBoundInstanceModelNamed<?>,IBoundInstanceModelField<?>,IBoundInstanceModelAssembly,IChoiceInstance,IBoundInstanceModelChoiceGroup>

getJsonProperties

@NonNull
default Map<String,IBoundProperty<?>> getJsonProperties(@Nullable
 Predicate<IBoundInstanceFlag> flagFilter)

Specified by:

getJsonProperties in interface IBoundDefinitionModelComplex

readItem

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

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