biweekly.io.xml

Class XCalWriter

java.lang.Object

biweekly.io.xml.XCalWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public class XCalWriter
extends Object
implements Closeable

Writes xCards (XML-encoded vCards) in a streaming fashion.

Example:

 VCard vcard1 = ...
 VCard vcard2 = ...
 
 File file = new File("vcards.xml");
 XCardWriter xcardWriter = new XCardWriter(file);
 xcardWriter.write(vcard1);
 xcardWriter.write(vcard2);
 xcardWriter.close();
 

Author:

Michael Angstadt

See Also:

RFC 6351

Constructor Summary

Constructors

Constructor and Description
XCalWriter(File file) Creates an xCard writer (UTF-8 encoding will be used).
XCalWriter(File file, String indent) Creates an xCard writer (UTF-8 encoding will be used).
XCalWriter(Node parent) Creates an xCard writer.
XCalWriter(OutputStream out) Creates an xCard writer (UTF-8 encoding will be used).
XCalWriter(OutputStream out, String indent) Creates an xCard writer (UTF-8 encoding will be used).
XCalWriter(Writer writer) Creates an xCard writer.
XCalWriter(Writer writer, String indent) Creates an xCard writer.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Terminates the XML document and closes the output stream.
ScribeIndex	getScribeIndex() Gets the object that manages the component/property scribes.
void	registerParameterDataType(String parameterName, ICalDataType dataType) Registers the data type of an experimental parameter.
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	write(ICalendar ical) Writes an iCalendar object.

Methods inherited from class java.lang.Object

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

Constructor Detail

XCalWriter

public XCalWriter(OutputStream out)

Creates an xCard writer (UTF-8 encoding will be used).

Parameters:

out - the output stream to write the xCards to

XCalWriter

public XCalWriter(OutputStream out,
          String indent)

Creates an xCard writer (UTF-8 encoding will be used).

Parameters:

out - the output stream to write the xCards to

indent - the indentation string to use for pretty printing (e.g. "\t") or null not to pretty print

XCalWriter

public XCalWriter(File file)
           throws IOException

Creates an xCard writer (UTF-8 encoding will be used).

Parameters:

file - the file to write the xCards to

Throws:

IOException - if there's a problem opening the file

XCalWriter

public XCalWriter(File file,
          String indent)
           throws IOException

Creates an xCard writer (UTF-8 encoding will be used).

Parameters:

file - the file to write the xCards to

indent - the indentation string to use for pretty printing (e.g. "\t") or null not to pretty print

Throws:

IOException - if there's a problem opening the file

XCalWriter

public XCalWriter(Writer writer)

Creates an xCard writer.

Parameters:

writer - the writer to write to

XCalWriter

public XCalWriter(Writer writer,
          String indent)

Creates an xCard writer.

Parameters:

writer - the writer to write to

indent - the indentation string to use for pretty printing (e.g. "\t") or null not to pretty print

XCalWriter

public XCalWriter(Node parent)

Creates an xCard writer.

Parameters:

parent - the DOM node to add child elements to

Method Detail

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

write

public void write(ICalendar ical)
           throws SAXException

Writes an iCalendar object.

Parameters:

ical - the iCalendar object to write

Throws:

SAXException - if there's a problem writing the iCalendar object

IllegalArgumentException - if the scribe index is missing scribes for one or more properties/components.

registerParameterDataType

public void registerParameterDataType(String parameterName,
                             ICalDataType dataType)

Registers the data type of an experimental parameter. Experimental parameters use the "unknown" data type by default.

Parameters:

parameterName - the parameter name (e.g. "x-foo")

dataType - the data type or null to remove

close

public void close()
           throws IOException

Terminates the XML document and closes the output stream.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException