Annotation Type Export


Annotation used for mapping java to CIM. The presence of this annotation on a java class, method, or method parameter provides information to allow the run time to bind the java element to the corresponding CIM definition.
Author:
Sharad Singhal
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    default value, if any, for the annotated property, parameter or reference.
    boolean
    Forces a java class to be defined as a MOF class, even if it only exports properties.
    Name of the CIM model class.
    CIM Namespace within which this element resides.
    Qualifiers, if any on this element.
    Referenced Java class, used to the name of the corresponding NamedElement for methods/properties that return ObjectPath/EnumValue/StructureValue/CimInstance etc.
    CIM Model Schema used when annotating classes.
    default version of the class, if any, for annotated enumerations, classes, and structures
  • Element Details

    • name

      String name
      Name of the CIM model class. By default, the name of the underlying java class or method is used
      Returns:
      name of the model class
      Default:
      ""
    • nameSpace

      String nameSpace
      CIM Namespace within which this element resides.
      Returns:
      - namespace within which the element resides.
      Default:
      "/aifusion"
    • schema

      String schema
      CIM Model Schema used when annotating classes. Default is "CimFusion". Schema names must be of the form "[a-zA-Z]\\w*_\\w+"
      Returns:
      schema associated with the model class
      Default:
      "AIFusion"
    • forceClass

      boolean forceClass
      Forces a java class to be defined as a MOF class, even if it only exports properties. Default is false
      Returns:
      true if this class should be modeled as a CIM class, even if it does not have methods
      Default:
      false
    • refClass

      String refClass
      Referenced Java class, used to the name of the corresponding NamedElement for methods/properties that return ObjectPath/EnumValue/StructureValue/CimInstance etc. Empty by default.
      Returns:
      fully qualified name of referenced Java class. Empty by default
      Default:
      ""
    • qualifiers

      String qualifiers
      Qualifiers, if any on this element. Default is an empty string
      Returns:
      - string containing MOF qualifers, if any.
      Default:
      ""
    • defaultValue

      String defaultValue
      default value, if any, for the annotated property, parameter or reference. Empty string implies no default value. Ignored for methods. Note that arrays can be specified by enclosing comma separated list in braces, e.g. "{1,2,3}". Also note that string values must contain double quotes, so must be explicitly included e.g., defaultValue="\"stringValue\""
      Returns:
      default value for the element
      Default:
      ""
    • version

      String version
      default version of the class, if any, for annotated enumerations, classes, and structures
      Returns:
      version for the class
      Default:
      "0.0.1"