biweekly.io.text

Class ICalWriter

java.lang.Object

biweekly.io.StreamWriter

biweekly.io.text.ICalWriter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class ICalWriter
extends StreamWriter
implements Flushable

Writes ICalendar objects to an iCalendar data stream.

Example:

 List<ICalendar> icals = ... 
 OutputStream out = ...
 ICalWriter icalWriter = new ICalWriter(out, ICalVersion.V2_0);
 for (ICalendar ical : icals){
   icalWriter.write(ical);
 }
 icalWriter.close();
 

Changing the timezone settings:

 ICalWriter writer = new ICalWriter(...);
 
 //format all date/time values in a specific timezone instead of UTC
 //note: this makes an HTTP call to "http://tzurl.org"
 writer.getTimezoneInfo().setDefaultTimeZone(TimeZone.getDefault());
 
 //format the value of a single date/time property in a specific timezone instead of UTC
 //note: this makes an HTTP call to "http://tzurl.org"
 DateStart dtstart = ...
 writer.getTimezoneInfo().setTimeZone(dtstart, TimeZone.getDefault());
 
 //generate Outlook-friendly VTIMEZONE components:
 writer.getTimezoneInfo().setGenerator(new TzUrlDotOrgGenerator(true));
 

Changing the line folding settings:

 ICalWriter writer = new ICalWriter(...);
 
 //disable line folding
 writer.getRawWriter().getFoldedLineWriter().setLineLength(null);
 
 //set line length (defaults to 75)
 writer.getRawWriter().getFoldedLineWriter().setLineLength(50);
 
 //change folded line indent string (defaults to one space character)
 writer.getRawWriter().getFoldedLineWriter().setIndent("\t");
 
 //change newline character (defaults to CRLF)
 writer.getRawWriter().getFoldedLineWriter().setNewline("**");
 

Author:

Michael Angstadt

See Also:

RFC 5545

Field Summary

Fields inherited from class biweekly.io.StreamWriter

context, index, tzinfo

Constructor Summary

Constructors

Constructor and Description
ICalWriter(File file, boolean append, ICalVersion version) Creates an iCalendar writer that writes to a file.
ICalWriter(File file, ICalVersion version) Creates an iCalendar writer that writes to a file.
ICalWriter(OutputStream outputStream, ICalVersion version) Creates an iCalendar writer that writes to an output stream.
ICalWriter(Writer writer, ICalVersion version) Creates an iCalendar writer that writes to a writer.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	_write(ICalendar ical) Writes an iCalendar object to the data stream.
void	close() Closes the underlying Writer object.
void	flush() Flushes the stream.
ICalRawWriter	getRawWriter() Gets the writer object that is used internally to write to the output stream.
ICalVersion	getTargetVersion() Gets the version that the written iCalendar objects will adhere to.
boolean	isCaretEncodingEnabled() Gets whether the writer will apply circumflex accent encoding on parameter values (disabled by default).
void	setCaretEncodingEnabled(boolean enable) Sets whether the writer will apply circumflex accent encoding on parameter values (disabled by default).
void	setTargetVersion(ICalVersion targetVersion) Sets the version that the written iCalendar objects will adhere to.

Methods inherited from class biweekly.io.StreamWriter

getScribeIndex, getTimezoneInfo, registerScribe, registerScribe, setScribeIndex, setTimezoneInfo, write

Methods inherited from class java.lang.Object

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

Constructor Detail

ICalWriter

public ICalWriter(OutputStream outputStream,
          ICalVersion version)

Creates an iCalendar writer that writes to an output stream.

Parameters:

outputStream - the output stream to write to

version - the iCalendar version to adhere to

ICalWriter

public ICalWriter(File file,
          ICalVersion version)
           throws IOException

Creates an iCalendar writer that writes to a file.

Parameters:

file - the file to write to

version - the iCalendar version to adhere to

Throws:

IOException - if the file cannot be written to

ICalWriter

public ICalWriter(File file,
          boolean append,
          ICalVersion version)
           throws IOException

Creates an iCalendar writer that writes to a file.

Parameters:

file - the file to write to

version - the iCalendar version to adhere to

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

Throws:

IOException - if the file cannot be written to

ICalWriter

public ICalWriter(Writer writer,
          ICalVersion version)

Creates an iCalendar writer that writes to a writer.

Parameters:

writer - the output stream to write to

version - the iCalendar version to adhere to

Method Detail

getRawWriter

public ICalRawWriter getRawWriter()

Gets the writer object that is used internally to write to the output stream.

Returns:

the raw writer

getTargetVersion

public ICalVersion getTargetVersion()

Gets the version that the written iCalendar objects will adhere to.

Specified by:

getTargetVersion in class StreamWriter

Returns:

the iCalendar version

setTargetVersion

public void setTargetVersion(ICalVersion targetVersion)

Sets the version that the written iCalendar objects will adhere to.

Parameters:

targetVersion - the iCalendar version

isCaretEncodingEnabled

public boolean isCaretEncodingEnabled()

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

Returns:

true if circumflex accent encoding is enabled, false if not

See Also:

ICalRawWriter.isCaretEncodingEnabled()

setCaretEncodingEnabled

public void setCaretEncodingEnabled(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)

_write

protected void _write(ICalendar ical)
               throws IOException

Description copied from class: StreamWriter

Writes an iCalendar object to the data stream.

Specified by:

_write in class StreamWriter

Parameters:

ical - the iCalendar object to write

Throws:

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

flush

public void flush()
           throws IOException

Flushes the stream.

Specified by:

flush in interface Flushable

Throws:

IOException - if there's a problem flushing the stream

close

public void close()
           throws IOException

Closes the underlying Writer object.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException