biweekly
Class Biweekly.WriterChainTextSingle

java.lang.Object
  biweekly.Biweekly.WriterChainTextSingle

Enclosing class:

Biweekly

public static class Biweekly.WriterChainTextSingle
extends Object

Chainer class for writing to plain text iCalendar data streams.

See Also:

Biweekly.write(ICalendar)

Method Summary

Biweekly.WriterChainTextSingle	caretEncoding(boolean enable) Sets whether the writer will apply circumflex accent encoding on parameter values (disabled by default).
String	go() Writes the iCalendar objects to a string.
void	go(File file) Writes the iCalendar objects to a file.
void	go(OutputStream out) Writes the iCalendar objects to a data stream.
void	go(Writer writer) Writes the iCalendar objects to a data stream.
Biweekly.WriterChainTextSingle	register(ICalComponentMarshaller<? extends ICalComponent> marshaller) Registers a component marshaller.
Biweekly.WriterChainTextSingle	register(ICalPropertyMarshaller<? extends ICalProperty> marshaller) Registers a property marshaller.
Biweekly.WriterChainTextSingle	warnings(List<String> warnings) Provides a list for putting the parser warnings into.

Methods inherited from class java.lang.Object

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

Method Detail

caretEncoding

public Biweekly.WriterChainTextSingle caretEncoding(boolean enable)

Sets whether the writer will apply circumflex accent encoding on parameter values (disabled by default). This escaping mechanism allows for newlines and double quotes to be included in parameter values.

When disabled, the writer will replace newlines with spaces and double quotes with single quotes.

Parameters:

enable - true to use circumflex accent encoding, false not to

See Also:

ICalRawWriter.setCaretEncodingEnabled(boolean)

warnings

public Biweekly.WriterChainTextSingle warnings(List<String> warnings)

Provides a list for putting the parser warnings into.

Parameters:

warnings - the list object to populate

Returns:

this

register

public Biweekly.WriterChainTextSingle register(ICalPropertyMarshaller<? extends ICalProperty> marshaller)

Registers a property marshaller.

Parameters:

marshaller - the marshaller

Returns:

this

register

public Biweekly.WriterChainTextSingle register(ICalComponentMarshaller<? extends ICalComponent> marshaller)

Registers a component marshaller.

Parameters:

marshaller - the marshaller

Returns:

this

go

public String go()

Writes the iCalendar objects to a string.

Returns:

the iCalendar string

go

public void go(OutputStream out)
        throws IOException

Writes the iCalendar objects to a data stream.

Parameters:

out - the output stream to write to

Throws:

IOException - if there's a problem writing to the output stream

go

public void go(File file)
        throws IOException

Writes the iCalendar objects to a file.

Parameters:

file - the file to write to

Throws:

IOException - if there's a problem writing to the file

go

public void go(Writer writer)
        throws IOException

Writes the iCalendar objects to a data stream.

Parameters:

writer - the writer to write to

Throws:

IOException - if there's a problem writing to the writer