|
||||||||||
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.CIMValuedElement
javax.cim.CIMProperty
javax.cim.CIMClassProperty
public class CIMClassProperty
Creates and instantiates a CIM property, a name/value pair used to
characterize instances of a class. Use this API to create a new attribute to
describe managed objects. For example, after a printer upgrade to handle
duplex (two-sided) printing, you could use this interface to create a CIM
property called duplex. The CIMProperty
class inherits the
property name from its parent class (CIMProperty extends CIMQualifiedElement
).
A CIM Property is defined by its name, data type and origin class.
Constructor Summary | |
---|---|
CIMClassProperty(java.lang.String pName,
CIMDataType pType,
java.lang.Object pValue,
CIMQualifier[] pQualifiers,
boolean pKey,
boolean propagated,
java.lang.String originClass)
This method constructs an instance of CIMClassProperty . |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object pObj)
Compares this object against the specified object. |
CIMClassProperty |
filter(boolean pIncludeQualifiers,
boolean pIncludeClassOrigin)
Returns a CIMClassProperty filtered as specified. |
CIMClassProperty |
filter(boolean pIncludeQualifiers,
boolean pIncludeClassOrigin,
boolean pLocalOnly)
Returns a CIMClassProperty filtered as specified. |
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 property. |
CIMQualifier[] |
getQualifiers()
Returns the list of qualifiers for this property. |
java.lang.Object |
getQualifierValue(java.lang.String pName)
Gets a qualifier value by name. |
boolean |
hasQualifier(java.lang.String pName)
Checks whether the specified qualifier is one of the qualifiers defined for this property. |
boolean |
hasQualifierValue(java.lang.String pName,
java.lang.Object pValue)
Checks whether the specified qualifier is one of the qualifiers defined for this property with the specified value. |
java.lang.String |
toString()
Returns a String representation of the
CIMElement This method is intended to be used only for
debugging purposes, and the format of the returned string may vary
between implementations. |
Methods inherited from class javax.cim.CIMProperty |
---|
getOriginClass, isKey, isPropagated |
Methods inherited from class javax.cim.CIMValuedElement |
---|
getValue |
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 CIMClassProperty(java.lang.String pName, CIMDataType pType, java.lang.Object pValue, CIMQualifier[] pQualifiers, boolean pKey, boolean propagated, java.lang.String originClass)
CIMClassProperty
.
pName
- -
The name of the property.pType
- -
The data type of the property.pValue
- -
The value of the property.pQualifiers
- -
The qualifiers for the property.pKey
- -
true
if the property is a key, otherwise
false
.propagated
- -
true
if the property was inherited, otherwise
false
.originClass
- -
The original class in which the property was defined.Method Detail |
---|
public boolean equals(java.lang.Object pObj)
CIMProperty
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 CIMProperty
pObj
- -
the object to compare with.
true
if the objects are the same;
false
otherwise.CIMProperty.equals(java.lang.Object)
public CIMClassProperty filter(boolean pIncludeQualifiers, boolean pIncludeClassOrigin)
CIMClassProperty
filtered as specified.
pIncludeQualifiers
- -
If true
all qualifiers are returned; otherwise
no qualifiers.pIncludeClassOrigin
- -
If true
the class origin is included; otherwise
no class origin is present
CIMClassProperty
.public CIMClassProperty filter(boolean pIncludeQualifiers, boolean pIncludeClassOrigin, boolean pLocalOnly)
pIncludeQualifiers
- If true all qualifiers are returned; otherwise no qualifiers.pIncludeClassOrigin
- If true the class origin is included; otherwise no class
origin is presentpLocalOnly
- If true only the qualifiers that were not propagated will be
included.
public CIMQualifier getQualifier(int pIndex)
getQualifier
in interface CIMQualifiedElementInterface
pIndex
- -
The index of the qualifier to retrieve.
public CIMQualifier getQualifier(java.lang.String pName)
getQualifier
in interface CIMQualifiedElementInterface
pName
- -
The name of the qualifier to get.
null
if the qualifier
does not exist.public java.lang.Object getQualifierValue(java.lang.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()
getQualifierCount
in interface CIMQualifiedElementInterface
public CIMQualifier[] getQualifiers()
getQualifiers
in interface CIMQualifiedElementInterface
public boolean hasQualifier(java.lang.String pName)
hasQualifier
in interface CIMQualifiedElementInterface
pName
- -
the name of the qualifier.
true
if the qualifier exists in this property,
otherwise false
.public boolean hasQualifierValue(java.lang.String pName, java.lang.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 java.lang.String toString()
String
representation of the
CIMElement
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 CIMProperty
CIMTypedElement.toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |