com.crankuptheamps.client.fields

Class ReasonField

java.lang.Object

com.crankuptheamps.client.fields.Field

com.crankuptheamps.client.fields.ReasonField

public class ReasonField
extends Field

Field data for a Message consisting of a reason. This reason helps to provide more information about acknowledgements.

Field Summary

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

buffer, length, position

Constructor Summary

Constructors

Constructor and Description
ReasonField()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	encodeReason(int r) Utility method that takes a reason code integer and returns the associated descriptive text.
java.lang.String	getText() Returns the value of this reason field as a descriptive text string.
int	getValue() This returns the value of this reason field as an integer reason code.
void	setValue(int v) Sets the value of this reason field using the specified reason 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

Constructor Detail

ReasonField

public ReasonField()

Method Detail

getValue

public int getValue()

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

Returns:

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

See Also:

Message.Reason

getText

public java.lang.String getText()

Returns the value of this reason field as a descriptive text string.

Returns:

The reason string.

setValue

public void setValue(int v)

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

Parameters:

v - The reason code integer.

See Also:

Message.Reason

encodeReason

public static final java.lang.String encodeReason(int r)

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

Parameters:

r - The reason code integer to be encoded.

Returns:

The descriptive text reason.