Package de.iip_ecosphere.platform.connectors.formatter

Class TextLineFormatter

java.lang.Object

de.iip_ecosphere.platform.connectors.formatter.TextLineFormatter

All Implemented Interfaces:

OutputFormatter<String>

@MachineFormatter
public class TextLineFormatter
extends Object
implements OutputFormatter<String>

A simple text line formatter for given separators. Field names are ignored.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextLineFormatter.TextLineFormatterConverter	Own parser converter type to hide implementing class for future modifications.

Nested classes/interfaces inherited from interface de.iip_ecosphere.platform.connectors.formatter.OutputFormatter

OutputFormatter.OutputConverter<T>

Field Summary

Fields

Modifier and Type	Field	Description
private String	charset
static final TextLineFormatter.TextLineFormatterConverter	CONVERTER
private String	separator
private StringBuilder	tmp

Fields inherited from interface de.iip_ecosphere.platform.connectors.formatter.OutputFormatter

SEPARATOR

Constructor Summary

Constructors

Constructor	Description
TextLineFormatter(String charset, String separator)	Creates a new text line formatter.

Method Summary

Modifier and Type	Method	Description
void	add(String name, String data)	Adds information to one chunk of output.
byte[]	chunkCompleted()	Completes a chunk of output data.
void	endStructure()	Ends a structure started before.
TextLineFormatter.TextLineFormatterConverter	getConverter()	Returns the output converter.
void	startArrayStructure(String name)	Starts an array structure.
void	startObjectStructure(String name)	Starts an object structure.

Methods inherited from class java.lang.Object

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

Field Details

CONVERTER

public static final TextLineFormatter.TextLineFormatterConverter CONVERTER

charset

private String charset

separator

private String separator

tmp

private StringBuilder tmp

Constructor Details

TextLineFormatter

public TextLineFormatter(String charset,
 String separator)

Creates a new text line formatter.

Parameters:

charset - the charset of the text encoding (preliminary as string)

separator - the separator to be used between data fields

Method Details

add

public void add(String name,
 String data)
         throws IOException

Description copied from interface: OutputFormatter

Adds information to one chunk of output. Hierarchical names separated by OutputFormatter.SEPARATOR can be used, but nested values for the same parent (object) field must be named in sequence.

Specified by:

add in interface OutputFormatter<String>

Parameters:

name - optional data name field (may be null for none)

data - the data to be added

Throws:

IOException - if adding the data fails for some reason

chunkCompleted

public byte[] chunkCompleted()
                      throws IOException

Description copied from interface: OutputFormatter

Completes a chunk of output data.

Specified by:

chunkCompleted in interface OutputFormatter<String>

Returns:

the chunk

Throws:

IOException - if creating the chunk fails for some reason

getConverter

public TextLineFormatter.TextLineFormatterConverter getConverter()

Description copied from interface: OutputFormatter

Returns the output converter.

Specified by:

getConverter in interface OutputFormatter<String>

Returns:

the output converter

startArrayStructure

public void startArrayStructure(String name)
                         throws IOException

Description copied from interface: OutputFormatter

Starts an array structure. Following OutputFormatter.add(String, Object) calls will add elements to the array. Must be closed with OutputFormatter.endStructure()

Specified by:

startArrayStructure in interface OutputFormatter<String>

Parameters:

name - optional data name field holding the array (may be null for none)

Throws:

IOException - if starting this structure fails

startObjectStructure

public void startObjectStructure(String name)
                          throws IOException

Description copied from interface: OutputFormatter

Starts an object structure. Following OutputFormatter.add(String, Object) calls will add elements to the object. Must be closed with OutputFormatter.endStructure()

Specified by:

startObjectStructure in interface OutputFormatter<String>

Parameters:

name - optional data name field holding the array (may be null for none)

Throws:

IOException - if starting this structure fails

endStructure

public void endStructure()
                  throws IOException

Description copied from interface: OutputFormatter

Ends a structure started before.

Specified by:

endStructure in interface OutputFormatter<String>

Throws:

IOException - if ending the actual structure fails