Class CIMMethod<E>

java.lang.Object
javax.cim.CIMElement
javax.cim.CIMTypedElement
javax.cim.CIMMethod<E>
Type Parameters:
E - Type parameter.
All Implemented Interfaces:
Serializable, Comparable<CIMElement>, CIMQualifiedElementInterface
public class CIMMethod<E> extends CIMTypedElement implements CIMQualifiedElementInterface
This class represents a CIM Method as defined by the Distributed Management Task Force (DMTF) CIM Infrastructure Specification (DSP004).
See Also:

  • Constructor Details

    • CIMMethod

      public CIMMethod(String pName, CIMDataType pType, CIMQualifier<?>[] pQualis, CIMParameter<?>[] pParams, boolean pPropagated, String pOriginClass)
      Constructs a CIMMethod object with the specified information.
      Parameters:
      pName - The name of the method.
      pType - The data type of the method.
      pQualis - The method qualifiers.
      pParams - The array of parameters for this method.
      pPropagated - Is this method propagated from the superclass.
      pOriginClass - The class this method was defined or overridden in.

  • Method Details

    • equals

      public boolean equals(Object pObj)
      Compares this object against the specified object. The result is true if and only if the argument is not null and is a CIMMethod object that represents the same value as this object.
      Overrides:
      equals in class CIMTypedElement
      Parameters:
      pObj - The object to compare.
      Returns:
      true if the objects are the same; false otherwise.

    • filter

      public CIMMethod<E> filter(boolean pIncludeQualifiers, boolean pIncludeClassOrigin)
      Returns a CIMMethod filtered as specified.
      Parameters:
      pIncludeQualifiers - If true all qualifiers are returned; otherwise no qualifiers.
      pIncludeClassOrigin - If true the class origin is included; otherwise no class origin is present.
      Returns:
      A filtered CIMMethod.

    • filter

      public CIMMethod<E> filter(boolean pIncludeQualifiers, boolean pIncludeClassOrigin, boolean pLocalOnly)
      Returns a CIMMethod filtered as specified.
      Parameters:
      pIncludeQualifiers - If true all qualifiers are returned; otherwise no qualifiers.
      pIncludeClassOrigin - If true the class origin is included; otherwise no class origin is present
      pLocalOnly - If true only the qualifiers defined on this class are included; otherwise all qualifiers are included.
      Returns:
      A filtered CIMMethod.

    • getOriginClass

      public String getOriginClass()
      Returns the class name in which this method was defined or overridden.
      Returns:
      Name of class where this property was defined.

    • getParameter

      public CIMParameter<?> getParameter(String pName)
      Get the parameter that matches the specified name.
      Parameters:
      pName - The name of the CIMParameter to retrieve.
      Returns:
      CIMParameter matching the name specified; otherwise null.

    • getParameters

      public CIMParameter<?>[] getParameters()
      Returns an array of the parameters for this method.
      Returns:
      The parameters for this method.

    • getQualifier

      public CIMQualifier<?> getQualifier(int pIndex) throws ArrayIndexOutOfBoundsException
      Get a qualifier by index.
      Specified by:
      getQualifier in interface CIMQualifiedElementInterface
      Parameters:
      pIndex - The index of the qualifier.
      Returns:
      The Qualifier at index pIndex.
      Throws:
      ArrayIndexOutOfBoundsException

    • getQualifier

      public CIMQualifier<?> getQualifier(String pName)
      Gets a qualifier by name.
      Specified by:
      getQualifier in interface CIMQualifiedElementInterface
      Parameters:
      pName - The name of the qualifier to get.
      Returns:
      null if the qualifier does not exist, otherwise returns the reference to the qualifier.

    • getQualifierCount

      public int getQualifierCount()
      Get the number of qualifiers defined for this CIM Method.
      Specified by:
      getQualifierCount in interface CIMQualifiedElementInterface
      Returns:
      The number of qualifiers.

    • getQualifiers

      public CIMQualifier<?>[] getQualifiers()
      Returns the list of qualifiers for this class.
      Specified by:
      getQualifiers in interface CIMQualifiedElementInterface
      Returns:
      Qualifiers for this class.

    • getQualifierValue

      public Object getQualifierValue(String pName)
      Gets a qualifier value by name.
      Specified by:
      getQualifierValue in interface CIMQualifiedElementInterface
      Parameters:
      pName - The name of the qualifier to get.
      Returns:
      null if the qualifier does not exist or value is null, otherwise returns the reference to the qualifier.

    • hasQualifier

      public boolean hasQualifier(String pName)
      Checks whether the specified qualifier is one of the qualifiers in this CIM method.
      Specified by:
      hasQualifier in interface CIMQualifiedElementInterface
      Parameters:
      pName - The name of the qualifier.
      Returns:
      true if the qualifier exists in this CIM method, otherwise false.

    • hasQualifierValue

      public boolean hasQualifierValue(String pName, Object pValue)
      Checks whether the specified qualifier is one of the qualifiers defined for this method with the specified value. This method will return false if the qualifier is not applied or if the value does not match.
      Specified by:
      hasQualifierValue in interface CIMQualifiedElementInterface
      Parameters:
      pName - The name of the qualifier.
      pValue - The value to be tested.
      Returns:
      true if the qualifier exists and has this value, otherwise false.

    • isPropagated

      public boolean isPropagated()
      Determines if this method is Propagated.
      Returns:
      true if this method is propagated.

    • toString

      public String toString()
      Returns a String representation of the CIMMethod. This method is intended to be used only for debugging purposes, and the format of the returned string may vary between implementations. The returned string may be empty but may not be null.
      Overrides:
      toString in class CIMTypedElement
      Returns:
      The string representation of this method.