Package net.aifusion.metamodel

Enum Scope

java.lang.Object
java.lang.Enum<Scope>
net.aifusion.metamodel.Scope
All Implemented Interfaces:
Serializable, Comparable<Scope>, java.lang.constant.Constable
public enum Scope extends Enum<Scope>
Scope of CIM Qualifiers. The scope defines cim elements that can be annotated with a given qualifier
Author:
Sharad Singhal

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ANY
    The qualifier can be applied to any meta element
    ASSOCIATION
    The qualifier can be applied to associations (needed for CimV.2 parser)
    CLASS
    The qualifier can be applied to a class
    ENUMERATION
    The qualifier applies to an enumeration
    ENUMERATIONVALUE
    The qualifier applies to an enumeration dataValue
    INDICATION
    The qualifier can be applied to an indication (needed for CimV.2 parser)
    INSTANCE
    The qualifier can be applied to an instance
    INTERFACE
    The qualifier can be applied to an interface
    METHOD
    The qualifier can be applied to a method
    PARAMETER
    The qualifier can be applied to a method parameter
    PROPERTY
    The qualifier can be applied to a property
    QUALIFIERTYPE
    The qualifier can be applied to a qualifier type
    REFERENCE
    The qualifier can be applied to a reference property
    SCHEMA
    The qualifier can be applied to the Schema
    STRUCTURE
    The qualifier can be applied to a structure
    STRUCTUREVALUE
    The qualifier can be applied to a structure value

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    appliesTo(ElementType elementType)
    Check if this scope applies to a given element type
    final String
    toMOF()
    Mof definition of scope
    static Scope
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static Scope[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • STRUCTURE

      public static final Scope STRUCTURE
      The qualifier can be applied to a structure

    • STRUCTUREVALUE

      public static final Scope STRUCTUREVALUE
      The qualifier can be applied to a structure value

    • ENUMERATION

      public static final Scope ENUMERATION
      The qualifier applies to an enumeration

    • ENUMERATIONVALUE

      public static final Scope ENUMERATIONVALUE
      The qualifier applies to an enumeration dataValue

    • INTERFACE

      public static final Scope INTERFACE
      The qualifier can be applied to an interface

    • CLASS

      public static final Scope CLASS
      The qualifier can be applied to a class

    • INSTANCE

      public static final Scope INSTANCE
      The qualifier can be applied to an instance

    • QUALIFIERTYPE

      public static final Scope QUALIFIERTYPE
      The qualifier can be applied to a qualifier type

    • PARAMETER

      public static final Scope PARAMETER
      The qualifier can be applied to a method parameter

    • METHOD

      public static final Scope METHOD
      The qualifier can be applied to a method

    • PROPERTY

      public static final Scope PROPERTY
      The qualifier can be applied to a property

    • REFERENCE

      public static final Scope REFERENCE
      The qualifier can be applied to a reference property

    • SCHEMA

      public static final Scope SCHEMA
      The qualifier can be applied to the Schema

    • ASSOCIATION

      public static final Scope ASSOCIATION
      The qualifier can be applied to associations (needed for CimV.2 parser)

    • INDICATION

      public static final Scope INDICATION
      The qualifier can be applied to an indication (needed for CimV.2 parser)

    • ANY

      public static final Scope ANY
      The qualifier can be applied to any meta element

  • Method Details

    • values

      public static Scope[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static Scope valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • appliesTo

      public final boolean appliesTo(ElementType elementType)
      Check if this scope applies to a given element type
      Parameters:
      elementType - - type of element to be checked
      Returns:
      - true if this scope matches the given element type, false otherwise

    • toMOF

      public final String toMOF()
      Mof definition of scope
      Returns:
      - mixed case dataValue of scope