Module dev.metaschema.core

Package dev.metaschema.core.model

Interface INamedInstance

All Superinterfaces:

IAttributable, IDefaultable, IDescribable, IInstance, IJsonNamed, IModelElement, IModelElementVisitable, INamed, INamedModelElement

All Known Subinterfaces:

IAssemblyInstance, IAssemblyInstanceAbsolute, IAssemblyInstanceGrouped, IFeatureDefinitionInstanceInlined<DEFINITION,INSTANCE>, IFeatureDefinitionReferenceInstance<DEFINITION,INSTANCE>, IFieldInstance, IFieldInstanceAbsolute, IFieldInstanceGrouped, IFlagInstance, INamedModelInstance, INamedModelInstanceAbsolute, INamedModelInstanceGrouped, IValuedInstance

All Known Implementing Classes:

AbstractAssemblyInstance, AbstractFieldInstance, AbstractFlagInstance, AbstractInlineAssemblyDefinition, AbstractInlineFieldDefinition, AbstractInlineFlagDefinition, AbstractNamedInstance, AbstractNamedModelInstance

public interface INamedInstance
extends INamedModelElement, IAttributable, IInstance

This marker interface indicates that the instance has a flag, field, or assembly name associated with it which will be used in JSON/YAML or XML to identify the data.

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

Method Summary

Modifier and Type	Method	Description
IDefinition	getDefinition()	Retrieve the definition of this instance.
IEnhancedQName	getReferencedDefinitionQName()	This represents the qualified name of a referenced definition.
boolean	isInlineDefinition()	Determine if the definition of this instance is declared inline.

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

getContainingDefinition, getParentContainer, 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.INamed

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

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

getJsonName

Method Details

getDefinition

@NonNull
IDefinition getDefinition()

Retrieve the definition of this instance.

Returns:

the corresponding definition

isInlineDefinition

boolean isInlineDefinition()

Determine if the definition of this instance is declared inline.

Returns:

true if the definition of this instance is declared inline or false otherwise

getReferencedDefinitionQName

@NonNull
IEnhancedQName getReferencedDefinitionQName()

This represents the qualified name of a referenced definition.

Returns:

the qualified name

See Also:

• IDefinition.getDefinitionQName()