IInstance (Metaschema Core API 1.0.0-M1 API)

All Superinterfaces:

IModelElement

All Known Subinterfaces:

IAssemblyInstance, IChoiceInstance, IFieldInstance, IFlagInstance, IModelInstance, INamedInstance, INamedModelInstance

All Known Implementing Classes:

AbstractAssemblyInstance, AbstractChoiceInstance, AbstractFieldInstance, AbstractFlagInstance, AbstractInstance, AbstractModelInstance
```
public interface IInstance
extends IModelElement
```
This marker interface indicates that this object is an instance.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`IFlagContainer`	`getContainingDefinition()`	Retrieve the Metaschema definition on which the instance was declared.
`default IModule`	`getContainingModule()`	Retrieves the Metaschema module that contains the information element's declaration.
`IContainer`	`getParentContainer()`	Get the parent model definition that serves as the container of this instance.
`default String`	`toCoordinates()`	Generates a "coordinate" string for the provided information element instance.

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

- Method Detail
  - getContainingDefinition
```
@NonNull
IFlagContainer getContainingDefinition()
```
    Retrieve the Metaschema definition on which the instance was declared.
    
    Returns:
    
    the Metaschema definition on which the instance was declared
  - getParentContainer
```
@NonNull
IContainer getParentContainer()
```
    Get the parent model definition that serves as the container of this instance.
    
    Returns:
    
    the container
  - getContainingModule
```
default IModule getContainingModule()
```
    Description copied from interface: IModelElement
    
    Retrieves the Metaschema module that contains the information element's declaration.
    
    Specified by:
    
    getContainingModule in interface IModelElement
    
    Returns:
    
    the Metaschema module
  - toCoordinates
```
default String toCoordinates()
```
    Generates a "coordinate" string for the provided information element instance. A coordinate consists of the element's:
    
    containing Metaschema module's short name
    
    model type
    
    name
    
    hash code
    
    the hash code of the definition
    Specified by:
    
    toCoordinates in interface IModelElement
    
    Returns:
    
    the coordinate