Module dev.metaschema.core

Package dev.metaschema.core.model

Class AbstractFlagInstance<PARENT extends IModelDefinition,DEFINITION extends IFlagDefinition,INSTANCE extends IFlagInstance>

java.lang.Object

dev.metaschema.core.model.AbstractInstance<PARENT>

dev.metaschema.core.model.AbstractNamedInstance<PARENT>

dev.metaschema.core.model.AbstractFlagInstance<PARENT,DEFINITION,INSTANCE>

Type Parameters:

PARENT - the Java type of the parent model (i.e., assembly, field).

DEFINITION - the Java type of the definition for this member flag

INSTANCE - the Java type of the instance for this member flag

All Implemented Interfaces:

IAttributable, IDefaultable, IDescribable, IFlag, IFlagInstance, IInstance, IInstanceAbsolute, IJsonNamed, IModelElement, IModelElementVisitable, INamed, INamedInstance, INamedModelElement, IValued, IValuedInstance

Direct Known Subclasses:

AbstractInlineFlagDefinition

public abstract class AbstractFlagInstance<PARENT extends IModelDefinition,DEFINITION extends IFlagDefinition,INSTANCE extends IFlagInstance>
extends AbstractNamedInstance<PARENT>
implements IFlagInstance

A base class for a flag that is a member of a containing model.

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

DEFAULT_FLAG_REQUIRED

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractFlagInstance(PARENT parent)	Construct a new flag instance.

Method Summary

Modifier and Type	Method	Description
final PARENT	getContainingDefinition()	Retrieve the Metaschema module definition on which the instance was declared.
IModule	getContainingModule()	Retrieves the Metaschema module that contains the information element's declaration.
DEFINITION	getDefinition()	Retrieves the flag definition referenced by this instance.
String	toCoordinates()	Generates a "coordinate" string for the assembly instance.

Methods inherited from class dev.metaschema.core.model.AbstractNamedInstance

getQName, getReferencedDefinitionQName

Methods inherited from class dev.metaschema.core.model.AbstractInstance

getParentContainer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getModelType

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

accept, getParentContainer, isRequired

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

getRemarks

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

getJsonName

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

getValue

Constructor Details

AbstractFlagInstance

protected AbstractFlagInstance(@NonNull
 PARENT parent)

Construct a new flag instance.

Parameters:

parent - the parent model containing this instance

Method Details

getDefinition

public DEFINITION getDefinition()

Description copied from interface: IFlagInstance

Retrieves the flag definition referenced by this instance.

Specified by:

getDefinition in interface IFlagInstance

Specified by:

getDefinition in interface INamedInstance

Specified by:

getDefinition in interface IValuedInstance

Returns:

the flag definition

getContainingDefinition

public final PARENT getContainingDefinition()

Description copied from interface: IInstance

Retrieve the Metaschema module definition on which the instance was declared.

Specified by:

getContainingDefinition in interface IFlagInstance

Specified by:

getContainingDefinition in interface IInstance

Returns:

the Metaschema module definition on which the instance was declared

toCoordinates

public String toCoordinates()

Generates a "coordinate" string for the assembly instance.

Specified by:

toCoordinates in interface IInstance

Specified by:

toCoordinates in interface IModelElement

Returns:

the coordinate

getContainingModule

public 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