ezvcard.io.xml

Class XCardWriter

java.lang.Object

ezvcard.io.StreamWriter

ezvcard.io.xml.XCardWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public class XCardWriter
extends StreamWriter

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

Example:

 VCard vcard1 = ...
 VCard vcard2 = ...
 Path file = Paths.get("vcards.xml");
 try (XCardWriter writer = new XCardWriter(file)) {
   writer.write(vcard1);
   writer.write(vcard2);
 }
 

Author:

Michael Angstadt

See Also:

RFC 6351

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,VCardDataType>	parameterDataTypes Defines the names (data types) of the XML elements that are used to hold each parameter's value.
protected VCardVersion	targetVersion

Fields inherited from class ezvcard.io.StreamWriter

addProdId, index, versionStrict

Constructor Summary

Constructors

Constructor and Description
XCardWriter(Node parent)
XCardWriter(OutputStream out)
XCardWriter(OutputStream out, Integer indent)
XCardWriter(OutputStream out, Integer indent, String xmlVersion)
XCardWriter(OutputStream out, Map<String,String> outputProperties)
XCardWriter(Path file)
XCardWriter(Path file, Integer indent)
XCardWriter(Path file, Integer indent, String xmlVersion)
XCardWriter(Path file, Map<String,String> outputProperties)
XCardWriter(Writer writer)
XCardWriter(Writer writer, Integer indent)
XCardWriter(Writer writer, Integer indent, String xmlVersion)
XCardWriter(Writer writer, Map<String,String> outputProperties)

Method Summary

Modifier and Type	Method and Description
protected void	_write(VCard vcard, List<VCardProperty> properties) Writes a vCard to the stream.
void	close() Terminates the XML document and closes the output stream.
protected VCardVersion	getTargetVersion() Gets the version that the next vCard will be written as.
void	registerParameterDataType(String parameterName, VCardDataType dataType) Registers the data type of an experimental parameter.
protected void	removeUnsupportedParameters(VCardParameters parameters) Removes parameters that are not supported by xCard.

Methods inherited from class ezvcard.io.StreamWriter

getScribeIndex, isAddProdId, isVersionStrict, registerScribe, setAddProdId, setScribeIndex, setVersionStrict, write

Methods inherited from class java.lang.Object

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

Field Detail

targetVersion

protected final VCardVersion targetVersion

parameterDataTypes

protected final Map<String,VCardDataType> parameterDataTypes

Defines the names (data types) of the XML elements that are used to hold each parameter's value.

Constructor Detail

XCardWriter

public XCardWriter(OutputStream out)

Parameters:

out - the output stream to write to (UTF-8 encoding will be used)

XCardWriter

public XCardWriter(OutputStream out,
                   Integer indent)

Parameters:

out - the output stream to write to (UTF-8 encoding will be used)

indent - the number of indent spaces to use for pretty-printing or null to disable pretty-printing (disabled by default)

XCardWriter

public XCardWriter(OutputStream out,
                   Integer indent,
                   String xmlVersion)

Parameters:

out - the output stream to write to (UTF-8 encoding will be used)

indent - the number of indent spaces to use for pretty-printing or null to disable pretty-printing (disabled by default)

xmlVersion - the XML version to use (defaults to "1.0") (Note: Many JDKs only support 1.0 natively. For XML 1.1 support, add a JAXP library like xalan to your project)

XCardWriter

public XCardWriter(OutputStream out,
                   Map<String,String> outputProperties)

Parameters:

out - the output stream to write to (UTF-8 encoding will be used)

outputProperties - properties to assign to the JAXP transformer (see Transformer.setOutputProperty(java.lang.String, java.lang.String))

XCardWriter

public XCardWriter(Path file)
            throws IOException

Parameters:

file - the file to write to (UTF-8 encoding will be used)

Throws:

IOException - if there is a problem opening the file

XCardWriter

public XCardWriter(Path file,
                   Integer indent)
            throws IOException

Parameters:

file - the file to write to (UTF-8 encoding will be used)

indent - the number of indent spaces to use for pretty-printing or null to disable pretty-printing (disabled by default)

Throws:

IOException - if there is a problem opening the file

XCardWriter

public XCardWriter(Path file,
                   Integer indent,
                   String xmlVersion)
            throws IOException

Parameters:

file - the file to write to (UTF-8 encoding will be used)

indent - the number of indent spaces to use for pretty-printing or null to disable pretty-printing (disabled by default)

xmlVersion - the XML version to use (defaults to "1.0") (Note: Many JDKs only support 1.0 natively. For XML 1.1 support, add a JAXP library like xalan to your project)

Throws:

IOException - if there is a problem opening the file

XCardWriter

public XCardWriter(Path file,
                   Map<String,String> outputProperties)
            throws IOException

Parameters:

file - the file to write to (UTF-8 encoding will be used)

outputProperties - properties to assign to the JAXP transformer (see Transformer.setOutputProperty(java.lang.String, java.lang.String))

Throws:

IOException - if there is a problem opening the file

XCardWriter

public XCardWriter(Writer writer)

Parameters:

writer - the writer to write to

XCardWriter

public XCardWriter(Writer writer,
                   Integer indent)

Parameters:

writer - the writer to write to

indent - the number of indent spaces to use for pretty-printing or null to disable pretty-printing (disabled by default)

XCardWriter

public XCardWriter(Writer writer,
                   Integer indent,
                   String xmlVersion)

Parameters:

writer - the writer to write to

indent - the number of indent spaces to use for pretty-printing or null to disable pretty-printing (disabled by default)

xmlVersion - the XML version to use (defaults to "1.0") (Note: Many JDKs only support 1.0 natively. For XML 1.1 support, add a JAXP library like xalan to your project)

XCardWriter

public XCardWriter(Writer writer,
                   Map<String,String> outputProperties)

Parameters:

writer - the writer to write to

outputProperties - properties to assign to the JAXP transformer (see Transformer.setOutputProperty(java.lang.String, java.lang.String))

XCardWriter

public XCardWriter(Node parent)

Parameters:

parent - the DOM node to add child elements to

Method Detail

_write

protected void _write(VCard vcard,
                      List<VCardProperty> properties)
               throws IOException

Description copied from class: StreamWriter

Writes a vCard to the stream.

Specified by:

_write in class StreamWriter

Parameters:

vcard - the vCard that is being written

properties - the properties to write

Throws:

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

close

public void close()
           throws IOException

Terminates the XML document and closes the output stream.

Throws:

IOException

getTargetVersion

protected VCardVersion getTargetVersion()

Description copied from class: StreamWriter

Gets the version that the next vCard will be written as.

Specified by:

getTargetVersion in class StreamWriter

Returns:

the version

removeUnsupportedParameters

protected void removeUnsupportedParameters(VCardParameters parameters)

Removes parameters that are not supported by xCard.

Parameters:

parameters - the property parameters

registerParameterDataType

public void registerParameterDataType(String parameterName,
                                      VCardDataType 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