biweekly.io

Class StreamWriter

java.lang.Object

biweekly.io.StreamWriter

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

ICalWriter, JCalWriter, XCalDocument.XCalDocumentStreamWriter, XCalWriter

public abstract class StreamWriter
extends Object
implements Closeable

Writes iCalendar objects to a data stream.

Author:

Michael Angstadt

Field Summary

Fields

Modifier and Type	Field and Description
protected WriteContext	context
protected ScribeIndex	index
protected TimezoneInfo	tzinfo

Constructor Summary

Constructors

Constructor and Description
StreamWriter()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	_write(ICalendar ical) Writes an iCalendar object to the data stream.
ScribeIndex	getScribeIndex() Gets the object that manages the component/property scribes.
protected abstract ICalVersion	getTargetVersion() Gets the version that the next iCalendar object will be written as.
TimezoneInfo	getTimezoneInfo() Gets the timezone-related info for this writer.
void	registerScribe(ICalComponentScribe<? extends ICalComponent> scribe) Registers an experimental component scribe.
void	registerScribe(ICalPropertyScribe<? extends ICalProperty> scribe) Registers an experimental property scribe.
void	setScribeIndex(ScribeIndex scribe) Sets the object that manages the component/property scribes.
void	setTimezoneInfo(TimezoneInfo tzinfo) Sets the timezone-related info for this writer.
void	write(ICalendar ical) Writes an iCalendar object to the data stream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Field Detail

index

protected ScribeIndex index

context

protected WriteContext context

tzinfo

protected TimezoneInfo tzinfo

Constructor Detail

StreamWriter

public StreamWriter()

Method Detail

write

public void write(ICalendar ical)
           throws IOException

Writes an iCalendar object to the data stream.

Parameters:

ical - the iCalendar object to write

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 registerScribe method.)

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

getTargetVersion

protected abstract ICalVersion getTargetVersion()

Gets the version that the next iCalendar object will be written as.

Returns:

the version

_write

protected abstract void _write(ICalendar ical)
                        throws IOException

Writes an iCalendar object to the data stream.

Parameters:

ical - the iCalendar object to write

Throws:

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

getTimezoneInfo

public TimezoneInfo getTimezoneInfo()

Gets the timezone-related info for this writer.

Returns:

the timezone-related info

setTimezoneInfo

public void setTimezoneInfo(TimezoneInfo tzinfo)

Sets the timezone-related info for this writer.

Parameters:

tzinfo - the timezone-related info

registerScribe

public void registerScribe(ICalPropertyScribe<? extends ICalProperty> scribe)

Registers an experimental property scribe. Can also be used to override the scribe of a standard property (such as DTSTART). Calling this method is the same as calling:

getScribeIndex().register(scribe).

Parameters:

scribe - the scribe to register

registerScribe

public void registerScribe(ICalComponentScribe<? extends ICalComponent> scribe)

Registers an experimental component scribe. Can also be used to override the scribe of a standard component (such as VEVENT). Calling this method is the same as calling:

getScribeIndex().register(scribe).

Parameters:

scribe - the scribe to register

getScribeIndex

public ScribeIndex getScribeIndex()

Gets the object that manages the component/property scribes.

Returns:

the scribe index

setScribeIndex

public void setScribeIndex(ScribeIndex scribe)

Sets the object that manages the component/property scribes.

Parameters:

scribe - the scribe index