javax.cim
Class CIMMethod

java.lang.Object
  javax.cim.CIMElement
      javax.cim.CIMTypedElement
          javax.cim.CIMMethod

All Implemented Interfaces:

CIMQualifiedElementInterface, java.io.Serializable

public class CIMMethod

extends javax.cim.CIMTypedElement

implements CIMQualifiedElementInterface, java.io.Serializable

This class represents a CIM Method as defined by the Distributed Management Task Force (DMTF) CIM Infrastructure Specification (DSP004).

Since:

JSR48 1.0.0

See Also:

Serialized Form

Constructor Summary

CIMMethod(java.lang.String name, CIMDataType type, CIMQualifier[] qualifiers, CIMParameter[] parameters, boolean propagated, java.lang.String originClass)
Constructs a CIMMethod object with the specified information.

Method Summary

boolean	equals(java.lang.Object obj) Compares this object against the specified object.
CIMDataType	getDataType() Returns the CIMDataType for this CIM Element.
java.lang.String	getOriginClass() Returns the class name in which this method was defined or overridden.
CIMParameter[]	getParameters() Returns an array of the parameters for this method
CIMQualifier	getQualifier(int pIndex) Get a qualifier by index.
CIMQualifier	getQualifier(java.lang.String pName) Gets a qualifier by name.
int	getQualifierCount() Get the number of qualifiers defined for this CIM Element.
CIMQualifier[]	getQualifiers() Returns the list of qualifiers for this class
java.lang.Object	getQualifierValue(java.lang.String name) Gets a qualifier value by name.
boolean	hasQualifier(java.lang.String pName) Checks whether the specified qualifier is one of the qualifiers in this CIM element.
boolean	hasQualifierValue(java.lang.String name, java.lang.Object value) Checks whether the specified qualifier is one of the qualifiers defined for this method with the specified value.
java.lang.String	toString() Returns a String representation of the CIMMethod.

Methods inherited from class javax.cim.CIMElement

getName, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CIMMethod

public CIMMethod(java.lang.String name,
                 CIMDataType type,
                 CIMQualifier[] qualifiers,
                 CIMParameter[] parameters,
                 boolean propagated,
                 java.lang.String originClass)

Constructs a CIMMethod object with the specified information.

Parameters:

name - The name of the method.

type - The data type of the method.

qualifiers - The method qualifiers.

parameters - The array of parameters for this method.

propagated - Is this method propagated from the superclass.

originClass - The class this method was defined or overridden in.

Method Detail

getOriginClass

public java.lang.String getOriginClass()

Returns the class name in which this method was defined or overridden.

Returns:

String Name of class where this property was defined.

getParameters

public CIMParameter[] getParameters()

Returns an array of the parameters for this method

Returns:

CIMParameter[] The parameters for this method

getQualifier

public CIMQualifier getQualifier(int pIndex)

Get a qualifier by index.

Specified by:

getQualifier in interface CIMQualifiedElementInterface

Parameters:

pIndex - The index of the qualifier

Returns:

The Qualifier at index pIndex

getQualifier

public CIMQualifier getQualifier(java.lang.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 Element.

Specified by:

getQualifierCount in interface CIMQualifiedElementInterface

Returns:

int The number of qualifiers.

getQualifiers

public CIMQualifier[] getQualifiers()

Returns the list of qualifiers for this class

Specified by:

getQualifiers in interface CIMQualifiedElementInterface

Returns:

CIMQualifier[] qualifiers for this class

getQualifierValue

public java.lang.Object getQualifierValue(java.lang.String name)

Gets a qualifier value by name.

Specified by:

getQualifierValue in interface CIMQualifiedElementInterface

Parameters:

name - 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(java.lang.String pName)

Checks whether the specified qualifier is one of the qualifiers in this CIM element.

Specified by:

hasQualifier in interface CIMQualifiedElementInterface

Parameters:

pName - the name of the qualifier

Returns:

true if the qualifier exists in this CIM element, otherwise false.

hasQualifierValue

public boolean hasQualifierValue(java.lang.String name,
                                 java.lang.Object value)

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:

name - the name of the qualifier

value - the value to be tested

Returns:

True if the qualifier exists and has this value, otherwise false.

toString

public java.lang.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 CIMElement

Returns:

the string representation of this method

equals

public boolean equals(java.lang.Object obj)

Compares this object against the specified object. The result is true if and only if the argument is not null and is a CIMTypedElement that represents the same name and type as this object.

Overrides:

equals in class CIMElement

Parameters:

obj - - the object to compare with.

Returns:

true if the objects are the same; false otherwise.

getDataType

public CIMDataType getDataType()

Returns the CIMDataType for this CIM Element.

Returns:

CIMDataType of this CIM element.