javax.cim
Class CIMInstance

java.lang.Object
  javax.cim.CIMInstance

All Implemented Interfaces:

Serializable, CIMNamedElementInterface

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).

See Also:

Serialized Form

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.
boolean	equals(Object pObj) Indicates whether some other instance is equal to this one.
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.
int	hashCode() Computes the hash code for this instance.
String	toString() Returns a String representation of the CIMInstance.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CIMInstance

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

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.

equals

public boolean equals(Object pObj)

Indicates whether some other instance is equal to this one. Two CIMInstances are considered equal if the names are the same. This method does NOT compare each property value.

Overrides:

equals in class Object

Parameters:

pObj - The object to compare.

Returns:

true if the specified path references the same instance, otherwise false.

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.

getClassName

public String getClassName()

Get the name of the class that instantiates this CIM instance.

Returns:

Name of class that instantiates this CIM instance.

getKeys

public CIMProperty<?>[] getKeys()

Get the key properties for this instance.

Returns:

An array of key properties.

getObjectPath

public CIMObjectPath getObjectPath()

Returns the CIMObjectPath that represents this instance.

Specified by:

getObjectPath in interface CIMNamedElementInterface

Returns:

The CIMObjectPath that represents this instance.

getProperties

public CIMProperty<?>[] getProperties()

Retrieve an array of the properties for this instance.

Returns:

An array of the CIM properties for this instance.

getProperty

public CIMProperty<?> getProperty(int pIndex)
                           throws ArrayIndexOutOfBoundsException

Get a class property by index.

Parameters:

pIndex - The index of the class property to retrieve.

Returns:

The CIMProperty at the specified index.

Throws:

ArrayIndexOutOfBoundsException

getProperty

public CIMProperty<?> getProperty(String pName)

Returns the specified property.

Parameters:

pName - The text string for the name of the property.

Returns:

The property requested or null if the property does not exist.

getProperty

public CIMProperty<?> getProperty(String pName,
                                  String pOriginClass)

Returns the specified CIMProperty.

Parameters:

pName - The string name of the property to get.

pOriginClass - (Optional) The string name of the class in which the property was defined.

Returns:

null if the property does not exist, otherwise returns the CIM property.

getPropertyCount

public int getPropertyCount()

Get the number of properties defined in this CIMInstance.

Returns:

The number of properties defined in the CIMInstance.

getPropertyValue

public Object getPropertyValue(String name)

Returns the value of a property of this CIM Instance.

Parameters:

name - The name of the property.

Returns:

The value for the specified property name or null if the property does not exist.

hashCode

public int hashCode()

Computes the hash code for this instance. The hash code will be the object path of the instance not including the host or namespace information.

Overrides:

hashCode in class Object

Returns:

The integer representing the hash code for this object path.

toString

public String toString()

Returns a String representation of the CIMInstance. 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.

Overrides:

toString in class Object

Returns:

String representation of this instance.