Class CIMParameter<E>
java.lang.Object
javax.cim.CIMElement
javax.cim.CIMTypedElement
javax.cim.CIMParameter<E>
- Type Parameters:
E
- Type parameter.
- All Implemented Interfaces:
Serializable, Comparable<CIMElement>, CIMQualifiedElementInterface
This class represents a CIM Parameter. A CIM Parameter is a schema item, thus
it can only be part of a
CIMMethod
definition for a
CIMClass
. A parameter can be used to define an input, output or
input/output parameter. A CIMParameter
consists of a name, data
type and qualifiers. CIMParameters
do not have values - so you
can not set a default value. CIM Parameters are defined by the Distributed
Management Task Force (DMTF) CIM
Infrastructure Specification (DSP004). To invoke a method, you would use CIMArgument
.- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionCIMParameter
(String pName, CIMDataType pType, CIMQualifier<?>[] pQualifiers) Constructs aCIMParameter
object using the specified name, data type and qualifiers. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compares this object against the specified object.filter
(boolean pIncludeQualifiers, boolean pLocalOnly) Returns aCIMParameter
filtered as specified.CIMQualifier
<?> getQualifier
(int pIndex) Get a qualifier by index.CIMQualifier
<?> getQualifier
(String pName) Gets a qualifier by name.int
Get the number of qualifiers defined for this CIM Parameter.CIMQualifier<?>[]
Returns the list of qualifiers for this class.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 parameter with the specified value.toString()
Returns aString
representation of theCIMParameter
.Methods inherited from class CIMTypedElement
getDataType, hashCode
Methods inherited from class CIMElement
compareTo, getName
-
Constructor Details
-
CIMParameter
Constructs aCIMParameter
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.- Parameters:
pName
- Name of this parameter.pType
- Data type of this parameter.pQualifiers
- Qualifiers for this parameter.
-
-
Method Details
-
equals
Compares this object against the specified object. The result istrue
if and only if the argument is notnull
and is aCIMParameter
object that represents the same value as this object.- Overrides:
equals
in classCIMTypedElement
- Parameters:
pObj
- The object to compare.- Returns:
true
if the objects are the same;false
otherwise.
-
filter
Returns aCIMParameter
filtered as specified.- Parameters:
pIncludeQualifiers
- Iftrue
all qualifiers are returned; otherwise no qualifiers.pLocalOnly
- Iftrue
only the qualifiers that were not propagated will be included.- Returns:
- A filtered
CIMParameter
.
-
getQualifier
Get a qualifier by index.- Specified by:
getQualifier
in interfaceCIMQualifiedElementInterface
- Parameters:
pIndex
- The index of the qualifier.- Returns:
- The Qualifier at index pIndex.
- Throws:
ArrayIndexOutOfBoundsException
-
getQualifier
Gets a qualifier by name.- Specified by:
getQualifier
in interfaceCIMQualifiedElementInterface
- 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 Parameter.- Specified by:
getQualifierCount
in interfaceCIMQualifiedElementInterface
- Returns:
- The number of qualifiers.
-
getQualifiers
Returns the list of qualifiers for this class.- Specified by:
getQualifiers
in interfaceCIMQualifiedElementInterface
- Returns:
- Qualifiers for this class.
-
getQualifierValue
Gets a qualifier value by name.- Specified by:
getQualifierValue
in interfaceCIMQualifiedElementInterface
- Parameters:
pName
- The name of the qualifier to get.- Returns:
null
if the qualifier does not exist or value isnull
, otherwise returns the reference to the qualifier.
-
hasQualifier
Checks whether the specified qualifier is one of the qualifiers in this CIM element.- Specified by:
hasQualifier
in interfaceCIMQualifiedElementInterface
- Parameters:
pName
- The name of the qualifier.- Returns:
true
if the qualifier exists in this CIM parameter, otherwisefalse
.
-
hasQualifierValue
Checks whether the specified qualifier is one of the qualifiers defined for this parameter with the specified value. This method will returnfalse
if the qualifier is not applied or if the value does not match.- Specified by:
hasQualifierValue
in interfaceCIMQualifiedElementInterface
- Parameters:
pName
- The name of the qualifier.pValue
- The value to be tested.- Returns:
true
if the qualifier exists in this property, otherwisefalse
.
-
toString
Returns aString
representation of theCIMParameter
. 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 benull
.- Overrides:
toString
in classCIMTypedElement
- Returns:
- String representation of this parameter.
-