Module dev.metaschema.core
Package dev.metaschema.core.model

Interface IDescribable

All Known Subinterfaces:
IAllowedValuesConstraint, IAssembly, IAssemblyDefinition, IAssemblyInstance, IAssemblyInstanceAbsolute, IAssemblyInstanceGrouped, IBindingDefinitionModel, IBindingDefinitionModelAssembly, IBoundDefinition, IBoundDefinitionFlag, IBoundDefinitionModel<ITEM>, IBoundDefinitionModelAssembly, IBoundDefinitionModelComplex, IBoundDefinitionModelField<ITEM>, IBoundDefinitionModelFieldComplex, IBoundInstanceFlag, IBoundInstanceModelAssembly, IBoundInstanceModelField<ITEM>, IBoundInstanceModelFieldComplex, IBoundInstanceModelFieldScalar, IBoundInstanceModelGroupedAssembly, IBoundInstanceModelGroupedField, IBoundInstanceModelGroupedNamed, IBoundInstanceModelNamed<ITEM>, ICardinalityConstraint, IConfigurableMessageConstraint, IConstraint, IDefinition, IExpectConstraint, IFeatureContainerFlag<FI>, IFeatureDefinitionInstanceInlined<DEFINITION,INSTANCE>, IFeatureDefinitionReferenceInstance<DEFINITION,INSTANCE>, IField, IFieldDefinition, IFieldInstance, IFieldInstanceAbsolute, IFieldInstanceGrouped, IFlag, IFlagDefinition, IFlagInstance, IIndexConstraint, IIndexHasKeyConstraint, IKeyConstraint, IMatchesConstraint, IModelDefinition, INamedInstance, INamedModelElement, INamedModelInstance, INamedModelInstanceAbsolute, INamedModelInstanceGrouped, IReportConstraint, IUniqueConstraint, IValuedDefinition, IValuedInstance
All Known Implementing Classes:
AbstractAssemblyInstance, AbstractFieldInstance, AbstractFlagInstance, AbstractGlobalAssemblyDefinition, AbstractGlobalDefinition, AbstractGlobalFieldDefinition, AbstractGlobalFlagDefinition, AbstractInlineAssemblyDefinition, AbstractInlineFieldDefinition, AbstractInlineFlagDefinition, AbstractNamedInstance, AbstractNamedModelInstance
public interface IDescribable
Represents a model element that has a formal name and description.

This interface provides access to human-readable documentation properties that describe the purpose and usage of a model element.

  • Method Summary

    Modifier and Type
    Method
    Description
    MarkupLine
    getDescription()
    Get the text that describes the basic use of the element.
    default MarkupLine
    getEffectiveDescription()
    Get the text that describes the basic use of the element, which allows an instance to override a definition's description.
    default String
    getEffectiveFormalName()
    The resolved formal display name, which allows an instance to override a definition's name.
    String
    getFormalName()
    The formal display name.

  • Method Details

    • getFormalName

      @Nullable String getFormalName()
      The formal display name.
      Returns:
      the formal name or null if not defined

    • getDescription

      @Nullable MarkupLine getDescription()
      Get the text that describes the basic use of the element.
      Returns:
      a line of markup text or null if not defined

    • getEffectiveFormalName

      @Nullable default String getEffectiveFormalName()
      The resolved formal display name, which allows an instance to override a definition's name.
      Returns:
      the formal name or null if not defined

    • getEffectiveDescription

      @Nullable default MarkupLine getEffectiveDescription()
      Get the text that describes the basic use of the element, which allows an instance to override a definition's description.
      Returns:
      a line of markup text or null if not defined