Module gov.nist.secauto.metaschema.databind

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

Interface IBoundInstanceModelFieldScalar

All Superinterfaces:

IAttributable, IBoundDefinition, IBoundDefinitionModel<Object>, IBoundDefinitionModelField<Object>, IBoundInstance<Object>, IBoundInstanceModel<Object>, IBoundInstanceModelField<Object>, IBoundInstanceModelNamed<Object>, IBoundModelElement, IBoundModelObject<Object>, IBoundProperty<Object>, IConstrained, IContainer, IDefaultable, IDefinition, IDescribable, IFeatureContainerFlag<IBoundInstanceFlag>, IFeatureDefinitionInstanceInlined<IBoundDefinitionModelField<Object>,IBoundInstanceModelFieldScalar>, IFeatureJavaField, IFeatureScalarItemValueHandler, IFeatureValueConstrained, IField, IFieldDefinition, IFieldInstance, IFieldInstanceAbsolute, IGroupable, IInstance, IInstanceAbsolute, IItemValueHandler<Object>, IJsonNamed, IModelDefinition, IModelElement, IModelInstance, IModelInstanceAbsolute, INamed, INamedInstance, INamedModelElement, INamedModelInstance, INamedModelInstanceAbsolute, IValueConstrained, IValued, IValuedDefinition, IValuedInstance, IValuedMutable

public interface IBoundInstanceModelFieldScalar
extends IBoundInstanceModelField<Object>, IBoundDefinitionModelField<Object>, IFeatureScalarItemValueHandler, IFeatureDefinitionInstanceInlined<IBoundDefinitionModelField<Object>,IBoundInstanceModelFieldScalar>

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

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

DEFAULT_FIELD_IN_XML_WRAPPED

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
IBoundDefinitionModelAssembly	getContainingDefinition()
default IBoundDefinitionModelField<Object>	getDefinition()
default Object	getFieldValue(Object item)
default IContainerFlagSupport<IBoundInstanceFlag>	getFlagContainer()
default IBoundInstanceModelFieldScalar	getInlineInstance()
default IBoundInstanceFlag	getItemJsonKey(Object item)	Get the JSON key flag for the provided item.
default IBoundInstanceFlag	getJsonKey()
default IBoundInstanceFlag	getJsonValueKeyFlagInstance()
default String	getJsonValueKeyName()
default Object	readItem(IBoundObject parent, IItemReadHandler handler)	Parse and return an item.
default void	writeItem(Object 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

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

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

canHandleXmlQName

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

getEffectiveJsonKey, getIndex, getItemValues, 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

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

getLocation, getModuleScope

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

getDescription, getFormalName

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

getFlagInstanceByName, getFlagInstances

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

getDefinitionQName, getEffectiveDefaultValue, getEffectiveDescription, getEffectiveFormalName, getEffectiveIndex, getEffectiveName, isInline, toCoordinates

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

getField, getItemType, getType

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

deepCopyItem, getJavaTypeAdapter, getValueFromString, setValue, toStringFromItem

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

isInXmlWrapped

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

isEffectiveValueWrappedInXml

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

hasChildren

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

getRemarks

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

getParentContainer

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

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

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

getJavaTypeAdapter

Method Details

getDefinition

default IBoundDefinitionModelField<Object> getDefinition()

Specified by:

getDefinition in interface IBoundInstanceModelField<Object>

Specified by:

getDefinition in interface IBoundInstanceModelNamed<Object>

Specified by:

getDefinition in interface IFeatureDefinitionInstanceInlined<IBoundDefinitionModelField<Object>,IBoundInstanceModelFieldScalar>

Specified by:

getDefinition in interface IFieldInstance

Specified by:

getDefinition in interface INamedInstance

Specified by:

getDefinition in interface INamedModelInstance

Specified by:

getDefinition in interface IValuedInstance

getInlineInstance

default IBoundInstanceModelFieldScalar getInlineInstance()

Specified by:

getInlineInstance in interface IBoundDefinitionModel<Object>

Specified by:

getInlineInstance in interface IBoundDefinitionModelField<Object>

Specified by:

getInlineInstance in interface IDefinition

Specified by:

getInlineInstance in interface IFeatureDefinitionInstanceInlined<IBoundDefinitionModelField<Object>,IBoundInstanceModelFieldScalar>

Specified by:

getInlineInstance in interface IFieldDefinition

getContainingDefinition

IBoundDefinitionModelAssembly getContainingDefinition()

Specified by:

getContainingDefinition in interface IBoundInstance<Object>

Specified by:

getContainingDefinition in interface IBoundInstanceModel<Object>

Specified by:

getContainingDefinition in interface IInstance

Specified by:

getContainingDefinition in interface IModelInstance

getFlagContainer

default IContainerFlagSupport<IBoundInstanceFlag> getFlagContainer()

Specified by:

getFlagContainer in interface IFeatureContainerFlag<IBoundInstanceFlag>

getJsonKey

default IBoundInstanceFlag getJsonKey()

Specified by:

getJsonKey in interface IBoundInstanceModelNamed<Object>

Specified by:

getJsonKey in interface IFeatureContainerFlag<IBoundInstanceFlag>

Specified by:

getJsonKey in interface IModelDefinition

Specified by:

getJsonKey in interface INamedModelInstance

Specified by:

getJsonKey in interface INamedModelInstanceAbsolute

getItemJsonKey

default IBoundInstanceFlag getItemJsonKey(Object item)

Description copied from interface: IBoundInstanceModel

Get the JSON key flag for the provided item.

Specified by:

getItemJsonKey in interface IBoundInstanceModel<Object>

Specified by:

getItemJsonKey in interface IBoundInstanceModelNamed<Object>

Parameters:

item - the item to get the JSON key flag for

Returns:

the JSON key flag

getFieldValue

default Object getFieldValue(Object item)

Specified by:

getFieldValue in interface IFieldDefinition

getJsonValueKeyName

default String getJsonValueKeyName()

Specified by:

getJsonValueKeyName in interface IFieldDefinition

getJsonValueKeyFlagInstance

default IBoundInstanceFlag getJsonValueKeyFlagInstance()

Specified by:

getJsonValueKeyFlagInstance in interface IBoundDefinitionModelField<Object>

Specified by:

getJsonValueKeyFlagInstance in interface IFieldDefinition

readItem

default Object readItem(IBoundObject parent,
 IItemReadHandler handler)
                 throws IOException

Description copied from interface: IItemValueHandler

Parse and return an item.

Specified by:

readItem in interface IItemValueHandler<Object>

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(Object item,
 IItemWriteHandler handler)
                throws IOException

Description copied from interface: IItemValueHandler

Write the provided item.

Specified by:

writeItem in interface IItemValueHandler<Object>

Parameters:

item - the data to write

handler - the item writing handler

Throws:

IOException - if an error occurred while writing