com.crankuptheamps.client.fields

Class CommandField

java.lang.Object

com.crankuptheamps.client.fields.Field

com.crankuptheamps.client.fields.CommandField

public class CommandField
extends Field

Field data for a Message which consists of a Command. This Command tells AMPS how to interpret the Message.

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
CommandField()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	encodeCommand(int command) This method encodes the Command.
int	getValue() This method gets the value of the Command.
void	setValue(int v) This method sets the value of the Command.

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

CommandField

public CommandField()

Method Detail

getValue

public int getValue()

This method gets the value of the Command.

Returns:

The Message.Command constant, if the buffer is not null. Otherwise Message.Command.Unknown is returned when the buffer is null.

setValue

public void setValue(int v)

This method sets the value of the Command.

Parameters:

v - The value of the Command to be set.

encodeCommand

public static final java.lang.String encodeCommand(int command)

This method encodes the Command. This method takes the integer Command and finds the corresponding string Command.

Parameters:

command - This is an integer which corresponds to a command.

Returns:

A string that represents the command.