com.crankuptheamps.client

Class CommandId

java.lang.Object

com.crankuptheamps.client.CommandId

public class CommandId
extends java.lang.Object

Used to give a unique identifier to a Command. This Id can be used to reference the command later, such as when unsubscribing a subscription command.

Field Summary

Fields

Modifier and Type	Field and Description
byte[]	id

Constructor Summary

Constructors

Constructor and Description
CommandId(byte[] buffer) Constructs a Command Id for an AMPS command, using an array of bytes as its identifier.
CommandId(byte[] buffer, int position, int length) Constructs a Command Id for an AMPS command, using an array of bytes, a position number, and a length as its identifier.
CommandId(java.lang.String string) Constructs a CommandId for an AMPS command, using a string as its identifier.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Overridden to test equality based upon object class and the CommandId value.
int	hashCode() Overridden to return a hash code that is based upon CommandId value.
static CommandId	nextIdentifier() Returns the next Id for the current command.
void	set(byte[] buffer, int position, int length) Sets the CommandId for the AMPS command.
java.lang.String	toString() Overridden to return the CommandId value as a string where each byte is interpreted as an ISO-8859-1 character.

Methods inherited from class java.lang.Object

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

Field Detail

id

public byte[] id

Constructor Detail

CommandId

public CommandId(java.lang.String string)

Constructs a CommandId for an AMPS command, using a string as its identifier.

Parameters:

string - A string used to set the new identifier for this AMPS command.

CommandId

public CommandId(byte[] buffer)

Constructs a Command Id for an AMPS command, using an array of bytes as its identifier.

Parameters:

buffer - An array of bytes used to set the new identifier for this AMPS command.

CommandId

public CommandId(byte[] buffer,
                 int position,
                 int length)

Constructs a Command Id for an AMPS command, using an array of bytes, a position number, and a length as its identifier.

Parameters:

buffer - An array of bytes used to set the new identifier for this AMPS command.

position - An integer used to represent the position that the buffer should start.

length - An integer used to determine the length of the new identifier.

Method Detail

nextIdentifier

public static CommandId nextIdentifier()

Returns the next Id for the current command.

Returns:

Next command identifier.

set

public void set(byte[] buffer,
                int position,
                int length)

Sets the CommandId for the AMPS command.

Parameters:

buffer - An array of bytes used to set the CommandId.

length - Length of the new id.

position - Position where the new CommandId should start.

equals

public boolean equals(java.lang.Object obj)

Overridden to test equality based upon object class and the CommandId value. For this to return true, the passed in instance must be an instance of CommandId and its value must be binary equal to this instance's value.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overridden to return a hash code that is based upon CommandId value.

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overridden to return the CommandId value as a string where each byte is interpreted as an ISO-8859-1 character.

Overrides:

toString in class java.lang.Object