Module gov.nist.secauto.metaschema.databind

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

Interface IBoundInstanceModelNamed<ITEM>

All Superinterfaces:

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

All Known Subinterfaces:

IBoundInstanceModelAssembly, IBoundInstanceModelField<ITEM>, IBoundInstanceModelFieldComplex, IBoundInstanceModelFieldScalar

public interface IBoundInstanceModelNamed<ITEM>
extends IBoundInstanceModel<ITEM>, INamedModelInstanceAbsolute

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.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(QName qname)	Determine if the provided XML qualified name is associated with this property.
IBoundDefinitionModel<ITEM>	getDefinition()
default IBoundInstanceFlag	getEffectiveJsonKey()
default Integer	getIndex()
default IBoundInstanceFlag	getItemJsonKey(Object item)	Get the JSON key flag for the provided item.
default Collection<? extends Object>	getItemValues(Object value)	Get the item values associated with the provided value.
default IBoundInstanceFlag	getJsonKey()
default String	getName()

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.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.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.databind.model.info.IItemValueHandler

deepCopyItem, readItem, writeItem

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

getModelType, getRemarks

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

getContainingDefinition, getParentContainer, isEffectiveValueWrappedInXml

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

getDefinition

@NonNull
IBoundDefinitionModel<ITEM> getDefinition()

Specified by:

getDefinition in interface INamedInstance

Specified by:

getDefinition in interface INamedModelInstance

getName

default String getName()

Specified by:

getName in interface INamed

getIndex

default Integer getIndex()

Specified by:

getIndex in interface INamed

getEffectiveJsonKey

@Nullable
default IBoundInstanceFlag getEffectiveJsonKey()

Specified by:

getEffectiveJsonKey in interface INamedModelInstance

Specified by:

getEffectiveJsonKey in interface INamedModelInstanceAbsolute

getJsonKey

default IBoundInstanceFlag getJsonKey()

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<ITEM>

Parameters:

item - the item to get the JSON key flag for

Returns:

the JSON key flag

getItemValues

default Collection<? extends Object> getItemValues(Object value)

Description copied from interface: IBoundInstanceModel

Get the item values associated with the provided value.

Specified by:

getItemValues in interface IBoundInstanceModel<ITEM>

Specified by:

getItemValues in interface IGroupable

Parameters:

value - the value which may be a singleton or a collection

Returns:

the ordered collection of values

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<ITEM>

Parameters:

qname - the XML qualified name of the property being parsed

Returns:

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