org.apache.poi.hssf.record
Interface CustomField

All Superinterfaces:

java.lang.Cloneable

All Known Implementing Classes:

LinkedDataFormulaField

public interface CustomField
extends java.lang.Cloneable

Method Summary

int	fillField(RecordInputStream in) Populates this fields data from the byte array passed in.
int	getSize()
int	serializeField(int offset, byte[] data) Converts this field to it's byte array form.
void	toString(java.lang.StringBuffer str) Appends the string representation of this field to the supplied StringBuffer.

Method Detail

getSize

int getSize()

Returns:

The size of this field in bytes. This operation is not valid until after the call to fillField()

fillField

int fillField(RecordInputStream in)

Populates this fields data from the byte array passed in.

Parameters:

in - the RecordInputstream to read the record from

toString

void toString(java.lang.StringBuffer str)

Appends the string representation of this field to the supplied StringBuffer.

Parameters:

str - The string buffer to append to.

serializeField

int serializeField(int offset,
                   byte[] data)

Converts this field to it's byte array form.

Parameters:

offset - The offset into the byte array to start writing to.

data - The data array to write to.

Returns:

The number of bytes written.