Module gov.nist.secauto.metaschema.databind

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

Interface IBoundDefinitionModelFieldComplex

All Superinterfaces:

IAttributable, IBoundDefinition, IBoundDefinitionModel<IBoundObject>, IBoundDefinitionModelComplex, IBoundDefinitionModelField<IBoundObject>, IBoundModelElement, IBoundModelObject<IBoundObject>, IConstrained, IContainer, IDefaultable, IDefinition, IDescribable, IFeatureComplexItemValueHandler, IFeatureContainerFlag<IBoundInstanceFlag>, IFeatureValueConstrained, IField, IFieldDefinition, IItemValueHandler<IBoundObject>, IJsonNamed, IModelDefinition, IModelElement, INamed, INamedModelElement, IValueConstrained, IValuedDefinition

public interface IBoundDefinitionModelFieldComplex
extends IBoundDefinitionModelField<IBoundObject>, IBoundDefinitionModelComplex

Represents a field definition bound to a Java class.

This definition is considered "complex", since it is bound to a Java class.

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, EMPTY

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

DEFAULT_DEFINITION_MODEL_SCOPE

Method Summary

Modifier and Type	Method	Description
default boolean	canHandleXmlQName(QName qname)	Determine if the provided XML qualified name is associated with this property.
default Object	getDefaultValue()
default IBoundDefinitionModelFieldComplex	getDefinition()	Get the Metaschema definition representing the bound complex data.
IBoundFieldValue	getFieldValue()	Get the bound field value associated with this field.
default Object	getFieldValue(Object item)
default IDataTypeAdapter<?>	getJavaTypeAdapter()
default Map<String,IBoundProperty<?>>	getJsonProperties(Predicate<IBoundInstanceFlag> flagFilter)
default String	getJsonValueKeyName()
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.IAttributable

getProperties, getPropertyValues, hasProperty, hasPropertyValue

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

getBindingContext, getInlineInstance

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

callAfterDeserialize, callBeforeDeserialize, getAfterDeserializeMethod, getBeforeDeserializeMethod, isInline

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

getInlineInstance, getJsonValueKeyFlagInstance

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

getContainingModule

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

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.constraint.IFeatureValueConstrained

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

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

getModelType

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

getEffectiveJsonValueKeyName, getJsonValueKey, hasJsonValueKeyFlagInstance

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

hasChildren

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, getUseIndex, getUseName, getXmlNamespace, getXmlQName

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

getJsonName

Method Details

getDefinition

@NonNull
default IBoundDefinitionModelFieldComplex getDefinition()

Description copied from interface: IFeatureComplexItemValueHandler

Get the Metaschema definition representing the bound complex data.

Specified by:

getDefinition in interface IFeatureComplexItemValueHandler

Returns:

the definition

getDefaultValue

default Object getDefaultValue()

Specified by:

getDefaultValue in interface IDefaultable

getFieldValue

@NonNull
IBoundFieldValue getFieldValue()

Get the bound field value associated with this field.

Returns:

the field's value binding

getFieldValue

@NonNull
default Object getFieldValue(@NonNull
 Object item)

Specified by:

getFieldValue in interface IFieldDefinition

getJsonValueKeyName

@NonNull
default String getJsonValueKeyName()

Specified by:

getJsonValueKeyName in interface IFieldDefinition

getJavaTypeAdapter

@NonNull
default IDataTypeAdapter<?> getJavaTypeAdapter()

Specified by:

getJavaTypeAdapter in interface IValuedDefinition

getJsonProperties

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

Specified by:

getJsonProperties in interface IBoundDefinitionModelComplex

readItem

@NonNull
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

canHandleXmlQName

default boolean canHandleXmlQName(QName 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