org.opengroup.arm40.metric

Interface ArmMetricDefinition

public interface ArmMetricDefinition extends ArmInterface

The superclass for all the metric definition interfaces. All the methods are defined in ArmMetricDefinition. The subclasses serve as markers for the data types. All the publicly accessible attributes are immutable and have a getter method for them.

The attributes are:

This class cannot be instantiated. Objects that implement a subclass of ArmMetricDefinition are created using the newArmMetric...Definition() methods of ArmMetricFactory.

Author: ARM Working Group of The Open Group

Field Summary
static shortMETRIC_USE_GENERAL
No specific usage semantics are declared.
static shortMETRIC_USE_TRAN_SIZE
Metric represents the "size" of the transaction (counter & gauge only).
static shortMETRIC_USE_TRAN_STATUS
Metric represents status, like an error code (numeric ID & string only).
Method Summary
ArmIDgetID()
Gets the (optional) ID for this definition.
StringgetName()
Gets the name of this definition.
StringgetUnits()
Gets the (optional) units description.
shortgetUsage()
Gets the usage semantics.

Field Detail

METRIC_USE_GENERAL

public static final short METRIC_USE_GENERAL
No specific usage semantics are declared.

METRIC_USE_TRAN_SIZE

public static final short METRIC_USE_TRAN_SIZE
Metric represents the "size" of the transaction (counter & gauge only).

METRIC_USE_TRAN_STATUS

public static final short METRIC_USE_TRAN_STATUS
Metric represents status, like an error code (numeric ID & string only).

Method Detail

getID

public ArmID getID()
Gets the (optional) ID for this definition.

Returns: the ID or null.

getName

public String getName()
Gets the name of this definition.

Returns: the definition name.

getUnits

public String getUnits()
Gets the (optional) units description.

Returns: the units desciption or null.

getUsage

public short getUsage()
Gets the usage semantics.

Returns: One of METRIC_USE_GENERAL, METRIC_USE_TRAN_SIZE, METRIC_USE_TRAN_STATUS, or an application-specific negative value.