|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.cim.CIMElement
javax.cim.CIMTypedElement
javax.cim.CIMParameter<E>
E
- : Type Parameterpublic class CIMParameter<E>
The CIMParameter
class wraps a CIM parameter that is used to
define an input, output or input/output parameter to a CIM method. A
CIMParameter
object consists of a name, data type and a list of
qualifiers. NOTE: Parameters do not have values - so you can not set a
default value. CIM Parameters are defined in the CIM Infrastructure
Specification. The specification is available from the DMTF (Distributed
Management Task Force) at http://dmtf.org/.
CIMMethod
,
Serialized FormConstructor Summary | |
---|---|
CIMParameter(String pName,
CIMDataType pType,
CIMQualifier<?>[] pQualifiers)
Constructs a CIMParameter object using the specified name,
data type and qualifiers. |
Method Summary | |
---|---|
boolean |
equals(Object pObj)
Compares this object against the specified object. |
CIMParameter<E> |
filter(boolean pIncludeQualifiers,
boolean pLocalOnly)
Returns a CIMParameter filtered as specified. |
CIMQualifier<?> |
getQualifier(int pIndex)
Get a qualifier by index. |
CIMQualifier<?> |
getQualifier(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. |
Object |
getQualifierValue(String pName)
Gets a qualifier value by name. |
boolean |
hasQualifier(String pName)
Checks whether the specified qualifier is one of the qualifiers in this CIM element. |
boolean |
hasQualifierValue(String pName,
Object pValue)
Checks whether the specified qualifier is one of the qualifiers defined for this property with the specified value. |
String |
toString()
Returns a String representation of the
CIMParameter . |
Methods inherited from class javax.cim.CIMTypedElement |
---|
getDataType |
Methods inherited from class javax.cim.CIMElement |
---|
compareTo, getName, hashCode |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public CIMParameter(String pName, CIMDataType pType, CIMQualifier<?>[] pQualifiers)
CIMParameter
object using the specified name,
data type and qualifiers. Takes a string for the name of an existing CIM
parameter and creates a new instance of a CIM parameter, using the name
and identifier of the existing CIM parameter.
pName
- - name of this parameterpType
- - data type of this parameterpQualifiers
- - qualifiers for this parameterMethod Detail |
---|
public boolean equals(Object pObj)
CIMTypedElement
true
if and only if the argument is not null
and is a CIMValuedObject
that represents the same name, type
and value as this object.
equals
in class CIMTypedElement
pObj
- - The object to compare with.
true
if the objects are the same; false
otherwise.CIMTypedElement.equals(java.lang.Object)
public CIMParameter<E> filter(boolean pIncludeQualifiers, boolean pLocalOnly)
pIncludeQualifiers
- If true all qualifiers are returned; otherwise no qualifiers.pLocalOnly
- If true only the qualifiers that were not propagated will be
included.
public CIMQualifier<?> getQualifier(int pIndex)
CIMQualifiedElementInterface
getQualifier
in interface CIMQualifiedElementInterface
pIndex
- - The index of the qualifier.
pIndex
.CIMQualifiedElementInterface.getQualifier(int)
public CIMQualifier<?> getQualifier(String pName)
CIMQualifiedElementInterface
getQualifier
in interface CIMQualifiedElementInterface
pName
- - The name of the qualifier to get.
null
if the qualifier does not exist, otherwise
returns the reference to the qualifier.CIMQualifiedElementInterface.getQualifier(java.lang.String)
public Object getQualifierValue(String pName)
CIMQualifiedElementInterface
getQualifierValue
in interface CIMQualifiedElementInterface
pName
- - The name of the qualifier to get.
null
if the qualifier does not exist or value is
null
, otherwise returns the reference to the
qualifier.CIMQualifiedElementInterface.getQualifierValue(java.lang.String)
public int getQualifierCount()
CIMQualifiedElementInterface
getQualifierCount
in interface CIMQualifiedElementInterface
CIMQualifiedElementInterface.getQualifierCount()
public CIMQualifier<?>[] getQualifiers()
CIMQualifiedElementInterface
getQualifiers
in interface CIMQualifiedElementInterface
CIMQualifiedElementInterface.getQualifiers()
public boolean hasQualifier(String pName)
CIMQualifiedElementInterface
hasQualifier
in interface CIMQualifiedElementInterface
pName
- - the name of the qualifier
true
if the qualifier exists in this CIM element,
otherwise false
.CIMQualifiedElementInterface.hasQualifier(java.lang.String)
public boolean hasQualifierValue(String pName, Object pValue)
CIMQualifiedElementInterface
hasQualifierValue
in interface CIMQualifiedElementInterface
pName
- - the name of the qualifierpValue
- - the value to be tested
true
if the qualifier exists and has the value,
otherwise false
.CIMQualifiedElementInterface.hasQualifierValue(java.lang.String,
java.lang.Object)
public String toString()
String
representation of the
CIMParameter
. 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
.
toString
in class CIMTypedElement
CIMElement.toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |