Package com.igormaznitsa.jbbp.utils

Class JBBPTextWriterExtraAdapter

java.lang.Object

com.igormaznitsa.jbbp.utils.JBBPTextWriterExtraAdapter

All Implemented Interfaces:

JBBPTextWriter.Extra

public abstract class JBBPTextWriterExtraAdapter
extends Object
implements JBBPTextWriter.Extra

Auxiliary adapter for interface JBBPTextWriter.Extra.

Since:

1.1

See Also:

• JBBPTextWriter.Extra

Constructor Summary

Constructors

Constructor	Description
JBBPTextWriterExtraAdapter()

Method Summary

Modifier and Type	Method	Description
String	doConvertByteToStr(JBBPTextWriter context, int value)	Convert byte to string representation.
String	doConvertCustomField(JBBPTextWriter context, Object obj, Field field, Bin annotation)	Convert a custom field into string.
String	doConvertDoubleToStr(JBBPTextWriter context, double value)	Convert double value to string representation.
String	doConvertFloatToStr(JBBPTextWriter context, float value)	Convert float value to string representation.
String	doConvertIntToStr(JBBPTextWriter context, int value)	Convert integer value to string representation.
String	doConvertLongToStr(JBBPTextWriter context, long value)	Convert long value to string representation.
String	doConvertObjToStr(JBBPTextWriter context, int id, Object obj)	Convert an object to its string representation.
String	doConvertShortToStr(JBBPTextWriter context, int value)	Convert short to string representation.
String	doConvertUIntToStr(JBBPTextWriter context, int value)	Convert unsigned integer value to string representation.
void	onBeforeFirstValue(JBBPTextWriter context)	Notification about print of the first value on the line.
void	onClose(JBBPTextWriter context)	Notification about close
void	onNewLine(JBBPTextWriter context, int lineNumber)	Notification about the start new line.
void	onReachedMaxValueNumberForLine(JBBPTextWriter context)	Notification that reached defined maximal number of values per string line.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JBBPTextWriterExtraAdapter

public JBBPTextWriterExtraAdapter()

Method Details

onNewLine

public void onNewLine(JBBPTextWriter context,
 int lineNumber)
               throws IOException

Description copied from interface: JBBPTextWriter.Extra

Notification about the start new line.

Specified by:

onNewLine in interface JBBPTextWriter.Extra

Parameters:

context - the context, must not be null

lineNumber - the current line number (0 is the first one)

Throws:

IOException - it can be thrown for transport error

onBeforeFirstValue

public void onBeforeFirstValue(JBBPTextWriter context)
                        throws IOException

Description copied from interface: JBBPTextWriter.Extra

Notification about print of the first value on the line.

Specified by:

onBeforeFirstValue in interface JBBPTextWriter.Extra

Parameters:

context - the context, must not be null

Throws:

IOException - it can be thrown for transport error

onClose

public void onClose(JBBPTextWriter context)
             throws IOException

Description copied from interface: JBBPTextWriter.Extra

Notification about close

Specified by:

onClose in interface JBBPTextWriter.Extra

Parameters:

context - the context, must not be null

Throws:

IOException - it can be thrown for transport error

doConvertByteToStr

public String doConvertByteToStr(JBBPTextWriter context,
 int value)
                          throws IOException

Description copied from interface: JBBPTextWriter.Extra

Convert byte to string representation.

Specified by:

doConvertByteToStr in interface JBBPTextWriter.Extra

Parameters:

context - the context, must not be null

value - the unsigned byte value to be converted

Returns:

string representation of the byte value, must not return null

Throws:

IOException - it can be thrown for transport error

doConvertShortToStr

public String doConvertShortToStr(JBBPTextWriter context,
 int value)
                           throws IOException

Description copied from interface: JBBPTextWriter.Extra

Convert short to string representation.

Specified by:

doConvertShortToStr in interface JBBPTextWriter.Extra

Parameters:

context - the context, must not be null

value - the unsigned short value to be converted

Returns:

string representation of the short value, must not return null

Throws:

IOException - it can be thrown for transport error

doConvertFloatToStr

public String doConvertFloatToStr(JBBPTextWriter context,
 float value)
                           throws IOException

Description copied from interface: JBBPTextWriter.Extra

Convert float value to string representation.

Specified by:

doConvertFloatToStr in interface JBBPTextWriter.Extra

Parameters:

context - the context, must not be null

value - the float value to be converted

Returns:

string representation of the float value, must not return null

Throws:

IOException - it can be thrown for transport error

doConvertDoubleToStr

public String doConvertDoubleToStr(JBBPTextWriter context,
 double value)
                            throws IOException

Description copied from interface: JBBPTextWriter.Extra

Convert double value to string representation.

Specified by:

doConvertDoubleToStr in interface JBBPTextWriter.Extra

Parameters:

context - the context, must not be null

value - the double value to be converted

Returns:

string representation of the double value, must not return null

Throws:

IOException - it can be thrown for transport error

doConvertIntToStr

public String doConvertIntToStr(JBBPTextWriter context,
 int value)
                         throws IOException

Description copied from interface: JBBPTextWriter.Extra

Convert integer value to string representation.

Specified by:

doConvertIntToStr in interface JBBPTextWriter.Extra

Parameters:

context - the context, must not be null

value - the integer value to be converted

Returns:

string representation of the integer value, must not return null

Throws:

IOException - it can be thrown for transport error

doConvertLongToStr

public String doConvertLongToStr(JBBPTextWriter context,
 long value)
                          throws IOException

Description copied from interface: JBBPTextWriter.Extra

Convert long value to string representation.

Specified by:

doConvertLongToStr in interface JBBPTextWriter.Extra

Parameters:

context - the context, must not be null

value - the long value to be converted

Returns:

string representation of the long value, must not return null

Throws:

IOException - it can be thrown for transport error

doConvertObjToStr

public String doConvertObjToStr(JBBPTextWriter context,
 int id,
 Object obj)
                         throws IOException

Description copied from interface: JBBPTextWriter.Extra

Convert an object to its string representation.

Specified by:

doConvertObjToStr in interface JBBPTextWriter.Extra

Parameters:

context - the context, must not be null

id - an optional object id

obj - an object to be converted into string, must not be null

Returns:

string representation of the object

Throws:

IOException - it can be thrown for transport error

doConvertCustomField

public String doConvertCustomField(JBBPTextWriter context,
 Object obj,
 Field field,
 Bin annotation)
                            throws IOException

Description copied from interface: JBBPTextWriter.Extra

Convert a custom field into string.

Specified by:

doConvertCustomField in interface JBBPTextWriter.Extra

Parameters:

context - the context, must not be null

obj - an object instance which field must be converted into string, must not be null

field - the field of the object which must be converted, must not be null

annotation - the bin annotation for the field, must not be null

Returns:

the text representation of the field or null if to not print anything

Throws:

IOException - it will be thrown for transport error

onReachedMaxValueNumberForLine

public void onReachedMaxValueNumberForLine(JBBPTextWriter context)
                                    throws IOException

Description copied from interface: JBBPTextWriter.Extra

Notification that reached defined maximal number of values per string line.

Specified by:

onReachedMaxValueNumberForLine in interface JBBPTextWriter.Extra

Parameters:

context - the context, must not be null

Throws:

IOException - it can be thrown for transport error

doConvertUIntToStr

public String doConvertUIntToStr(JBBPTextWriter context,
 int value)
                          throws IOException

Description copied from interface: JBBPTextWriter.Extra

Convert unsigned integer value to string representation.

Specified by:

doConvertUIntToStr in interface JBBPTextWriter.Extra

Parameters:

context - the context, must not be null

value - the unsigned integer value to be converted

Returns:

string representation of the integer value, must not return null

Throws:

IOException - it can be thrown for transport error