ezvcard.io.xml

Class XCardOutputProperties

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,String>

ezvcard.io.xml.XCardOutputProperties

All Implemented Interfaces:

Serializable, Cloneable, Map<String,String>

public class XCardOutputProperties
extends HashMap<String,String>

Helper class for setting commonly-used JAXP output properties.

Author:

Michael Angstadt

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
XCardOutputProperties()
XCardOutputProperties(Integer indent, String xmlVersion)

Method Summary

Modifier and Type	Method and Description
Integer	getIndent() Gets the number of indent spaces to use for pretty-printing.
String	getXmlVersion() Gets the XML version to use.
void	setIndent(Integer indent) Sets the number of indent spaces to use for pretty-printing (disabled by default).
void	setXmlVersion(String version) Sets the XML version to use (defaults to "1.0").

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

XCardOutputProperties

public XCardOutputProperties()

XCardOutputProperties

public XCardOutputProperties(Integer indent,
                             String xmlVersion)

Parameters:

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:

IllegalArgumentException - if the indent amount is less than zero

Method Detail

getIndent

public Integer getIndent()

Gets the number of indent spaces to use for pretty-printing.

Returns:

the number of indent spaces or null if pretty-printing is disabled

setIndent

public void setIndent(Integer indent)

Sets the number of indent spaces to use for pretty-printing (disabled by default).

Parameters:

indent - the number of indent spaces to use or null to disable pretty-printing

Throws:

IllegalArgumentException - if the indent amount is less than zero

getXmlVersion

public String getXmlVersion()

Gets the XML version to use.

Returns:

the XML version or null if not set

setXmlVersion

public void setXmlVersion(String version)

Sets 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.

Parameters:

version - the XML version or null to remove