danbikel.switchboard
Class TextObjectWriterFactory

java.lang.Object
  danbikel.switchboard.TextObjectWriterFactory

All Implemented Interfaces:

ObjectWriterFactory

public class TextObjectWriterFactory
extends Object
implements ObjectWriterFactory

A factory for returning TextObjectWriter objects. This factory is provided as a convenient output mechanism to complement custom ObjectReader factories that are using character-based input.

See Also:

TextObjectWriter

Constructor Summary

TextObjectWriterFactory()
Constructs a new TextObjectWriterFactory.

Method Summary

ObjectWriter	get(OutputStream os, boolean append, boolean emptyFile) Returns a newly-constructed ObjectWriter using the specified stream.
ObjectWriter	get(OutputStream os, String encoding, int bufSize, boolean append, boolean emptyFile) Returns a newly-constructed ObjectWriter using the specified stream.
ObjectWriter	get(String filename, String encoding, int bufSize, boolean append) Returns a newly-constructed ObjectWriter using the specified stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextObjectWriterFactory

public TextObjectWriterFactory()

Constructs a new TextObjectWriterFactory.

Method Detail

get

public ObjectWriter get(OutputStream os,
                        boolean append,
                        boolean emptyFile)
                 throws IOException

Description copied from interface: ObjectWriterFactory

Returns a newly-constructed ObjectWriter using the specified stream. The two final arguments, append and emptyFile, should be used to determine whether stream header information needs to be written (by stream implementations that use headers, such as ObjectOutputStream).

Specified by:

get in interface ObjectWriterFactory

Parameters:

os - the output stream around which to build an ObjectWriter

append - if true, indicates that the output stream belongs to a file that is being appended to

emptyFile - indicates whether the underlying file (if there is one) for the output stream is currently empty

Throws:

IOException

get

public ObjectWriter get(OutputStream os,
                        String encoding,
                        int bufSize,
                        boolean append,
                        boolean emptyFile)
                 throws IOException

Description copied from interface: ObjectWriterFactory

Returns a newly-constructed ObjectWriter using the specified stream. If the underlying writer is character-based, the encoding argument will be used; otherwise, it will be ignored. The bufSize argument should be used by ObjectWriter implementations for construction of a buffered stream or Writer. The two final arguments, append and emptyFile, should be used to determine whether stream header information needs to be written (by stream implementations that use headers, such as ObjectOutputStream).

Specified by:

get in interface ObjectWriterFactory

Parameters:

os - the output stream around which to build an ObjectWriter

encoding - the character encoding to be used (ignored if the ObjectWriter implementor returned by this factory is not character-based)

bufSize - the suggested buffer size to be used by ObjectWriter objects returned by this factory

append - if true, indicates that the output stream belongs to a file that is being appended to

emptyFile - indicates whether the underlying file (if there is one) for the output stream is currently empty

Throws:

IOException

get

public ObjectWriter get(String filename,
                        String encoding,
                        int bufSize,
                        boolean append)
                 throws IOException

Description copied from interface: ObjectWriterFactory

Returns a newly-constructed ObjectWriter using the specified stream. If the underlying writer is character-based, the encoding argument will be used; otherwise, it will be ignored. The bufSize argument should be used by ObjectWriter implementations for construction of a buffered stream or Writer.

Specified by:

get in interface ObjectWriterFactory

Parameters:

filename - the name of an output file around which to build an ObjectWriter

encoding - the character encoding to be used (ignored if the ObjectWriter implementor returned by this factory is not character-based)

bufSize - the suggested buffer size to be used by ObjectWriter objects returned by this factory

append - indicates whether to append to the opened file

Throws:

IOException