org.arm4.arm40.metric
Class ArmMetricString32

java.lang.Object
  org.arm4.arm40.transaction.ArmInterface
      org.arm4.arm40.metric.ArmMetric
          org.arm4.arm40.metric.ArmMetricString32

All Implemented Interfaces:

ArmMetric, ArmMetricString32, ArmInterface

public class ArmMetricString32
extends ArmMetric
implements ArmMetricString32

Implements a string of 1 to 32 characters. It is the same as ARM 2.0 metric type=10 (ARM_String32), with two differences:

• The characters are in the Java standard UCS-2 format.
• The limit of 32 in the ARM 2.0 C language interface is a byte limit. The limit in the ARM 4.0 C bindings is a character limit. Because a character may be represented by more than one byte (e.g., a character in UTF-8 is represented as 1, 2, or 3 bytes), the ARM 4.0 C metric may be longer than 32 bytes.

Objects implementing this interface are created using ArmMetricFactory.newArmMetricString32(org.opengroup.arm40.metric.ArmMetricString32Definition).

Author:

David Carter

Field Summary

protected java.lang.String

m_string32

Fields inherited from class org.arm4.arm40.transaction.ArmInterface

m_errorCode, m_factory

Constructor Summary

ArmMetricString32(ArmMetricDefinition definition)
Create ARM Metric.

Method Summary

java.lang.String	get() Gets the string value.
int	set(java.lang.String s) Sets the string value.

Methods inherited from class org.arm4.arm40.metric.ArmMetric

getDefinition

Methods inherited from class org.arm4.arm40.transaction.ArmInterface

getErrorCode, getErrorMessage, getFactory, setErrorCode, setFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opengroup.arm40.metric.ArmMetric

getDefinition

Methods inherited from interface org.opengroup.arm40.transaction.ArmInterface

getErrorCode, getErrorMessage, setErrorCode

Field Detail

m_string32

protected java.lang.String m_string32

Constructor Detail

ArmMetricString32

public ArmMetricString32(ArmMetricDefinition definition)

Create ARM Metric.

Parameters:

definition - the descriptive metadata (name, units, usage, ID) for the metric

Method Detail

get

public java.lang.String get()

Description copied from interface: ArmMetricString32

Gets the string value.

Specified by:

get in interface ArmMetricString32

Returns:

the string value.

set

public int set(java.lang.String s)

Description copied from interface: ArmMetricString32

Sets the string value.

Specified by:

set in interface ArmMetricString32

Parameters:

s - new string value.

Returns:

0 on sucess; otherwise, a non-zero error code is returned (as specified in ArmInterface).