org.opengroup.arm40.metric
Interface ArmMetricDefinition

All Superinterfaces:
ArmInterface
All Known Subinterfaces:
ArmMetricCounter32Definition, ArmMetricCounter64Definition, ArmMetricCounterFloat32Definition, ArmMetricGauge32Definition, ArmMetricGauge64Definition, ArmMetricGaugeFloat32Definition, ArmMetricNumericId32Definition, ArmMetricNumericId64Definition, ArmMetricString32Definition
All Known Implementing Classes:
ArmMetricCounter32Definition, ArmMetricCounter64Definition, ArmMetricCounterFloat32Definition, ArmMetricDefinition, ArmMetricGauge32Definition, ArmMetricGauge64Definition, ArmMetricGaugeFloat32Definition, ArmMetricNumericId32Definition, ArmMetricNumericId64Definition, ArmMetricString32Definition

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 short METRIC_USE_GENERAL
          No specific usage semantics are declared.
static short METRIC_USE_TRAN_SIZE
          Metric represents the "size" of the transaction (counter & gauge only).
static short METRIC_USE_TRAN_STATUS
          Metric represents status, like an error code (numeric ID & string only).
 
Method Summary
 ArmID getID()
          Gets the (optional) ID for this definition.
 java.lang.String getName()
          Gets the name of this definition.
 java.lang.String getUnits()
          Gets the (optional) units description.
 short getUsage()
          Gets the usage semantics.
 
Methods inherited from interface org.opengroup.arm40.transaction.ArmInterface
getErrorCode, getErrorMessage, setErrorCode
 

Field Detail

METRIC_USE_GENERAL

static final short METRIC_USE_GENERAL
No specific usage semantics are declared.

See Also:
Constant Field Values

METRIC_USE_TRAN_SIZE

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

See Also:
Constant Field Values

METRIC_USE_TRAN_STATUS

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

See Also:
Constant Field Values
Method Detail

getID

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

Returns:
the ID or null.

getName

java.lang.String getName()
Gets the name of this definition.

Returns:
the definition name.

getUnits

java.lang.String getUnits()
Gets the (optional) units description.

Returns:
the units desciption or null.

getUsage

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.