javax.cim

Class CIMClassProperty<E>

java.lang.Object

javax.cim.CIMElement

javax.cim.CIMTypedElement

javax.cim.CIMValuedElement<E>

javax.cim.CIMProperty<E>

javax.cim.CIMClassProperty<E>

Type Parameters:

E - Type parameter.

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CIMElement>, CIMQualifiedElementInterface

public class CIMClassProperty<E>
extends CIMProperty<E>
implements CIMQualifiedElementInterface

This class represents a CIM property (when used for a CIMClass) as defined by the Distributed Management Task Force (DMTF) CIM Infrastructure Specification (DSP004). This class is to be used for all CIMClass properties. NOTE: For instance properties, use the class CIMProperty.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CIMClassProperty(java.lang.String pName, CIMDataType pType, E pValue, CIMQualifier<?>[] pQualifiers, boolean pKey, boolean pPropagated, java.lang.String pOriginClass) This method constructs an instance of CIMClassProperty.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object pObj) Compares this object against the specified object.
CIMClassProperty<E>	filter(boolean pIncludeQualifiers, boolean pIncludeClassOrigin) Returns a CIMClassProperty filtered as specified.
CIMClassProperty<E>	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.

Methods inherited from class javax.cim.CIMProperty

getOriginClass, isKey, isPropagated

Methods inherited from class javax.cim.CIMValuedElement

getValue, hashCode, toString

Methods inherited from class javax.cim.CIMTypedElement

getDataType

Methods inherited from class javax.cim.CIMElement

compareTo, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

CIMClassProperty

public CIMClassProperty(java.lang.String pName,
                CIMDataType pType,
                E pValue,
                CIMQualifier<?>[] pQualifiers,
                boolean pKey,
                boolean pPropagated,
                java.lang.String pOriginClass)

This method constructs an instance of CIMClassProperty.

Parameters:

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.

pPropagated - true if the property was inherited, otherwise false.

pOriginClass - The original class in which the property was defined.

Method Detail

equals

public boolean equals(java.lang.Object pObj)

Compares this object against the specified object. The result is true if and only if the argument is not null and is a CIMClassProperty that represents the same name, type and value as this object.

Overrides:

equals in class CIMProperty<E>

Parameters:

pObj - The object to compare with.

Returns:

true if the objects are the same; false otherwise.

filter

public CIMClassProperty<E> filter(boolean pIncludeQualifiers,
                         boolean pIncludeClassOrigin)

Returns a CIMClassProperty filtered as specified.

Parameters:

pIncludeQualifiers - If true all qualifiers are returned; otherwise no qualifiers.

pIncludeClassOrigin - If true the class origin is included; otherwise no class origin is present.

Returns:

A filtered CIMClassProperty.

filter

public CIMClassProperty<E> filter(boolean pIncludeQualifiers,
                         boolean pIncludeClassOrigin,
                         boolean pLocalOnly)

Returns a CIMClassProperty filtered as specified.

Parameters:

pIncludeQualifiers - If true all qualifiers are returned; otherwise no qualifiers.

pIncludeClassOrigin - If true the class origin is included; otherwise no class origin is present.

pLocalOnly - If true only the qualifiers that were not propagated will be included.

Returns:

CIMClassProperty A filtered CIMClassProperty.

getQualifier

public CIMQualifier<?> getQualifier(int pIndex)
                             throws java.lang.ArrayIndexOutOfBoundsException

Get a qualifier by index.

Specified by:

getQualifier in interface CIMQualifiedElementInterface

Parameters:

pIndex - The index of the qualifier to retrieve.

Returns:

The qualifier at the specified index.

Throws:

java.lang.ArrayIndexOutOfBoundsException

getQualifier

public CIMQualifier<?> getQualifier(java.lang.String pName)

Gets a qualifier by name.

Specified by:

getQualifier in interface CIMQualifiedElementInterface

Parameters:

pName - The name of the qualifier to get.

Returns:

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

getQualifierCount

public int getQualifierCount()

Get the number of qualifiers defined for this property.

Specified by:

getQualifierCount in interface CIMQualifiedElementInterface

Returns:

The number of qualifiers defined for this property.

getQualifiers

public CIMQualifier<?>[] getQualifiers()

Returns the list of qualifiers for this property.

Specified by:

getQualifiers in interface CIMQualifiedElementInterface

Returns:

Qualifiers for this property.

getQualifierValue

public java.lang.Object getQualifierValue(java.lang.String pName)

Gets a qualifier value by name.

Specified by:

getQualifierValue in interface CIMQualifiedElementInterface

Parameters:

pName - The name of the qualifier to get.

Returns:

null if the qualifier does not exist or value is null, otherwise returns the reference to the qualifier.

hasQualifier

public boolean hasQualifier(java.lang.String pName)

Checks whether the specified qualifier is one of the qualifiers defined for this property.

Specified by:

hasQualifier in interface CIMQualifiedElementInterface

Parameters:

pName - The name of the qualifier.

Returns:

true if the qualifier exists in this property, otherwise false.

hasQualifierValue

public 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. This method will return false if the qualifier is not applied or if the value does not match.

Specified by:

hasQualifierValue in interface CIMQualifiedElementInterface

Parameters:

pName - The name of the qualifier.

pValue - The value to be tested.

Returns:

true if the qualifier exists in this property, otherwise false.