org.thales.punch.punchlang.util

Interface ICodec<T>

All Known Implementing Classes:

JsonArrayCodec, LineCodec, MultilineCodec, XmlCodec

public interface ICodec<T>

An ICodec lets you stream continuously some data (text) stream, and truncate the data using some delimiting strategy.

The simplest is the line per line strategy.

In the two append() method, the codec must throw a 'ArrayIndexOutOfBounds' exception if the chunk size received make the current buffer exceed the maximum capacity.

Author:

jonathan

Method Summary

Modifier and Type	Method and Description
default void	append(char[] buffer, int bytesRead) Append a char array at the end of the codec.
void	append(T s) Append a new String into the codec.
default void	flush() flush buffer
List<T>	getNextItems() Check and return some (not necessary all) found items if any.
ECodec	getType()
default void	tick() Refresh the codec that require a timeout logic.

Method Detail

getType

ECodec getType()

Returns:

this codec type

getNextItems

List<T> getNextItems()

Check and return some (not necessary all) found items if any.

Returns:

the list of complete items, or an empty list if not enough data is available.

append

void append(T s)

Append a new String into the codec.

Parameters:

s - the input String

append

default void append(char[] buffer,
                    int bytesRead)

Append a char array at the end of the codec.

Parameters:

buffer - the holding buffer

bytesRead - the number of read bytes

tick

default void tick()

Refresh the codec that require a timeout logic. As of today only the multiline codec implement this to flush multiline that never receive the next new line.

flush

default void flush()

flush buffer