com.crankuptheamps.client.fields

Class StatusField

java.lang.Object

com.crankuptheamps.client.fields.Field

com.crankuptheamps.client.fields.StatusField

public class StatusField
extends Field

Field data for a Message which consists of a status. This is the status of the Message. This status indicates the success or failure of the command being acknowledged.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.nio.charset.Charset	LATIN1
protected static byte	LATIN1_ZERO

Fields inherited from class com.crankuptheamps.client.fields.Field

buffer, length, position

Constructor Summary

Constructors

Constructor and Description
StatusField()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	encodeStatus(int s) Utility method that takes a status code integer and returns the associated descriptive text.
int	getValue() This returns the value of this status field as an integer status code.
void	setValue(int v) Sets the value of this status field using the specified status code integer.

Methods inherited from class com.crankuptheamps.client.fields.Field

byteAt, copy, copyFrom, equals, hashCode, isNull, reset, set, set, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LATIN1

protected static final java.nio.charset.Charset LATIN1

LATIN1_ZERO

protected static final byte LATIN1_ZERO

See Also:

Constant Field Values

Constructor Detail

StatusField

public StatusField()

Method Detail

getValue

public int getValue()

This returns the value of this status field as an integer status code.

Returns:

The value of this status field as an integer status code.

See Also:

Message.Status

setValue

public void setValue(int v)

Sets the value of this status field using the specified status code integer.

Parameters:

v - The status code integer.

See Also:

Message.Status

encodeStatus

public static final java.lang.String encodeStatus(int s)

Utility method that takes a status code integer and returns the associated descriptive text. Returns "none" if the integer code is not known.

Parameters:

s - The status code integer to be encoded.

Returns:

The descriptive text status.