Class CIMClass

java.lang.Object
org.sblim.wbem.cim.CIMElement
org.sblim.wbem.cim.CIMQualifiableElement
org.sblim.wbem.cim.CIMObject
org.sblim.wbem.cim.CIMClass
All Implemented Interfaces:
Serializable, Cloneable, Comparable
public class CIMClass extends CIMObject implements Serializable, Cloneable
Defines a Java object that represents a CIM Class. A CIM Class provides the class definition for creating CIM Instances.
See Also:

  • Constructor Details

    • CIMClass

      public CIMClass()
      Constructs an object of a CIMClass.

    • CIMClass

      public CIMClass(String pClassName)
      Construct an object of a CIMClass with the specified name.
      Parameters:
      pClassName -

    • CIMClass

      public CIMClass(CIMObjectPath pObjectPath)
      Construct an object of a CIMClass pointing to the specified CIMObjectPath. Initialize internal object path with the information provided (namespace, hostname, and object name)
      Parameters:
      pObjectPath -
      Throws:
      IllegalArgumentException - if the object name of the objectpath or the object path are null

  • Method Details

    • addMethod

      public void addMethod(CIMMethod pMethod)
      Add a CIMMethod to this class.
      Parameters:
      pMethod - defines a CIMMethod to be added to the class. If the method already exists, nothing happend.
      Throws:
      IllegalArgumentException - if the specified method is null.

    • clone

      public Object clone()
      Overrides:
      clone in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class CIMElement

    • getMethod

      protected CIMMethod getMethod(CIMMethod pMethod)
      Gets a method corresponding to the specified name
      Parameters:
      pMethod - A CIMMethod with the name to look for
      Returns:
      The method

    • getAllMethods

      protected CIMMethod getAllMethods(CIMMethod pMethod)

    • filterProperties

      public CIMClass filterProperties(String[] pPropertyList)
      Creates a replica of this CIMClass only with the properties specified in the propertyList argument.
      Parameters:
      pPropertyList - An array with string of property names. (case sencitive names)
      Returns:
      The replica

    • getAllMethods

      public Vector getAllMethods()
      Return all the methods for this class, including all the methods inherited from superclasses.
      Returns:
      A Vector containin all CIMMethods from this class. For performance reasons, the returned vector points to the internal data structure that maintains the methods. Modifications on this object may result in an inconsistent state of the CIMClass. Applications MUST deside when this obect has to be cloned.

    • getMethod

      public CIMMethod getMethod(String pName)
      Returns a CIMMethod with the specified name. If a method with the specified name (case sensitive) does not exists, then returns null. For performance reasons, this method returns the internal data structure that is used to by the CIMClass. Modifications on this object may result in state of the CIMClass or CIMMethod. Applications MUST deside when this object has to be cloned.
      Parameters:
      pName - The method's name
      Returns:
      null if the speficied method is not found or does not exists.

    • getMethod

      public CIMMethod getMethod(String pName, String pOriginClass)
      Returns a CIMMethod with the specified name for the given class origin. If a method with the specified name (case sensitive) does not exists, then returns null. The class origin may be "superclass.overridingmethod" or "overridingmethod", or null. For performance reasons, this method returns the internal data structure that is used to by the CIMClass. Modifications on this object may result in state of the CIMClass or CIMMethod. Applications MUST deside when this object has to be cloned.
      Parameters:
      pName - The method's name
      pOriginClass - The class origin
      Returns:
      null if the speficied method is not found or does not exists.

    • getMethods

      public Vector getMethods()
      Returns a vector containing all the CIMMethods defined by this CIMClass, without including the methods inherited by any super classes. For performance reasons, this method returns a vector that contains CIMMethods which are internally used by the CIMClass. Modifications on the CIMMethods objects may result in state of the CIMClass or CIMMethod. Applications MUST deside when this object has to be cloned.
      Returns:
      a vector of CIMMethods.

    • getSuperClass

      public String getSuperClass()
      Returns the name of the super class. Return null if this class does not has a super class.
      Returns:
      a string which defines the super class of this class.

    • isAssociation

      public boolean isAssociation()
      Determines if this CIMClass contains the Association qualifier.
      Returns:
      true if this class contains the association qualifier, otherwise false.

    • isKeyed

      public boolean isKeyed()
      Determines if this CIMClass contains any keyed CIMProperty.
      Returns:
      true if this CIMClass contains a keyed CIMProperty, otherwise returns false.

    • localElements

      public CIMClass localElements()
      Creates a replica of this CIMClass which only contains the objects local CIMProperties and CIMMethods. A local CIMProperty or CIMMethod are those that the original CIMClass is this object.
      Returns:
      The replica

    • newInstance

      public CIMInstance newInstance()
      Creates an CIMInstance object based on this CIMClass. This CIMInstance may be used later to create a CIMInstance remotely at the CIMOM with the CIMClient.createInstance() method.
      Returns:
      The new instance

    • numberOfProperties

      public int numberOfProperties()
      Returns the number of properties in this class.
      Returns:
      The property count

    • numberOfQualifiers

      public int numberOfQualifiers()
      Returns the number of qualifiers in this class.
      Returns:
      The qualifier count

    • setSuperClass

      public void setSuperClass(String pClass)
      Sets the super class for this class. If null is passed means that the class does not have any super class.
      Parameters:
      pClass -

    • setIsAssociation

      public void setIsAssociation(boolean pValue)
      Adds or removes the Association qualifier from this CIMClass. Depending on the case, this method will add if the specified parameter is true, otherwise remove the association qualifier from this CIMClass.
      Parameters:
      pValue -

    • setIsKeyed

      public void setIsKeyed(boolean pValue)
      Deprecated.
      this method may lead to confusion. Instead of this method application are encourage to remove/add the Key qualifier manually.
      Specified when this CIM Class has key properties or not.
      Parameters:
      pValue -

    • setMethods

      public void setMethods(Vector pMethods)
      Assigns the specified vector with CIMMethod to this CIMClass. If the method argument is null, all the CIMMethods from this CIMClass will be removed.
      Parameters:
      pMethods -

    • setName

      public void setName(String pName)
      Sets the name for this CIMClass.
      Overrides:
      setName in class CIMElement
      Parameters:
      pName - The name

    • getObjectPath

      public CIMObjectPath getObjectPath()
      Returns the CIMObjectPath from this object. For performance reasons, this method returns the internal structure used by the CIMClass. The application is responsable to deside when it must may a copy of the returned object to prevent inconsiste state.
      Returns:
      A CIMObjectPath pointing to the class.

    • setObjectPath

      public void setObjectPath(CIMObjectPath pObjectPath)
      Sets the CIMObjectPath for the current CIMClass.
      Specified by:
      setObjectPath in class CIMObject
      Parameters:
      pObjectPath -

    • toMOF

      public String toMOF()
      Returns the MOF representation of this object.
      Returns:
      A string containig the MOF representation

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • main

      public static void main(String[] args)