org.fudgemsg.types
Class StringFieldType

java.lang.Object
  org.fudgemsg.FudgeFieldType<String>
      org.fudgemsg.types.StringFieldType

All Implemented Interfaces:

Serializable

public class StringFieldType
extends FudgeFieldType<String>

The type definition for a Modified UTF-8 encoded string.

See Also:

Serialized Form

Field Summary

static StringFieldType

INSTANCE Standard Fudge field type: string.

Method Summary

int	getVariableSize(String value, FudgeTaxonomy taxonomy) Gets the number of bytes used to encode a value.
String	readValue(DataInput input, int dataSize) Reads a value of this type to the output.
void	writeValue(DataOutput output, String value) Writes a value of this type to the output.

Methods inherited from class org.fudgemsg.FudgeFieldType

equals, getFixedSize, getJavaType, getTypeId, hashCode, isVariableSize, toString

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final StringFieldType INSTANCE

Standard Fudge field type: string. See FudgeTypeDictionary.STRING_TYPE_ID.

Method Detail

getVariableSize

public int getVariableSize(String value,
                           FudgeTaxonomy taxonomy)

Gets the number of bytes used to encode a value.

A variable width type must override this method. A fixed width type will return the fixed size.

Overrides:

getVariableSize in class FudgeFieldType<String>

Parameters:

value - the value to check, not used for fixed width types

taxonomy - the taxonomy being used for the encoding, not used for fixed width types

Returns:

the size in bytes

readValue

public String readValue(DataInput input,
                        int dataSize)
                 throws IOException

Reads a value of this type to the output.

This is intended for use by variable width types and must read the given value. The implementation must read exactly the number of bytes passed into the method.

Overrides:

readValue in class FudgeFieldType<String>

Parameters:

input - the input source to read the value from, not null

dataSize - the number of bytes of data to read

Returns:

the value that was read

Throws:

IOException - if an error occurs, which must be wrapped by the caller

writeValue

public void writeValue(DataOutput output,
                       String value)
                throws IOException

Writes a value of this type to the output.

This is intended for use by variable width types and must write the given value. The implementation must write exactly the number of bytes returned by the size calculation.

Overrides:

writeValue in class FudgeFieldType<String>

Parameters:

output - the output target to write the value to, not null

value - the value to write

Throws:

IOException - if an error occurs, which must be wrapped by the caller