Module dev.metaschema.core

Package dev.metaschema.core.model

Interface IFlagDefinition

All Superinterfaces:

IAttributable, IDefaultable, IDefinition, IDescribable, IFeatureValueConstrained, IFlag, IJsonNamed, IModelElement, IModelElementVisitable, INamed, INamedModelElement, IValueConstrained, IValuedDefinition

All Known Implementing Classes:

AbstractGlobalFlagDefinition, AbstractInlineFlagDefinition

public interface IFlagDefinition
extends IValuedDefinition, IFlag

Represents a flag definition in a Metaschema module.

A flag is a simple named data value that can be associated with a field or assembly. Flag definitions define the data type and constraints for flag values.

Nested Class Summary

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

IAttributable.Key

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

IDefinition.ModuleScope

Field Summary

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

DEFAULT_PROPERY_NAMESPACE

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

DEFAULT_MODULE_SCOPE

Method Summary

Modifier and Type	Method	Description
default <CONTEXT, RESULT> RESULT	accept(IModelElementVisitor<CONTEXT,RESULT> visitor, CONTEXT context)	A visitor callback.
IFlagInstance	getInlineInstance()	If IDefinition.isInline() is true, return the instance the definition is inlined for.

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

getDefinitionQName, getLocation, getModuleScope, isInline, toCoordinates

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

getDescription, getEffectiveDescription, getEffectiveFormalName, getFormalName

Methods inherited from interface dev.metaschema.core.model.constraint.IFeatureValueConstrained

addConstraint, addConstraint, addConstraint, addConstraint, addConstraint, addLetExpression, getAllowedValuesConstraints, getConstraints, getConstraintSupport, getExpectConstraints, getIndexHasKeyConstraints, getLetExpressions, getMatchesConstraints, getReportConstraints

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

getModelType

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

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

getJsonName

Methods inherited from interface dev.metaschema.core.model.constraint.IValueConstrained

getSource

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

getJavaTypeAdapter

Method Details

getInlineInstance

IFlagInstance getInlineInstance()

Description copied from interface: IDefinition

If IDefinition.isInline() is true, return the instance the definition is inlined for.

If this method returns null, then IDefinition.getInlineInstance() must return false.

Specified by:

getInlineInstance in interface IDefinition

Returns:

the instance or null otherwise

See Also:

• IDefinition.isInline()

accept

default <CONTEXT,
RESULT> RESULT accept(@NonNull
 IModelElementVisitor<CONTEXT,RESULT> visitor,
 CONTEXT context)

A visitor callback.

Specified by:

accept in interface IModelElementVisitable

Type Parameters:

CONTEXT - the type of the context parameter

RESULT - the type of the visitor result

Parameters:

visitor - the calling visitor

context - a parameter used to pass contextual information between visitors

Returns:

the visitor result