Class CIMProperty
java.lang.Object
org.sblim.wbem.cim.CIMElement
org.sblim.wbem.cim.CIMQualifiableElement
org.sblim.wbem.cim.CIMProperty
- All Implemented Interfaces:
Serializable, Cloneable, Comparable
- See Also:
-
Field Summary
Fields inherited from class CIMQualifiableElement
iQualifiers
Fields inherited from class CIMElement
CLOSING_BRAKET, EMPTY, iName, OPENING_BRAKET
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an CIMProperty object.CIMProperty
(String pName) Creates a CIMProperty object with the specified name.CIMProperty
(String pName, CIMValue pValue) Creates a CIMProperty with the specified name and CIMValue. -
Method Summary
Modifier and TypeMethodDescriptionclone()
clone
(boolean pIncludeQualifier, boolean pIncludeClassOrigin) Creates a replica of this object.boolean
Returns the origin class for this object.Returns the name of the property that this CIMProperty overrides.int
getSize()
Returns the size of this property.getType()
Returns the CIMDataType associated with this CIMProperty.getValue()
Returns the CIMValue associated with this CIMProperty.boolean
isKey()
Determines if this CIMProperty contains the Key qualifier.boolean
Determines if this CIMProperty is propagated.boolean
Determines if this CIMProperty is a reference data type.boolean
removeQualifier
(String pName) Removes the qualifier with the specified name from this CIMProperty.void
setKey
(boolean pKey) Adds/removes the key qualifiervoid
setOriginClass
(String pOriginClass) Specifies the origin class for this CIMProperty.void
setOverridingProperty
(String pNewOverridingProperty) Specifies the overriding property for this CIMProperty.void
setPropagated
(boolean pValue) Sets the propagated value to the specified value.setQualifier
(CIMQualifier pQualifier) Updates the CIMQualifier value from the CIMProperty with the specified CIMQualifier.void
setSize
(int pSize) Deprecated.the size of the property is bounded to the CIMDataType, which is unmutable.void
setType
(CIMDataType pType) Sets the CIMDataType for this CIMProperty.void
Sets the value of this CIMProperty to the specified CIMProperty.toMOF()
Returns the MOF representation of this CIMObject.toString()
Methods inherited from class CIMQualifiableElement
addQualifier, getQualifier, getQualifiers, setQualifiers
Methods inherited from class CIMElement
appendTab, assign, compareTo, getName, lessThan, setName, vectorToMOFString, vectorToMOFString, vectorToMOFString
-
Constructor Details
-
CIMProperty
public CIMProperty()Creates an CIMProperty object. -
CIMProperty
Creates a CIMProperty object with the specified name.- Parameters:
pName
- The property's name
-
CIMProperty
-
-
Method Details
-
clone
-
clone
Creates a replica of this object. Only if the includeQualifier arguments is true, the qualifiers of the CIMProperty will be copied. Only if includeClassOrigin is true, the classorigin information will be passed to the new object.- Parameters:
pIncludeQualifier
- iftrue
, the qualifiers of the CIMProperty will be copiedpIncludeClassOrigin
- iftrue
, the classorigin information will be copied- Returns:
- The replica
-
equals
- Overrides:
equals
in classCIMElement
-
getOriginClass
Returns the origin class for this object. The origin class specifies the CIMClass that introduces this property.- Returns:
- The originating class
-
getOverridingProperty
Returns the name of the property that this CIMProperty overrides. Returns null if this CIMProperty does not override any property.- Returns:
- The overridden property
-
getSize
public int getSize()Returns the size of this property.- Returns:
- The size
-
getValue
Returns the CIMValue associated with this CIMProperty.- Returns:
- The value
-
getType
Returns the CIMDataType associated with this CIMProperty.- Returns:
- The type
-
isKey
public boolean isKey()Determines if this CIMProperty contains the Key qualifier.- Returns:
true
if the property is a key property
-
isPropagated
public boolean isPropagated()Determines if this CIMProperty is propagated.- Returns:
true
if the property is propagated
-
isReference
public boolean isReference()Determines if this CIMProperty is a reference data type.- Returns:
true
if the property is a reference
-
removeQualifier
Removes the qualifier with the specified name from this CIMProperty.- Overrides:
removeQualifier
in classCIMQualifiableElement
- Parameters:
pName
- The qualifier's name- Returns:
true
if the qualifier was successfully removed, otherwise returnsfalse
.
-
setKey
public void setKey(boolean pKey) Adds/removes the key qualifier- Parameters:
pKey
- iftrue
the key qualifier is added, otherwise it's removed
-
setOverridingProperty
Specifies the overriding property for this CIMProperty.- Parameters:
pNewOverridingProperty
- The overriding property
-
setOriginClass
Specifies the origin class for this CIMProperty.- Parameters:
pOriginClass
- The origin class
-
setPropagated
public void setPropagated(boolean pValue) Sets the propagated value to the specified value.- Parameters:
pValue
- The propageted value
-
setSize
public void setSize(int pSize) Deprecated.the size of the property is bounded to the CIMDataType, which is unmutable. Applications are encourage to specify the CIMDataType with the appopiated size.Specifies the size of this property.- Parameters:
pSize
- The size
-
setType
Sets the CIMDataType for this CIMProperty.- Parameters:
pType
- The type- Throws:
IllegalArgumentException
- if the current property already has a CIMValue assigned to it and the new CIMDataType does not matches the value's data type.
-
setQualifier
Updates the CIMQualifier value from the CIMProperty with the specified CIMQualifier.- Parameters:
pQualifier
- The qualifier- Returns:
- The new qualifier
- Throws:
CIMException
- if a CIMQualifier with the same name does not exists.
-
setValue
Sets the value of this CIMProperty to the specified CIMProperty.- Parameters:
pValue
- The value- Throws:
IllegalArgumentException
- if the specified CIMValues's type does not match current CIMDataType
-
toMOF
Returns the MOF representation of this CIMObject.- Returns:
- The MOF representation
-
toString
-