org.semarglproject.sink

Class CharOutputSink

java.lang.Object

org.semarglproject.sink.CharOutputSink

All Implemented Interfaces:

CharSink, DataSink

public final class CharOutputSink
extends Object
implements CharSink

Implementation of CharSink. Provides bridging to Java IO APIs (Writer, OutputStream, File).

Constructor Summary

Constructors

Constructor and Description
CharOutputSink() Creates class instance with default charset encoding..
CharOutputSink(Charset charset) Creates class instance with specified charset encoding.
CharOutputSink(String charsetName) Creates class instance with specified charset name.

Method Summary

Methods

Modifier and Type	Method and Description
void	connect(File file) Redirects output to specified file
void	connect(OutputStream outputStream) Redirects output to specified stream
void	connect(Writer writer) Redirects output to specified writer
void	endStream() Callback for end stream event.
CharOutputSink	process(char ch) Callback for char processing
CharOutputSink	process(char[] buffer, int start, int count) Callback for buffer processing
CharOutputSink	process(String str) Callback for string processing
void	setBaseUri(String baseUri) Sets document base URI.
boolean	setProperty(String key, Object value) Key-value based settings.
void	startStream() Callback for start stream event.

Methods inherited from class java.lang.Object

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

Constructor Detail

CharOutputSink

public CharOutputSink()

Creates class instance with default charset encoding..

CharOutputSink

public CharOutputSink(Charset charset)

Creates class instance with specified charset encoding.

Parameters:

charset - charset

CharOutputSink

public CharOutputSink(String charsetName)

Creates class instance with specified charset name.

Parameters:

charsetName - charset name

Method Detail

connect

public void connect(File file)

Redirects output to specified file

Parameters:

file - output file

connect

public void connect(Writer writer)

Redirects output to specified writer

Parameters:

writer - output writer

connect

public void connect(OutputStream outputStream)

Redirects output to specified stream

Parameters:

outputStream - output stream

process

public CharOutputSink process(String str)
                       throws ParseException

Description copied from interface: CharSink

Callback for string processing

Specified by:

process in interface CharSink

Parameters:

str - string for processing

Throws:

ParseException

process

public CharOutputSink process(char ch)
                       throws ParseException

Description copied from interface: CharSink

Callback for char processing

Specified by:

process in interface CharSink

Parameters:

ch - char for processing

Throws:

ParseException

process

public CharOutputSink process(char[] buffer,
                     int start,
                     int count)
                       throws ParseException

Description copied from interface: CharSink

Callback for buffer processing

Specified by:

process in interface CharSink

Parameters:

buffer - char buffer for processing

start - position to start

count - count of chars to process

Throws:

ParseException

setBaseUri

public void setBaseUri(String baseUri)

Description copied from interface: DataSink

Sets document base URI. Must be called befor start stream event.

Specified by:

setBaseUri in interface DataSink

Parameters:

baseUri - base URI

startStream

public void startStream()
                 throws ParseException

Description copied from interface: DataSink

Callback for start stream event.

Specified by:

startStream in interface DataSink

Throws:

ParseException

endStream

public void endStream()
               throws ParseException

Description copied from interface: DataSink

Callback for end stream event.

Specified by:

endStream in interface DataSink

Throws:

ParseException

setProperty

public boolean setProperty(String key,
                  Object value)

Description copied from interface: DataSink

Key-value based settings. Property settings are passed to child sinks.

Specified by:

setProperty in interface DataSink

Parameters:

key - property key

value - property value

Returns:

true if at least one sink understands specified property, false otherwise