biweekly.io.chain

Class ChainingTextWriter

java.lang.Object

biweekly.io.chain.ChainingTextWriter

public class ChainingTextWriter
extends Object

Chainer class for writing traditional, plain-text iCalendar objects.

Author:

Michael Angstadt

See Also:

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

Constructor Summary

Constructors

Constructor and Description
ChainingTextWriter(Collection<ICalendar> icals)

Method Summary

Modifier and Type	Method and Description
ChainingTextWriter	caretEncoding(boolean enable) Sets whether the writer will use circumflex accent encoding for parameter values (disabled by default).
ChainingTextWriter	foldLines(boolean foldLines) Sets whether to fold long lines.
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 an output stream.
void	go(Writer writer) Writes the iCalendar objects to a writer.
ChainingTextWriter	register(ICalComponentScribe<? extends ICalComponent> scribe) Registers a component scribe.
ChainingTextWriter	register(ICalPropertyScribe<? extends ICalProperty> scribe) Registers a property scribe.
ChainingTextWriter	tz(TimeZone defaultTimeZone, boolean outlookCompatible) Sets the timezone to use when outputting date values (defaults to UTC).
ChainingTextWriter	version(ICalVersion version) Sets the version that all the iCalendar objects will be marshalled to.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChainingTextWriter

public ChainingTextWriter(Collection<ICalendar> icals)

Parameters:

icals - the iCalendar objects to write

Method Detail

version

public ChainingTextWriter version(ICalVersion version)

Sets the version that all the iCalendar objects will be marshalled to. The version that is attached to each individual ICalendar object will be ignored.

If no version is passed into this method, the writer will look at the version attached to each individual ICalendar object and marshal it to that version. And if a ICalendar object has no version attached to it, then it will be marshalled to version 2.0.

Parameters:

version - the version to marshal the iCalendar objects to

Returns:

this

caretEncoding

public ChainingTextWriter caretEncoding(boolean enable)

Sets whether the writer will use circumflex accent encoding for parameter values (disabled by default). This only applies to version 2.0 iCalendar objects.

Parameters:

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

Returns:

this

See Also:

ICalWriter.setCaretEncodingEnabled(boolean), RFC 6868

foldLines

public ChainingTextWriter foldLines(boolean foldLines)

Sets whether to fold long lines. Line folding is when long lines are split up into multiple lines. No data is lost or changed when a line is folded.

Line folding is enabled by default. If the iCalendar consumer is not parsing your iCalendar objects properly, disabling line folding may help.

Parameters:

foldLines - true to enable line folding, false to disable it (defaults to true)

Returns:

this

tz

public ChainingTextWriter tz(TimeZone defaultTimeZone,
                             boolean outlookCompatible)

Sets the timezone to use when outputting date values (defaults to UTC).

This method downloads an appropriate VTIMEZONE component from the tzurl.org website.

Parameters:

defaultTimeZone - the default timezone or null for UTC

outlookCompatible - true to download a VTIMEZONE component that is tailored for Microsoft Outlook email clients, false to download a standards-based one

Returns:

this

register

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

Registers a property scribe.

Parameters:

scribe - the scribe to register

Returns:

this

register

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

Registers a component scribe.

Parameters:

scribe - the scribe to register

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 an output 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. If the file exists, it will be overwritten.

Parameters:

file - the file to write to

Throws:

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 onto the end of the file, false to overwrite it

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 writer.

Parameters:

writer - the writer to write to

Throws:

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