io.vertx.core.parsetools.impl

Class RecordParserImpl

java.lang.Object

io.vertx.core.parsetools.impl.RecordParserImpl

All Implemented Interfaces:

Handler<Buffer>, RecordParser

public class RecordParserImpl
extends Object
implements RecordParser

Author:

Tim Fox, Lars Timm

Method Summary

Modifier and Type	Method and Description
void	delimitedMode(Buffer delim) Flip the parser into delimited mode, and where the delimiter can be represented by the delimiter delim.
void	delimitedMode(String delim) Flip the parser into delimited mode, and where the delimiter can be represented by the String delim encoded in latin-1 .
void	fixedSizeMode(int size) Flip the parser into fixed size mode, where the record size is specified by size in bytes.
void	handle(Buffer buffer) This method is called to provide the parser with data.
static Buffer	latin1StringToBytes(String str) Helper method to convert a latin-1 String to an array of bytes for use as a delimiter Please do not use this for non latin-1 characters
static RecordParser	newDelimited(Buffer delim, Handler<Buffer> output) Create a new RecordParser instance, initially in delimited mode, and where the delimiter can be represented by the buffer delim.
static RecordParser	newDelimited(String delim, Handler<Buffer> output) Create a new RecordParser instance, initially in delimited mode, and where the delimiter can be represented by the String delim endcoded in latin-1 .
static RecordParser	newFixed(int size, Handler<Buffer> output) Create a new RecordParser instance, initially in fixed size mode, and where the record size is specified by the size parameter.
void	setOutput(Handler<Buffer> output)

Methods inherited from class java.lang.Object

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

Method Detail

setOutput

public void setOutput(Handler<Buffer> output)

Specified by:

setOutput in interface RecordParser

latin1StringToBytes

public static Buffer latin1StringToBytes(String str)

Helper method to convert a latin-1 String to an array of bytes for use as a delimiter Please do not use this for non latin-1 characters

Parameters:

str - the string

Returns:

The byte[] form of the string

newDelimited

public static RecordParser newDelimited(String delim,
                                        Handler<Buffer> output)

Create a new RecordParser instance, initially in delimited mode, and where the delimiter can be represented by the String delim endcoded in latin-1 . Don't use this if your String contains other than latin-1 characters.

output Will receive whole records which have been parsed.

Specified by:

newDelimited in interface RecordParser

Parameters:

delim - the initial delimiter string

output - handler that will receive the output

newDelimited

public static RecordParser newDelimited(Buffer delim,
                                        Handler<Buffer> output)

Create a new RecordParser instance, initially in delimited mode, and where the delimiter can be represented by the buffer delim.

output Will receive whole records which have been parsed.

Specified by:

newDelimited in interface RecordParser

Parameters:

delim - the initial delimiter buffer

output - handler that will receive the output

newFixed

public static RecordParser newFixed(int size,
                                    Handler<Buffer> output)

Create a new RecordParser instance, initially in fixed size mode, and where the record size is specified by the size parameter.

output Will receive whole records which have been parsed.

Specified by:

newFixed in interface RecordParser

Parameters:

size - the initial record size

output - handler that will receive the output

delimitedMode

public void delimitedMode(String delim)

Flip the parser into delimited mode, and where the delimiter can be represented by the String delim encoded in latin-1 . Don't use this if your String contains other than latin-1 characters.

This method can be called multiple times with different values of delim while data is being parsed.

Specified by:

delimitedMode in interface RecordParser

Parameters:

delim - the new delimeter

delimitedMode

public void delimitedMode(Buffer delim)

Flip the parser into delimited mode, and where the delimiter can be represented by the delimiter delim.

This method can be called multiple times with different values of delim while data is being parsed.

Specified by:

delimitedMode in interface RecordParser

Parameters:

delim - the new delimiter

fixedSizeMode

public void fixedSizeMode(int size)

Flip the parser into fixed size mode, where the record size is specified by size in bytes.

This method can be called multiple times with different values of size while data is being parsed.

Specified by:

fixedSizeMode in interface RecordParser

Parameters:

size - the new record size

handle

public void handle(Buffer buffer)

This method is called to provide the parser with data.

Specified by:

handle in interface Handler<Buffer>

Specified by:

handle in interface RecordParser

Parameters:

buffer - a chunk of data