org.sblim.wbem.cim
Class CIMProperty
- Cloneable, Comparable, Serializable
public class CIMProperty
implements Cloneable, Serializable
CIMProperty.java
(C) Copyright IBM Corp. 2005, 2006
THIS FILE IS PROVIDED UNDER THE TERMS OF THE COMMON PUBLIC LICENSE
("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS FILE
CONSTITUTES RECIPIENTS ACCEPTANCE OF THE AGREEMENT.
You can obtain a current copy of the Common Public License from
http://www.opensource.org/licenses/cpl1.0.php
CIMProperty() - Creates 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.
|
Object | clone()
|
Object | clone(boolean pIncludeQualifier, boolean pIncludeClassOrigin) - Creates a replica of this object.
|
boolean | equals(Object obj)
|
String | getOriginClass() - Returns the origin class for this object.
|
String | getOverridingProperty() - Returns the name of the property that this CIMProperty overrides.
|
int | getSize() - Returns the size of this property.
|
CIMDataType | getType() - Returns the CIMDataType associated with this CIMProperty.
|
CIMValue | getValue() - Returns the CIMValue associated with this CIMProperty.
|
boolean | isKey() - Determines if this CIMProperty contains the Key qualifier.
|
boolean | isPropagated() - Determines if this CIMProperty is propagated.
|
boolean | isReference() - 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 qualifier
|
void | 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.
|
CIMQualifier | setQualifier(CIMQualifier pQualifier) - Updates the CIMQualifier value from the CIMProperty with the specified
CIMQualifier.
|
void | setSize(int pSize) - the size of the property is bounded to the CIMDataType, which
is unmutable.
|
void | setType(CIMDataType pType) - Sets the CIMDataType for this CIMProperty.
|
void | setValue(CIMValue pValue) - Sets the value of this CIMProperty to the specified CIMProperty.
|
String | toMOF() - Returns the MOF representation of this CIMObject.
|
String | toString()
|
CIMProperty
public CIMProperty()
Creates an CIMProperty object.
CIMProperty
public CIMProperty(String pName)
Creates a CIMProperty object with the specified name.
pName
- The property's name
CIMProperty
public CIMProperty(String pName,
CIMValue pValue)
Creates a CIMProperty with the specified name and CIMValue.
pName
- The property's namepValue
- The property's value
clone
public Object clone()
clone
public Object clone(boolean pIncludeQualifier,
boolean pIncludeClassOrigin)
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.
pIncludeQualifier
- if true
, the qualifiers of the CIMProperty
will be copiedpIncludeClassOrigin
- if true
, the classorigin information will be
copied
getOriginClass
public String getOriginClass()
Returns the origin class for this object. The origin class specifies the
CIMClass that introduces this property.
getOverridingProperty
public String getOverridingProperty()
Returns the name of the property that this CIMProperty overrides. Returns
null if this CIMProperty does not override any property.
getSize
public int getSize()
Returns the size of this property.
getType
public CIMDataType getType()
Returns the CIMDataType associated with this CIMProperty.
getValue
public CIMValue getValue()
Returns the CIMValue associated with this CIMProperty.
isKey
public boolean isKey()
Determines if this CIMProperty contains the Key qualifier.
true
if the property is a key property
isPropagated
public boolean isPropagated()
Determines if this CIMProperty is propagated.
true
if the property is propagated
isReference
public boolean isReference()
Determines if this CIMProperty is a reference data type.
true
if the property is a reference
removeQualifier
public boolean removeQualifier(String pName)
Removes the qualifier with the specified name from this CIMProperty.
- removeQualifier in interface CIMQualifiableElement
pName
- The qualifier's name
true
if the qualifier was successfully removed,
otherwise returns false
.
setKey
public void setKey(boolean pKey)
Adds/removes the key qualifier
pKey
- if true
the key qualifier is added, otherwise
it's removed
setOriginClass
public void setOriginClass(String pOriginClass)
Specifies the origin class for this CIMProperty.
pOriginClass
- The origin class
setOverridingProperty
public void setOverridingProperty(String pNewOverridingProperty)
Specifies the overriding property for this CIMProperty.
pNewOverridingProperty
- The overriding property
setPropagated
public void setPropagated(boolean pValue)
Sets the propagated value to the specified value.
pValue
- The propageted value
setQualifier
public CIMQualifier setQualifier(CIMQualifier pQualifier)
throws CIMException
Updates the CIMQualifier value from the CIMProperty with the specified
CIMQualifier.
pQualifier
- The qualifier
CIMException
- if a CIMQualifier with the same name does not exists.
setSize
public void setSize(int pSize)
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.
setType
public void setType(CIMDataType pType)
Sets the CIMDataType for this CIMProperty.
setValue
public void setValue(CIMValue pValue)
Sets the value of this CIMProperty to the specified CIMProperty.
toMOF
public String toMOF()
Returns the MOF representation of this CIMObject.
toString
public String toString()
Copyright © 2005, 2006 IBM Corporation. All Rights Reserved.