com.crankuptheamps.client.fields

Class StringField

java.lang.Object

com.crankuptheamps.client.fields.Field

com.crankuptheamps.client.fields.StringField

Direct Known Subclasses:

BookmarkField, OptionsField

public class StringField
extends Field

Field data for a Message which consists of a string.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	LATIN1
protected static byte	LATIN1_ZERO

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

buffer, length, position

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected int	getConversionBufInitialSize() Returns the initial default size for the byte and char conversion buffers used by this instance.
boolean	getValue(java.nio.ByteBuffer v) Writes the byte value of this instance into the specified byte buffer, if the value is not null.
java.lang.String	getValue(java.nio.charset.CharsetDecoder decoder) Returns a string representation of the Field value, where the bytes are interpreted by using the specified decoder.
boolean	getValue(CommandId v) Writes the byte value of this instance into the specified command ID buffer object, if the value is not null.
void	setValue(byte[] v, int offset, int length) Sets the value of this instance with the specified region of a byte buffer.
void	setValue(CommandId v) Sets the value of this instance with the specified buffer from the command ID object.
void	setValue(java.lang.String v, java.nio.charset.CharsetEncoder encoder) Sets the value of this instance from the specified string.

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.lang.String LATIN1

See Also:

Constant Field Values

LATIN1_ZERO

protected static final byte LATIN1_ZERO

See Also:

Constant Field Values

Constructor Detail

StringField

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

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

Parameters:

buffer - The byte array buffer containing the string data.

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

length - The length of the string.

StringField

public StringField()

Default constructor.

StringField

public StringField(java.lang.String value)

Initializes a new instance of the StringField class with the specified string value.

Parameters:

value - The string value to initialize the StringField with.

Method Detail

getConversionBufInitialSize

protected int getConversionBufInitialSize()

Returns the initial default size for the byte and char conversion buffers used by this instance. Defaults to 256 for this class.

Returns:

Returns a default size of 256.

getValue

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

Returns a string representation of the Field value, where the bytes are interpreted by using the specified decoder.

Parameters:

decoder - The charset decoder used to interpret bytes as characters.

Returns:

a newly-constructed String representing the value of this field

getValue

public boolean getValue(java.nio.ByteBuffer v)

Writes the byte value of this instance into the specified byte buffer, if the value is not null.

Parameters:

v - The byte buffer to write in to.

Returns:

Return true if this instance is not null, otherwise false.

getValue

public boolean getValue(CommandId v)

Writes the byte value of this instance into the specified command ID buffer object, if the value is not null.

Parameters:

v - The command ID object to write in to.

Returns:

Return true if this instance is not null, otherwise false.

setValue

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

Sets the value of this instance with the specified region of a byte buffer. Note: the bytes are not copied from the buffer. The specified buffer region is referenced by this instance.

Parameters:

v - The byte buffer.

offset - The starting position of the value in the byte buffer.

length - The length from the starting position of the value in the byte buffer.

setValue

public void setValue(CommandId v)

Sets the value of this instance with the specified buffer from the command ID object. Note: the bytes are not copied from the buffer. The specified buffer region is referenced by this instance.

Parameters:

v - The command ID object whose value is used to set this instance.

setValue

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

Sets the value of this instance from the specified string. The characters of the string are interpreted using the specified encoder. This method makes its own copy of the bytes.

Parameters:

v - The string used as the value.

encoder - The encoder used to interpret the string's characters as bytes.