com.crankuptheamps.client.fields

Class OptionsField

java.lang.Object

com.crankuptheamps.client.fields.Field

com.crankuptheamps.client.fields.StringField

com.crankuptheamps.client.fields.OptionsField

public class OptionsField
extends StringField

Field data for a Message which consists of options. These options represent the possible values for message options in an AMPS command.

Field Summary

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

LATIN1, LATIN1_ZERO

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

buffer, length, position

Constructor Summary

Constructors

Modifier	Constructor and Description
	OptionsField() Initializes a new instance of the OptionsField class.
protected	OptionsField(byte[] buffer, int position, int length) Initializes a new instance of the OptionsField class with the specified buffer, position, and length.
	OptionsField(java.lang.String value) Initializes a new instance of the OptionsField class with the specified value.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Implementation for Object.equals(java.lang.Object) for an OptionsField.
boolean	getValue(java.nio.ByteBuffer v) Retrieves the value of this OptionsField as a byte buffer.
java.lang.String	getValue(java.nio.charset.CharsetDecoder decoder) Retrieves the value of this OptionsField as a string using the specified charset decoder.
int	hashCode() Implementation of Object.hashCode() for an OptionsField.
void	setValue(byte[] v, int offset, int length) Sets the value of this OptionsField using the specified byte array, offset, and length.
void	setValue(java.lang.String v, java.nio.charset.CharsetEncoder encoder) Sets the value of this OptionsField using the specified string value and charset encoder.

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

getConversionBufInitialSize, getValue, setValue

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionsField

protected OptionsField(byte[] buffer,
                       int position,
                       int length)

Initializes a new instance of the OptionsField class with the specified buffer, position, and length.

Parameters:

buffer - The byte array buffer containing the options.

position - The starting position of the options within the buffer.

length - The length of the options.

OptionsField

public OptionsField(java.lang.String value)

Initializes a new instance of the OptionsField class with the specified value.

Parameters:

value - The string value representing the options.

OptionsField

public OptionsField()

Initializes a new instance of the OptionsField class.

Method Detail

setValue

public void setValue(byte[] v,
                     int offset,
                     int length)

Sets the value of this OptionsField using the specified byte array, offset, and length. Trailing commas are handled appropriately.

Overrides:

setValue in class StringField

Parameters:

v - The byte array containing the value to set.

offset - The starting offset in the byte array.

length - The length of the value to set.

setValue

public void setValue(java.lang.String v,
                     java.nio.charset.CharsetEncoder encoder)

Sets the value of this OptionsField using the specified string value and charset encoder. Trailing commas are handled appropriately.

Overrides:

setValue in class StringField

Parameters:

v - The string value to set.

encoder - The charset encoder to use.

getValue

public java.lang.String getValue(java.nio.charset.CharsetDecoder decoder)

Retrieves the value of this OptionsField as a string using the specified charset decoder. Trailing commas are handled appropriately.

Overrides:

getValue in class StringField

Parameters:

decoder - The charset decoder to use.

Returns:

The string value of this OptionsField.

getValue

public boolean getValue(java.nio.ByteBuffer v)

Retrieves the value of this OptionsField as a byte buffer. Trailing commas are handled appropriately.

Overrides:

getValue in class StringField

Parameters:

v - The byte buffer to store the value.

Returns:

True if the value was successfully retrieved, false otherwise.

equals

public boolean equals(java.lang.Object obj)

Implementation for Object.equals(java.lang.Object) for an OptionsField. For two OptionsFields to be considered equal, their values must have the same length and all bytes in the value must be equal, other than a possible trailing comma.

Overrides:

equals in class Field

Parameters:

obj - The object to compare this with.

Returns:

True if the objects are equal, otherwise false.

hashCode

public int hashCode()

Implementation of Object.hashCode() for an OptionsField.

Overrides:

hashCode in class Field