ezvcard.io.chain

Class ChainingXmlWriter

java.lang.Object

ezvcard.io.chain.ChainingXmlWriter

public class ChainingXmlWriter
extends Object

Chainer class for writing xCards (XML-encoded vCards).

Author:

Michael Angstadt

See Also:

Ezvcard.writeXml(Collection), Ezvcard.writeXml(VCard...)

Constructor Summary

Constructors

Constructor and Description
ChainingXmlWriter(Collection<VCard> vcards)

Method Summary

Modifier and Type	Method and Description
Document	dom() Generates an XML document object model (DOM) containing the xCards.
String	go() Writes the xCards to a string.
void	go(OutputStream out) Writes the xCards to an output stream.
void	go(Path file) Writes the xCards to a file.
void	go(Writer writer) Writes the xCards 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	prodId(boolean include) Sets whether to add a ProductId property to each vCard that marks it as having been generated by this library.
ChainingXmlWriter	register(String parameterName, VCardDataType dataType) Registers the data type of a non-standard parameter.
ChainingXmlWriter	register(VCardPropertyScribe<? extends VCardProperty> scribe) Registers a property scribe.
ChainingXmlWriter	versionStrict(boolean versionStrict) Sets whether to exclude properties that do not support the target version from the written vCard.
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<VCard> vcards)

Parameters:

vcards - the vCards 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

prodId

public ChainingXmlWriter prodId(boolean include)

Sets whether to add a ProductId property to each vCard that marks it as having been generated by this library. For 2.1 vCards, the extended property "X-PRODID" will be added, since ProductId is not supported by that version.

Parameters:

include - true to add the property, false not to (defaults to true)

Returns:

this

versionStrict

public ChainingXmlWriter versionStrict(boolean versionStrict)

Sets whether to exclude properties that do not support the target version from the written vCard.

Parameters:

versionStrict - true to exclude such properties, false not to (defaults to true)

Returns:

this

register

public ChainingXmlWriter register(VCardPropertyScribe<? extends VCardProperty> scribe)

Registers a property scribe.

Parameters:

scribe - the scribe to register

Returns:

this

register

public ChainingXmlWriter register(String parameterName,
                                  VCardDataType 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 xCards to a string.

Returns:

the XML document

go

public void go(OutputStream out)
        throws TransformerException

Writes the xCards 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(Path file)
        throws IOException,
               TransformerException

Writes the xCards 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 xCards 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 xCards.

Returns:

the DOM