biweekly.io.chain

Class ChainingXmlWriter

java.lang.Object

biweekly.io.chain.ChainingXmlWriter

public class ChainingXmlWriter
extends Object

Chainer class for writing xCal (XML-encoded iCalendar objects).

Author:

Michael Angstadt

See Also:

Biweekly.writeXml(Collection), Biweekly.writeXml(ICalendar...)

Constructor Summary

Constructors

Constructor and Description
ChainingXmlWriter(Collection<ICalendar> icals)

Method Summary

Modifier and Type	Method and Description
Document	dom() Generates an XML document object model (DOM) containing the iCalendar objects.
String	go() Writes the iCalendar objects to a string.
void	go(File file) 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.
ChainingXmlWriter	indent(Integer indent) Sets the number of indent spaces to use for pretty-printing.
ChainingXmlWriter	outputProperties(Map<String,String> outputProperties) Assigns all of the given output properties to the JAXP transformer (see Transformer.setOutputProperty(java.lang.String, java.lang.String)).
ChainingXmlWriter	outputProperty(String name, String value) Assigns an output property to the JAXP transformer (see Transformer.setOutputProperty(java.lang.String, java.lang.String)).
ChainingXmlWriter	register(ICalComponentScribe<? extends ICalComponent> scribe) Registers a component scribe.
ChainingXmlWriter	register(ICalPropertyScribe<? extends ICalProperty> scribe) Registers a property scribe.
ChainingXmlWriter	register(String parameterName, ICalDataType dataType) Registers the data type of a non-standard parameter.
ChainingXmlWriter	tz(TimeZone defaultTimeZone, boolean outlookCompatible) Sets the timezone to use when outputting date values (defaults to UTC).
ChainingXmlWriter	xmlVersion(String xmlVersion) Sets the XML version to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChainingXmlWriter

public ChainingXmlWriter(Collection<ICalendar> icals)

Parameters:

icals - the iCValendar objects to write

Method Detail

indent

public ChainingXmlWriter indent(Integer indent)

Sets the number of indent spaces to use for pretty-printing. If not set, then the XML will not be pretty-printed.

Parameters:

indent - the number of spaces in the indent string or "null" not to pretty-print (disabled by default)

Returns:

this

xmlVersion

public ChainingXmlWriter xmlVersion(String xmlVersion)

Sets the XML version to use. Note that many JDKs only support 1.0 natively. For XML 1.1 support, add a JAXP library like xalan to your project.

Parameters:

xmlVersion - the XML version (defaults to "1.0")

Returns:

this

outputProperty

public ChainingXmlWriter outputProperty(String name,
                                        String value)

Assigns an output property to the JAXP transformer (see Transformer.setOutputProperty(java.lang.String, java.lang.String)).

Parameters:

name - the property name

value - the property value

Returns:

this

outputProperties

public ChainingXmlWriter outputProperties(Map<String,String> outputProperties)

Assigns all of the given output properties to the JAXP transformer (see Transformer.setOutputProperty(java.lang.String, java.lang.String)).

Parameters:

outputProperties - the properties

Returns:

this

tz

public ChainingXmlWriter 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 ChainingXmlWriter register(ICalPropertyScribe<? extends ICalProperty> scribe)

Registers a property scribe.

Parameters:

scribe - the scribe to register

Returns:

this

register

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

Registers a component scribe.

Parameters:

scribe - the scribe to register

Returns:

this

register

public ChainingXmlWriter register(String parameterName,
                                  ICalDataType dataType)

Registers the data type of a non-standard parameter. Non-standard parameters use the "unknown" data type by default.

Parameters:

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

dataType - the data type

Returns:

this

go

public String go()

Writes the iCalendar objects to a string.

Returns:

the XML document

go

public void go(OutputStream out)
        throws TransformerException

Writes the iCalendar objects to an output stream.

Parameters:

out - the output stream to write to

Throws:

TransformerException - if there's a problem writing to the output stream

go

public void go(File file)
        throws IOException,
               TransformerException

Writes the iCalendar objects to a file.

Parameters:

file - the file to write to

Throws:

IOException - if the file can't be opened

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

go

public void go(Writer writer)
        throws TransformerException

Writes the iCalendar objects to a writer.

Parameters:

writer - the writer to write to

Throws:

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

dom

public Document dom()

Generates an XML document object model (DOM) containing the iCalendar objects.

Returns:

the DOM