javax.cim

Class CIMInstance

public class CIMInstance extends Object implements CIMNamedElementInterface, Serializable

This class represents a CIM instance as defined by the Distributed Management Task Force (DMTF) CIM Infrastructure Specification (DSP004).

Constructor Summary
	CIMInstance(CIMObjectPath pName, CIMProperty<?>[] pProps) Constructs a `CIMInstance` object using the name and properties specified.

Method Summary
CIMInstance	deriveInstance(CIMObjectPath pPath) Returns a CIMInstance with the updated `CIMObjectPath`.
CIMInstance	deriveInstance(CIMProperty<?>[] pPropA) Returns a `CIMInstance` with the updated values for the properties in `pPropA`.
CIMInstance	filterProperties(boolean pLocalOnly, boolean pIncludeClassOrigin, String[] pPropertyList) This method returns a new `CIMInstance` with properties filtered according to the input parameters.
String	getClassName() Get the name of the class that instantiates this CIM instance.
CIMProperty<?>[]	getKeys() Get the key properties for this instance.
CIMObjectPath	getObjectPath() Returns the `CIMObjectPath` that represents this instance.
CIMProperty<?>[]	getProperties() Retrieve an array of the properties for this instance.
CIMProperty<?>	getProperty(int pIndex) Get a class property by index.
CIMProperty<?>	getProperty(String pName) Returns the specified property.
CIMProperty<?>	getProperty(String pName, String pOriginClass) Returns the specified `CIMProperty`.
int	getPropertyCount() Get the number of properties defined in this `CIMInstance`.
Object	getPropertyValue(String name) Returns the value of a property of this CIM Instance.

Constructor Detail

CIMInstance

public CIMInstance(CIMObjectPath pName, CIMProperty<?>[] pProps)

Constructs a CIMInstance object using the name and properties specified.

Parameters: pName The CIMObjectPath for this CIMInstance. pProps The properties for this CIMInstance.

Throws: IllegalArgumentException If pName is null or pName.getObjectName() is null.
[OPTIONAL] - If the key property values do not match the values in the property array. This is optional due to the cost of the verification. Some implementations may leave it up to the developer to ensure that the values match.

Method Detail

deriveInstance

public CIMInstance deriveInstance(CIMObjectPath pPath)

Returns a CIMInstance with the updated CIMObjectPath.

Parameters: pPath The complete CIMObjectPath for this instance.

Returns: A new CIMInstance with the updated CIMObjectPath.

deriveInstance

public CIMInstance deriveInstance(CIMProperty<?>[] pPropA)

Returns a CIMInstance with the updated values for the properties in pPropA. Any new properties are ignored.

Parameters: pPropA The array of properties to update.

Returns: A new instance with the updated properties.

filterProperties

public CIMInstance filterProperties(boolean pLocalOnly, boolean pIncludeClassOrigin, String[] pPropertyList)

This method returns a new CIMInstance with properties filtered according to the input parameters. Inclusion of class origin and qualifiers can also be controlled.

Parameters: pLocalOnly Include only the properties values that were instantiated in this instance. pIncludeClassOrigin classOrigins are only included if true. pPropertyList If the pPropertyList input parameter is not null, the members of the array define one or more Property names. The returned Instance does not include elements for any Properties missing from this list. If the pPropertyList input parameter is an empty array this signifies that no Properties are included in each returned class. If the pPropertyList input parameter is null this specifies that all Properties are included in each returned class. If the pPropertyList contains duplicate elements or invalid property names, they are ignored.

Returns: CIMInstance matching the input filter.