de.undercouch.actson

Interface JsonFeeder

All Known Implementing Classes:

DefaultJsonFeeder

public interface JsonFeeder

A feeder can be used to provide more input data to the JsonParser. The caller has to take care to only feed as much data as the parser can process at the time. Use isFull() to determine if the parser accepts more data. Then call feed(byte) or feed(byte[], int, int) until there is no more data to feed or until isFull() returns true. Next call JsonParser.nextEvent() until it returns JsonEvent.NEED_MORE_INPUT. Repeat feeding and parsing until all input data has been consumed. Finally, call done() to indicate the end of the JSON text.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
void	done() Call this method to indicate that the end of the JSON text has been reached and that there is no more input to parse.
void	feed(byte b) Provide more data to the JsonParser.
int	feed(byte[] buf) Provide more data to the JsonParser.
int	feed(byte[] buf, int offset, int len) Provide more data to the JsonParser.
boolean	hasInput() Determine if the feeder has input data that can be parsed
boolean	isDone() Check if the end of the JSON text has been reached
boolean	isFull() Checks if the parser accepts more input at the moment.
char	nextInput() Decode and return the next character to be parsed

Method Detail

feed

void feed(byte b)

Provide more data to the JsonParser. Should only be called if isFull() returns false.

Parameters:

b - the byte to provide as input to the parser

Throws:

java.lang.IllegalStateException - if the parser does not accept more input at the moment (see isFull())

feed

int feed(byte[] buf)

Provide more data to the JsonParser. The method will consume as many bytes from the input buffer as possible, either until all bytes have been consumed or until the feeder is full (see isFull()). The method will return the number of bytes consumed (which can be 0 if the parser does not accept more input at the moment).

Parameters:

buf - the byte array containing the data to consume

Returns:

the number of bytes consumed (can be 0 if the parser does not accept more input at the moment, see isFull())

feed

int feed(byte[] buf,
         int offset,
         int len)

Provide more data to the JsonParser. The method will consume as many bytes from the input buffer as possible, either until len bytes have been consumed or until the feeder is full (see isFull()). The method will return the number of bytes consumed (which can be 0 if the parser does not accept more input at the moment).

Parameters:

buf - the byte array containing the data to consume

offset - the start offset in the byte array

len - the number of bytes to consume

Returns:

the number of bytes consumed (can be 0 if the parser does not accept more input at the moment, see isFull())

isFull

boolean isFull()

Checks if the parser accepts more input at the moment. If it doesn't, you have to call JsonParser.nextEvent() until it returns JsonEvent.NEED_MORE_INPUT. Only then new input can be provided to the parser.

Returns:

true if the parser does not accept more input

done

void done()

Call this method to indicate that the end of the JSON text has been reached and that there is no more input to parse.

hasInput

boolean hasInput()
          throws java.nio.charset.CharacterCodingException

Determine if the feeder has input data that can be parsed

Returns:

true if the feeder has more input to be parsed

Throws:

java.nio.charset.CharacterCodingException - if the input data contains invalid characters

isDone

boolean isDone()
        throws java.nio.charset.CharacterCodingException

Check if the end of the JSON text has been reached

Returns:

true if the end of input has been reached

Throws:

java.nio.charset.CharacterCodingException - if the input data contains invalid characters

nextInput

char nextInput()
        throws java.nio.charset.CharacterCodingException

Decode and return the next character to be parsed

Returns:

the next character to be parsed

Throws:

java.lang.IllegalStateException - if there is no input to parse

java.nio.charset.CharacterCodingException - if the input data contains invalid characters