biweekly

Class Biweekly.WriterChainText

java.lang.Object

biweekly.Biweekly.WriterChainText

Enclosing class:

Biweekly

public static class Biweekly.WriterChainText
extends Object

Chainer class for writing to plain text iCalendar data streams.

See Also:

Biweekly.write(Collection), Biweekly.write(ICalendar...)

Method Summary

Methods

Modifier and Type	Method and Description
Biweekly.WriterChainText	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(File file, boolean append) 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.
T	register(ICalComponentScribe<? extends ICalComponent> scribe) Registers a component scribe.
T	register(ICalPropertyScribe<? extends ICalProperty> scribe) Registers a property scribe.
Biweekly.WriterChainText	version(ICalVersion version) Sets the iCal version to adhere to when writing (defaults to 2.0).

Methods inherited from class java.lang.Object

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

Method Detail

caretEncoding

public Biweekly.WriterChainText 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

Returns:

this

See Also:

ICalRawWriter.setCaretEncodingEnabled(boolean)

version

public Biweekly.WriterChainText version(ICalVersion version)

Sets the iCal version to adhere to when writing (defaults to 2.0).

Parameters:

version - the version

Returns:

this

go

public String go()

Writes the iCalendar objects to a string.

Returns:

the iCalendar string

Throws:

IllegalArgumentException - if the scribe class for a component or property object cannot be found (only happens when an experimental property/component scribe is not registered with the register method.)

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:

IllegalArgumentException - if the scribe class for a component or property object cannot be found (only happens when an experimental property/component scribe is not registered with the register method.)

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:

IllegalArgumentException - if the scribe class for a component or property object cannot be found (only happens when an experimental property/component scribe is not registered with the register method.)

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

go

public void go(File file,
      boolean append)
        throws IOException

Writes the iCalendar objects to a file.

Parameters:

file - the file to write to

append - true to append to the end of the file, false to overwrite it

Throws:

IllegalArgumentException - if the scribe class for a component or property object cannot be found (only happens when an experimental property/component scribe is not registered with the register method.)

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:

IllegalArgumentException - if the scribe class for a component or property object cannot be found (only happens when an experimental property/component scribe is not registered with the register method.)

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

register

public T register(ICalPropertyScribe<? extends ICalProperty> scribe)

Registers a property scribe.

Parameters:

scribe - the scribe

Returns:

this

register

public T register(ICalComponentScribe<? extends ICalComponent> scribe)

Registers a component scribe.

Parameters:

scribe - the scribe

Returns:

this