javax.cim

Class CIMClassProperty<E>

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.

Parameters: Type parameter.

Constructor Summary
CIMClassProperty(String pName, CIMDataType pType, E pValue, CIMQualifier<?>[] pQualifiers, boolean pKey, boolean pPropagated, String pOriginClass)
This method constructs an instance of CIMClassProperty.
Method Summary
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(String pName)
Gets a qualifier by name.
intgetQualifierCount()
Get the number of qualifiers defined for this property.
CIMQualifier<?>[]getQualifiers()
Returns the list of qualifiers for this property.
ObjectgetQualifierValue(String pName)
Gets a qualifier value by name.
booleanhasQualifier(String pName)
Checks whether the specified qualifier is one of the qualifiers defined for this property.
booleanhasQualifierValue(String pName, Object pValue)
Checks whether the specified qualifier is one of the qualifiers defined for this property with the specified value.

Constructor Detail

CIMClassProperty

public CIMClassProperty(String pName, CIMDataType pType, E pValue, CIMQualifier<?>[] pQualifiers, boolean pKey, boolean pPropagated, 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

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)
Get a qualifier by index.

Parameters: pIndex The index of the qualifier to retrieve.

Returns: The qualifier at the specified index.

Throws: ArrayIndexOutOfBoundsException

getQualifier

public CIMQualifier<?> getQualifier(String pName)
Gets a qualifier by name.

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.

Returns: The number of qualifiers defined for this property.

getQualifiers

public CIMQualifier<?>[] getQualifiers()
Returns the list of qualifiers for this property.

Returns: Qualifiers for this property.

getQualifierValue

public Object getQualifierValue(String pName)
Gets a qualifier value by name.

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(String pName)
Checks whether the specified qualifier is one of the qualifiers defined for this property.

Parameters: pName The name of the qualifier.

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

hasQualifierValue

public boolean hasQualifierValue(String pName, 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.

Parameters: pName The name of the qualifier. pValue The value to be tested.

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

Copyright © 2005, 2010 IBM Corporation. All Rights Reserved.