org.thales.punch.libraries.punchlang.api

Interface IResourceBuilder

All Known Implementing Classes:

AbstractCsvLineResourceBuilder, AbstractCsvResourceBuilder, AbstractJsonResourceBuilder, CidrRangeOperator, CsvToArrayResourceBuilder, CsvToMapInPlaceResourceBuilder, CsvToMapResourceBuilder, CsvToTuple, IpRangeOperator, JsonToMapInPlaceResourceBuilder, JsonToMapResourceBuilder, JsonToTuple, JsonToTupleResourceBuilder, SimpleResourceBuilder

public interface IResourceBuilder

Utility interface to build useful in memory structures from remote resource files.

Implement this whenever you need to transform a string content into a tuple, map or anything useful according to some decoding strategy.

Watch out : this builder assume resource files are composed of several lines.

Author:

dimi

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IResourceBuilder.CompactionType very large resource files are common.

Method Summary

Modifier and Type	Method and Description
Tuple	onEnd() Callback that tells you the scan is done.
void	onStart() Callback to tell you you are about to receive new lines.
void	onStream(Reader inputStream) Callback for you to stream the remote resource file.
default void	prepare(org.thales.punch.settings.api.ISettingsMap settings) An optional callback to prepare you builder with additional parameters.

Method Detail

onStart

void onStart()

Callback to tell you you are about to receive new lines.

Parameters:

c - the compaction mode requested by the caller.

onStream

void onStream(Reader inputStream)
       throws IOException

Callback for you to stream the remote resource file.

Parameters:

inputStream - the input stream to consume the resource file

Throws:

IOException - in case of IO error

onEnd

Tuple onEnd()

Callback that tells you the scan is done. You can safely terminate and return the building of your resource.

You should typically free any temporary storage, if any, used to build your resource.

Returns:

the built resource.

prepare

default void prepare(org.thales.punch.settings.api.ISettingsMap settings)

An optional callback to prepare you builder with additional parameters.

Parameters:

settings -