Package net.aifusion.metamodel

Enum StandardQualifierType

java.lang.Object
java.lang.Enum<StandardQualifierType>
net.aifusion.metamodel.StandardQualifierType
All Implemented Interfaces:
Serializable, Comparable<StandardQualifierType>, java.lang.constant.Constable
public enum StandardQualifierType extends Enum<StandardQualifierType>
Standard CIM Qualifier Types defined in the meta model. This Enum provides "built-in" qualifier types that are defined in a standard way. Note that unlike the QualifierType class, this enumeration does not accommodate user defined qualifier types loaded into a Repository, and has all information hard-coded in it. Qualifier Types defined in this class are available by default in the implementation, and do not need to be defined explicitly in MOF.
Author:
Sharad Singhal
See Also:

  • 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
    ABSTRACT
    Qualifier ABSTRACT : Boolean = false, Scope(CLASS, ASSOCIATION, ENUMERATION, STRUCTURE, INTERFACE), Policy(RESTRICTED)
    AGGREGATIONKIND
    Qualifier AggregationKind : String = "None", Scope(REFERENCE), Policy(DISABLEOVERRIDE)
    ARRAYTYPE
    Qualifier ARRAYTYPE : String = "Bag", Scope(PROPERTY, PARAMETER, METHOD, REFERENCE), Policy(DISABLEOVERRIDE);
    BITMAP
    Qualifier BITMAP : String[], Scope(METHOD, PROPERTY, PARAMETER), Policy(ENABLEOVERRIDE)
    BITVALUES
    Qualifier BITVALUES : String[], Scope(METHOD, PROPERTY, PARAMETER), Policy(ENABLEOVERRIDE);
    COUNTER
    Qualifier COUNTER : Boolean = false, Scope(METHOD, PROPERTY, PARAMETER), Policy(DISABLEOVERIDE)
    DEPRECATED
    Qualifier DEPRECATED : String[], Scope(ANY), Policy(RESTRICTED)
    DESCRIPTION
    Qualifier DESCRIPTION : String, Scope(ANY), Policy(ENABLEOVERIDE)
    EMBEDDEDOBJECT
    Qualifier EMBEDDEDOBJECT : Boolean = false, Scope(METHOD, PROPERTY, PARAMETER), Policy(DISABLEOVERRIDE)
    EXPERIMENTAL
    Qualifier EXPERIMENTAL : Boolean = false, Scope(ANY), Policy(RESTRICTED)
    GAUGE
    Qualifier GAUGE : Boolean = false, Scope(METHOD, PROPERTY, PARAMETER)), Policy(DISABLEOVERRIDE)
    IMPLEMENTS
    Qualifier IMPLEMENTS : String[], Scope(CLASS, ASSOCIATION), Policy(RESTRICTED)
    IN
    Qualifier IN : Boolean = true, Scope(PARAMETER), Policy(DISABLEOVERRIDE)
    ISPUNIT
    Qualifier ISPUNIT : Boolean = false, Scope(METHOD, PROPERTY, PARAMETER), Policy(ENABLEOVERRIDE)
    KEY
    Qualifier KEY : Boolean = false, Scope(PROPERTY, REFERENCE), Policy(DISABLEOVERRIDE)
    MAPPINGSTRINGS
    Qualifier MAPPINGSTRINGS : String[], Scope(ANY), Policy(ENABLEOVERRIDE)
    MAX
    Qualifier MAX : UnsignedInt32, Scope(REFERENCE), Policy(ENABLEOVERRIDE)
    MIN
    Qualifier MIN : UnsignedInt32 = 0, Scope(REFERENCE), Policy(ENABLEOVERRIDE)
    MODELCORRESPONDENCE
    Qualifier MODELCORRESPONDENCE : String[], Scope(ANY), Policy(ENABLEOVERRIDE)
    OCL
    Qualifier OCL : String[], Scope(CLASS, ASSOCIATION, STRUCTURE, PROPERTY, METHOD, PARAMETER), Policy(ENABLEOVERRIDE)
    OUT
    Qualifier OUT : Boolean = false, Scope(PARAMETER), Policy(DISABLEOVERRIDE)
    OVERRIDE
    Qualifier OVERRIDE : Boolean = false, Scope(METHOD, PROPERTY, REFERENCE, PARAMETER), Policy(RESTRICTED)
    PACKAGEPATH
    Qualifier PACKAGEPATH : String, Scope(ASSOCIATION, CLASS, ENUMERATION,STRUCTURE), Policy(ENABLEOVERRIDE)
    PUNIT
    Qualifier PUNIT : String, Scope(METHOD, PROPERTY, PARAMETER), Policy(ENABLEOVERRIDE)
    READ
    Qualifier READ : Boolean = true, Scope(PROPERTY,REFERENCE), Policy(ENABLEOVERRIDE)
    REQUIRED
    Qualifier REQUIRED : Boolean = false, Scope(METHOD, PROPERTY, REFERENCE, PARAMETER), Policy(DISABLEOVERRIDE)
    STATIC
    Qualifier STATIC : Boolean = false, Scope(METHOD, PROPERTY), Policy(DISABLEOVERRIDE)
    TERMINAL
    Qualifier TERMINAL : Boolean = false, Scope(CLASS, ASSOCIATION, ENUMERATION, STRUCTURE), Policy(ENABLEOVERRIDE)
    VERSION
    Qualifier VERSION : String, Scope(INTERFACE, CLASS, ASSOCIATION, ENUMERATION,STRUCTURE), Policy(RESTRICTED)
    WRITE
    Qualifier WRITE : Boolean = false, Scope(PROPERTY,REFERENCE), Policy(ENABLEOVERRIDE)
    XMLNAMESPACENAME
    Qualifier XMLNAMESPACENAME : String = null, Scope(PARAMETER,PROPERTY,REFERENCE,METHOD), Policy(ENABLEOVERRIDE)

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    appliesTo(ElementType elementType)
    Check if this qualifierType applies to a given elementType
    DataType
    getDataType()
    Get the CIM data type of this qualifier type
    DataValue
    getDefaultValue()
    Get the default dataValue for this qualifier type
    String
    getMofName()
    Get the MOF name associated with this qualifier type
    Policy
    getPolicy()
    Get the policy to which this qualifier type can be applied.
    Qualifier
    getQualifier()
    Create a new Qualifier instance based on this qualifier type with the default namespace.
    Qualifier
    getQualifier(Object value, NameSpacePath path)
    Create a new Qualifier instance based on this qualifier type
    QualifierType
    getQualifierType()
    Get the QualifierType dataValue corresponding to this CimStandardQualifier
    QualifierType
    getQualifierType(NameSpacePath path)
    Get the QualifierType corresponding to this StandardQualifier within a given nameSpace
    static QualifierType[]
    getQualifierTypes()
    Get all pre-defined qualifier types.
    List<Scope>
    getScopes()
    Get the scopes to which this qualifier type can be applied.
    boolean
    hasArrayValue()
    Check if this qualifier type has an array dataValue
    boolean
    hasDefaultValue()
    Check if the qualifier type has a default dataValue specified
    boolean
    hasScope(Scope s)
    Check if this qualifierType has a given scope
    static boolean
    isKnownType(String name)
    Check if a given name is a standard qualifier type
    boolean
    isOverridable()
    Check if this qualifier type can be overridden in subclasses
    boolean
    isRestricted()
    Check if this qualifier type has restricted propagation policy
    String
    toMOF()
    Return a MOF representation of this Qualifier Type
    static StandardQualifierType
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static StandardQualifierType[]
    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

    • ABSTRACT

      public static final StandardQualifierType ABSTRACT
      Qualifier ABSTRACT : Boolean = false, Scope(CLASS, ASSOCIATION, ENUMERATION, STRUCTURE, INTERFACE), Policy(RESTRICTED)

    • AGGREGATIONKIND

      public static final StandardQualifierType AGGREGATIONKIND
      Qualifier AggregationKind : String = "None", Scope(REFERENCE), Policy(DISABLEOVERRIDE)

    • ARRAYTYPE

      public static final StandardQualifierType ARRAYTYPE
      Qualifier ARRAYTYPE : String = "Bag", Scope(PROPERTY, PARAMETER, METHOD, REFERENCE), Policy(DISABLEOVERRIDE);

    • BITMAP

      public static final StandardQualifierType BITMAP
      Qualifier BITMAP : String[], Scope(METHOD, PROPERTY, PARAMETER), Policy(ENABLEOVERRIDE)

    • BITVALUES

      public static final StandardQualifierType BITVALUES
      Qualifier BITVALUES : String[], Scope(METHOD, PROPERTY, PARAMETER), Policy(ENABLEOVERRIDE);

    • COUNTER

      public static final StandardQualifierType COUNTER
      Qualifier COUNTER : Boolean = false, Scope(METHOD, PROPERTY, PARAMETER), Policy(DISABLEOVERIDE)

    • DEPRECATED

      public static final StandardQualifierType DEPRECATED
      Qualifier DEPRECATED : String[], Scope(ANY), Policy(RESTRICTED)

    • DESCRIPTION

      public static final StandardQualifierType DESCRIPTION
      Qualifier DESCRIPTION : String, Scope(ANY), Policy(ENABLEOVERIDE)

    • EMBEDDEDOBJECT

      public static final StandardQualifierType EMBEDDEDOBJECT
      Qualifier EMBEDDEDOBJECT : Boolean = false, Scope(METHOD, PROPERTY, PARAMETER), Policy(DISABLEOVERRIDE)

    • EXPERIMENTAL

      public static final StandardQualifierType EXPERIMENTAL
      Qualifier EXPERIMENTAL : Boolean = false, Scope(ANY), Policy(RESTRICTED)

    • GAUGE

      public static final StandardQualifierType GAUGE
      Qualifier GAUGE : Boolean = false, Scope(METHOD, PROPERTY, PARAMETER)), Policy(DISABLEOVERRIDE)

    • IN

      public static final StandardQualifierType IN
      Qualifier IN : Boolean = true, Scope(PARAMETER), Policy(DISABLEOVERRIDE)

    • ISPUNIT

      public static final StandardQualifierType ISPUNIT
      Qualifier ISPUNIT : Boolean = false, Scope(METHOD, PROPERTY, PARAMETER), Policy(ENABLEOVERRIDE)

    • KEY

      public static final StandardQualifierType KEY
      Qualifier KEY : Boolean = false, Scope(PROPERTY, REFERENCE), Policy(DISABLEOVERRIDE)

    • MAPPINGSTRINGS

      public static final StandardQualifierType MAPPINGSTRINGS
      Qualifier MAPPINGSTRINGS : String[], Scope(ANY), Policy(ENABLEOVERRIDE)

    • MAX

      public static final StandardQualifierType MAX
      Qualifier MAX : UnsignedInt32, Scope(REFERENCE), Policy(ENABLEOVERRIDE)

    • MIN

      public static final StandardQualifierType MIN
      Qualifier MIN : UnsignedInt32 = 0, Scope(REFERENCE), Policy(ENABLEOVERRIDE)

    • MODELCORRESPONDENCE

      public static final StandardQualifierType MODELCORRESPONDENCE
      Qualifier MODELCORRESPONDENCE : String[], Scope(ANY), Policy(ENABLEOVERRIDE)

    • OCL

      public static final StandardQualifierType OCL
      Qualifier OCL : String[], Scope(CLASS, ASSOCIATION, STRUCTURE, PROPERTY, METHOD, PARAMETER), Policy(ENABLEOVERRIDE)

    • OUT

      public static final StandardQualifierType OUT
      Qualifier OUT : Boolean = false, Scope(PARAMETER), Policy(DISABLEOVERRIDE)

    • OVERRIDE

      public static final StandardQualifierType OVERRIDE
      Qualifier OVERRIDE : Boolean = false, Scope(METHOD, PROPERTY, REFERENCE, PARAMETER), Policy(RESTRICTED)

    • PACKAGEPATH

      public static final StandardQualifierType PACKAGEPATH
      Qualifier PACKAGEPATH : String, Scope(ASSOCIATION, CLASS, ENUMERATION,STRUCTURE), Policy(ENABLEOVERRIDE)

    • PUNIT

      public static final StandardQualifierType PUNIT
      Qualifier PUNIT : String, Scope(METHOD, PROPERTY, PARAMETER), Policy(ENABLEOVERRIDE)

    • READ

      public static final StandardQualifierType READ
      Qualifier READ : Boolean = true, Scope(PROPERTY,REFERENCE), Policy(ENABLEOVERRIDE)

    • REQUIRED

      public static final StandardQualifierType REQUIRED
      Qualifier REQUIRED : Boolean = false, Scope(METHOD, PROPERTY, REFERENCE, PARAMETER), Policy(DISABLEOVERRIDE)

    • STATIC

      public static final StandardQualifierType STATIC
      Qualifier STATIC : Boolean = false, Scope(METHOD, PROPERTY), Policy(DISABLEOVERRIDE)

    • TERMINAL

      public static final StandardQualifierType TERMINAL
      Qualifier TERMINAL : Boolean = false, Scope(CLASS, ASSOCIATION, ENUMERATION, STRUCTURE), Policy(ENABLEOVERRIDE)

    • VERSION

      public static final StandardQualifierType VERSION
      Qualifier VERSION : String, Scope(INTERFACE, CLASS, ASSOCIATION, ENUMERATION,STRUCTURE), Policy(RESTRICTED)

    • WRITE

      public static final StandardQualifierType WRITE
      Qualifier WRITE : Boolean = false, Scope(PROPERTY,REFERENCE), Policy(ENABLEOVERRIDE)

    • XMLNAMESPACENAME

      public static final StandardQualifierType XMLNAMESPACENAME
      Qualifier XMLNAMESPACENAME : String = null, Scope(PARAMETER,PROPERTY,REFERENCE,METHOD), Policy(ENABLEOVERRIDE)

    • IMPLEMENTS

      public static final StandardQualifierType IMPLEMENTS
      Qualifier IMPLEMENTS : String[], Scope(CLASS, ASSOCIATION), Policy(RESTRICTED)

  • Method Details

    • values

      public static StandardQualifierType[] 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 StandardQualifierType 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

    • hasDefaultValue

      public boolean hasDefaultValue()
      Check if the qualifier type has a default dataValue specified
      Returns:
      - true if the qualifier type has a default dataValue, false otherwise

    • getDefaultValue

      public DataValue getDefaultValue()
      Get the default dataValue for this qualifier type
      Returns:
      The CIM dataValue for this qualifier type. Null if this qualifier type does not have a value

    • hasArrayValue

      public boolean hasArrayValue()
      Check if this qualifier type has an array dataValue
      Returns:
      - true if this qualifier type has an array dataValue, false otherwise

    • getScopes

      public List<Scope> getScopes()
      Get the scopes to which this qualifier type can be applied.
      Returns:
      set of CIM element scopes for which this qualifier type is applicable.

    • getPolicy

      public Policy getPolicy()
      Get the policy to which this qualifier type can be applied.
      Returns:
      set of policy for which this qualifier type is applicable.

    • getDataType

      public DataType getDataType()
      Get the CIM data type of this qualifier type
      Returns:
      The data type of this qualifier type.

    • getMofName

      public String getMofName()
      Get the MOF name associated with this qualifier type
      Returns:
      - MOF name associated with this qualifier type

    • appliesTo

      public boolean appliesTo(ElementType elementType)
      Check if this qualifierType applies to a given elementType
      Parameters:
      elementType - - type of element to check
      Returns:
      - true if the standardQualifierType applies to this element type, false otherwise

    • hasScope

      public boolean hasScope(Scope s)
      Check if this qualifierType has a given scope
      Parameters:
      s - - scope to check
      Returns:
      - true if the qualifierType has the given scope, false otherwise

    • isRestricted

      public boolean isRestricted()
      Check if this qualifier type has restricted propagation policy
      Returns:
      - true if qualifier type is restricted, false otherwise
      See Also:

    • isOverridable

      public boolean isOverridable()
      Check if this qualifier type can be overridden in subclasses
      Returns:
      - true if the qualifier type can be overridden, false otherwise. Note that the returned dataValue is meaningful only if the qualifier type is not restricted, i.e. isRestricted() returns false.
      See Also:

    • toMOF

      public String toMOF()
      Return a MOF representation of this Qualifier Type
      Returns:
      - String containing MOF representation of this Qualifier Type

    • getQualifier

      public Qualifier getQualifier(Object value, NameSpacePath path)
      Create a new Qualifier instance based on this qualifier type
      Parameters:
      value - - dataValue of the qualifier (java object or DataValue)
      path - - namespace path for the qualifier. If null, a default dataValue is used
      Returns:
      - new qualifier instance
      See Also:

    • getQualifier

      public Qualifier getQualifier()
      Create a new Qualifier instance based on this qualifier type with the default namespace. The Qualifier has default dataValue and policy as defined in the qualifier type
      Returns:
      - new qualifier of this type
      See Also:

    • getQualifierTypes

      public static QualifierType[] getQualifierTypes()
      Get all pre-defined qualifier types. Does NOT include user defined qualifier types
      Returns:
      - array containing all pre-defined Cim QualifierTypes within the default namespace
      See Also:

    • isKnownType

      public static boolean isKnownType(String name)
      Check if a given name is a standard qualifier type
      Parameters:
      name - - name to be checked
      Returns:
      - true if name is a standard qualifier type, false otherwise

    • getQualifierType

      public QualifierType getQualifierType()
      Get the QualifierType dataValue corresponding to this CimStandardQualifier
      Returns:
      - qualifier type for this Standard Qualifier Type
      See Also:

    • getQualifierType

      public QualifierType getQualifierType(NameSpacePath path)
      Get the QualifierType corresponding to this StandardQualifier within a given nameSpace
      Parameters:
      path - - name space path to use for the qualifier type. If null, a default name space is used
      Returns:
      - qualifier type corresponding to this standard qualifier type
      See Also: