Module dev.metaschema.core

Package dev.metaschema.core.model

Interface INamedModelInstanceAbsolute

All Superinterfaces:

IAttributable, IDefaultable, IDescribable, IGroupable, IInstance, IInstanceAbsolute, IJsonInstance, IJsonNamed, IModelElement, IModelElementVisitable, IModelInstance, IModelInstanceAbsolute, INamed, INamedInstance, INamedModelElement, INamedModelInstance, IValued

All Known Subinterfaces:

IAssemblyInstanceAbsolute, IBoundInstanceModelAssembly, IBoundInstanceModelField<ITEM>, IBoundInstanceModelFieldComplex, IBoundInstanceModelFieldScalar, IBoundInstanceModelNamed<ITEM>, IFieldInstanceAbsolute

public interface INamedModelInstanceAbsolute
extends INamedModelInstance, IModelInstanceAbsolute, IJsonInstance

Represents a named model instance with absolute positioning and JSON serialization support.

Provides JSON name resolution based on cardinality and grouping behavior, with support for JSON key configuration.

Nested Class Summary

Nested classes/interfaces inherited from interface dev.metaschema.core.model.IAttributable

IAttributable.Key

Field Summary

Fields inherited from interface dev.metaschema.core.model.IAttributable

DEFAULT_PROPERY_NAMESPACE

Fields inherited from interface dev.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 IFlagInstance	getEffectiveJsonKey()	Get the JSON key flag instance for this model instance, if one is configured.
default IFlagInstance	getJsonKey()	Get the JSON key associated with this instance.
default String	getJsonName()	Get the name used for the associated property in JSON/YAML serialization-related operations.

Methods inherited from interface dev.metaschema.core.model.IAttributable

getProperties, getPropertyValues, hasProperty, hasPropertyValue

Methods inherited from interface dev.metaschema.core.model.IDefaultable

getDefaultValue, getEffectiveDefaultValue, getResolvedDefaultValue

Methods inherited from interface dev.metaschema.core.model.IDescribable

getDescription, getEffectiveDescription, getEffectiveFormalName, getFormalName

Methods inherited from interface dev.metaschema.core.model.IGroupable

getEffectiveXmlGroupAsQName, getGroupAsName, getItemValues, getJsonGroupAsBehavior, getMaxOccurs, getMinOccurs, getXmlGroupAsBehavior

Methods inherited from interface dev.metaschema.core.model.IInstance

toCoordinates

Methods inherited from interface dev.metaschema.core.model.IModelElement

getContainingModule, getModelType, getRemarks

Methods inherited from interface dev.metaschema.core.model.IModelElementVisitable

accept

Methods inherited from interface dev.metaschema.core.model.IModelInstance

getContainingDefinition, getParentContainer, isEffectiveValueWrappedInXml

Methods inherited from interface dev.metaschema.core.model.INamed

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

Methods inherited from interface dev.metaschema.core.model.INamedInstance

getReferencedDefinitionQName, isInlineDefinition

Methods inherited from interface dev.metaschema.core.model.INamedModelInstance

getDefinition, hasJsonKey

Methods inherited from interface dev.metaschema.core.model.IValued

getValue

Method Details

getJsonName

default String getJsonName()

Description copied from interface: IJsonNamed

Get the name used for the associated property in JSON/YAML serialization-related operations.

Specified by:

getJsonName in interface IJsonInstance

Specified by:

getJsonName in interface IJsonNamed

Specified by:

getJsonName in interface INamedModelElement

Returns:

the JSON property name

getEffectiveJsonKey

@Nullable
default IFlagInstance getEffectiveJsonKey()

Description copied from interface: INamedModelInstance

Get the JSON key flag instance for this model instance, if one is configured.

Specified by:

getEffectiveJsonKey in interface INamedModelInstance

Returns:

the JSON key flag instance or null if no JSON key is configured

getJsonKey

@Nullable
default IFlagInstance getJsonKey()

Description copied from interface: INamedModelInstance

Get the JSON key associated with this instance.

Specified by:

getJsonKey in interface INamedModelInstance

Returns:

the configured JSON key or null if no JSON key is configured