org.opengroup.arm40.metric
public interface ArmMetricDefinition extends ArmInterface
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:
METRIC_USE_...
below for
the defined values. Any negative value is also permitted;
the negative range is reserved for application-specific values.
ArmMetricDefinition
are created using the
newArmMetric...Definition()
methods of ArmMetricFactory.
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. |
String | getName()
Gets the name of this definition. |
String | getUnits()
Gets the (optional) units description. |
short | getUsage()
Gets the usage semantics. |
Returns: the ID or null
.
Returns: the definition name.
Returns: the units desciption or null
.
Returns: One of METRIC_USE_GENERAL, METRIC_USE_TRAN_SIZE, METRIC_USE_TRAN_STATUS, or an application-specific negative value.