com.ctc.wstx.api

Class WriterConfig

java.lang.Object

com.ctc.wstx.api.WriterConfig

All Implemented Interfaces:

OutputConfigFlags, org.codehaus.stax2.XMLStreamProperties

public final class WriterConfig
extends Object
implements OutputConfigFlags

Simple configuration container class; passed by writer factory to writer instance created.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_AUTOMATIC_NS_PREFIX
protected static String	IMPL_NAME
protected static String	IMPL_VERSION This is "major.minor" version used for purposes of determining the feature set.
protected int	mConfigFlags
protected boolean	mReturnNullForDefaultNamespace As per [WSTX-277], can specify whether prefix for the "default namespace" is return as null (true) or empty String (false)

Fields inherited from interface com.ctc.wstx.cfg.OutputConfigFlags

CFG_ADD_SPACE_AFTER_EMPTY_ELEM, CFG_AUTO_CLOSE_OUTPUT, CFG_AUTOMATIC_EMPTY_ELEMENTS, CFG_AUTOMATIC_END_ELEMENTS, CFG_AUTOMATIC_NS, CFG_COPY_DEFAULT_ATTRS, CFG_ENABLE_NS, CFG_ESCAPE_CR, CFG_FIX_CONTENT, CFG_OUTPUT_CDATA_AS_TEXT, CFG_USE_DOUBLE_QUOTES_IN_XML_DECL, CFG_VALIDATE_ATTR, CFG_VALIDATE_CONTENT, CFG_VALIDATE_NAMES, CFG_VALIDATE_STRUCTURE

Fields inherited from interface org.codehaus.stax2.XMLStreamProperties

XSP_IMPLEMENTATION_NAME, XSP_IMPLEMENTATION_VERSION, XSP_NAMESPACE_AWARE, XSP_PROBLEM_REPORTER, XSP_SUPPORT_XMLID, XSP_SUPPORTS_XML11, XSP_V_XMLID_FULL, XSP_V_XMLID_NONE, XSP_V_XMLID_TYPING

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	allocFullBBuffer(int minSize)
char[]	allocFullCBuffer(int minSize)
char[]	allocMediumCBuffer(int minSize) Method called to allocate intermediate recyclable copy buffers
boolean	automaticEmptyElementsEnabled()
boolean	automaticEndElementsEnabled()
boolean	automaticNamespacesEnabled()
void	configureForRobustness() For Woodstox, this profile enables all basic well-formedness checks, including checking for name validity, and also enables all matching "fix-me" properties (currently only content-fixing property exists).
void	configureForSpeed() For Woodstox, setting this profile disables most checks for validity; specifically anything that can have measurable performance impact.
void	configureForXmlConformance() For Woodstox, this profile enables all basic well-formedness checks, including checking for name validity.
static WriterConfig	createFullDefaults()
static WriterConfig	createJ2MEDefaults()
WriterConfig	createNonShared()
void	doAddSpaceAfterEmptyElem(boolean state)
void	doAutoCloseOutput(boolean state)
void	doCopyDefaultAttrs(boolean state)
void	doEscapeCr(boolean state)
boolean	doesSupportXml11()
boolean	doesSupportXmlId()
void	doFixContent(boolean state)
void	doOutputCDataAsText(boolean state)
void	doSupportNamespaces(boolean state)
void	doUseDoubleQuotesInXmlDecl(boolean state)
void	doValidateAttributes(boolean state)
void	doValidateContent(boolean state)
void	doValidateNames(boolean state)
void	doValidateStructure(boolean state)
void	enableAutomaticEmptyElements(boolean state)
void	enableAutomaticEndElements(boolean state)
void	enableAutomaticNamespaces(boolean state)
protected int	findPropertyId(String propName)
protected int	findStdPropertyId(String propName)
void	freeFullBBuffer(byte[] buffer)
void	freeFullCBuffer(char[] buffer)
void	freeMediumCBuffer(char[] buffer)
org.codehaus.stax2.io.EscapingWriterFactory	getAttrValueEscaperFactory()
String	getAutomaticNsPrefix()
int	getConfigFlags()
EmptyElementHandler	getEmptyElementHandler()
static String	getImplName() Method used to figure out the official implementation name for input/output/validation factories.
static String	getImplVersion() Method used to figure out the official implementation version for input/output/validation factories.
InvalidCharHandler	getInvalidCharHandler()
XMLReporter	getProblemReporter()
Object	getProperty(int id)
Object	getProperty(String propName)
protected Object	getStdProperty(int id)
org.codehaus.stax2.io.EscapingWriterFactory	getTextEscaperFactory()
boolean	isPropertySupported(String propName)
protected void	reportUnknownProperty(String propName)
boolean	returnNullForDefaultNamespace()
Object	safeGetProperty(String propName)
void	setAttrValueEscaperFactory(org.codehaus.stax2.io.EscapingWriterFactory f)
void	setAutomaticNsPrefix(String prefix)
void	setEmptyElementHandler(EmptyElementHandler h)
void	setInvalidCharHandler(InvalidCharHandler h)
void	setProblemReporter(XMLReporter rep)
boolean	setProperty(String name, int id, Object value)
boolean	setProperty(String propName, Object value)
protected boolean	setStdProperty(String propName, int id, Object value)
void	setTextEscaperFactory(org.codehaus.stax2.io.EscapingWriterFactory f)
boolean	willAddSpaceAfterEmptyElem()
boolean	willAutoCloseOutput()
boolean	willCopyDefaultAttrs()
boolean	willEscapeCr()
boolean	willFixContent()
boolean	willOutputCDataAsText()
boolean	willSupportNamespaces()
boolean	willUseDoubleQuotesInXmlDecl()
boolean	willValidateAttributes()
boolean	willValidateContent()
boolean	willValidateNames()
boolean	willValidateStructure()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_AUTOMATIC_NS_PREFIX

protected static final String DEFAULT_AUTOMATIC_NS_PREFIX

See Also:

Constant Field Values

mConfigFlags

protected int mConfigFlags

IMPL_NAME

protected static final String IMPL_NAME

See Also:

Constant Field Values

IMPL_VERSION

protected static final String IMPL_VERSION

This is "major.minor" version used for purposes of determining the feature set. Patch level is not included, since those should not affect API or feature set. Using applications should be prepared to take additional levels, however, just not depend on those being available.

See Also:

Constant Field Values

mReturnNullForDefaultNamespace

protected boolean mReturnNullForDefaultNamespace

As per [WSTX-277], can specify whether prefix for the "default namespace" is return as null (true) or empty String (false)

Method Detail

createJ2MEDefaults

public static WriterConfig createJ2MEDefaults()

createFullDefaults

public static WriterConfig createFullDefaults()

createNonShared

public WriterConfig createNonShared()

findPropertyId

protected int findPropertyId(String propName)

Returns:

Internal enumerated int matching the String name of the property, if one found: -1 to indicate no match was found.

getProperty

public Object getProperty(int id)

setProperty

public boolean setProperty(String name,
                  int id,
                  Object value)

Returns:

True, if the specified property was succesfully set to specified value; false if its value was not changed

getConfigFlags

public int getConfigFlags()

automaticNamespacesEnabled

public boolean automaticNamespacesEnabled()

automaticEmptyElementsEnabled

public boolean automaticEmptyElementsEnabled()

willAutoCloseOutput

public boolean willAutoCloseOutput()

willSupportNamespaces

public boolean willSupportNamespaces()

willUseDoubleQuotesInXmlDecl

public boolean willUseDoubleQuotesInXmlDecl()

Since:

4.2.2

willOutputCDataAsText

public boolean willOutputCDataAsText()

willCopyDefaultAttrs

public boolean willCopyDefaultAttrs()

willEscapeCr

public boolean willEscapeCr()

willAddSpaceAfterEmptyElem

public boolean willAddSpaceAfterEmptyElem()

automaticEndElementsEnabled

public boolean automaticEndElementsEnabled()

willValidateStructure

public boolean willValidateStructure()

willValidateContent

public boolean willValidateContent()

willValidateAttributes

public boolean willValidateAttributes()

willValidateNames

public boolean willValidateNames()

willFixContent

public boolean willFixContent()

getAutomaticNsPrefix

public String getAutomaticNsPrefix()

Returns:

Prefix to use as the base for automatically generated namespace prefixes ("namespace prefix prefix", so to speak). Defaults to "wstxns".

getTextEscaperFactory

public org.codehaus.stax2.io.EscapingWriterFactory getTextEscaperFactory()

getAttrValueEscaperFactory

public org.codehaus.stax2.io.EscapingWriterFactory getAttrValueEscaperFactory()

getProblemReporter

public XMLReporter getProblemReporter()

getInvalidCharHandler

public InvalidCharHandler getInvalidCharHandler()

getEmptyElementHandler

public EmptyElementHandler getEmptyElementHandler()

enableAutomaticNamespaces

public void enableAutomaticNamespaces(boolean state)

enableAutomaticEmptyElements

public void enableAutomaticEmptyElements(boolean state)

doAutoCloseOutput

public void doAutoCloseOutput(boolean state)

doSupportNamespaces

public void doSupportNamespaces(boolean state)

doUseDoubleQuotesInXmlDecl

public void doUseDoubleQuotesInXmlDecl(boolean state)

Since:

4.2.2

doOutputCDataAsText

public void doOutputCDataAsText(boolean state)

doCopyDefaultAttrs

public void doCopyDefaultAttrs(boolean state)

doEscapeCr

public void doEscapeCr(boolean state)

doAddSpaceAfterEmptyElem

public void doAddSpaceAfterEmptyElem(boolean state)

enableAutomaticEndElements

public void enableAutomaticEndElements(boolean state)

doValidateStructure

public void doValidateStructure(boolean state)

doValidateContent

public void doValidateContent(boolean state)

doValidateAttributes

public void doValidateAttributes(boolean state)

doValidateNames

public void doValidateNames(boolean state)

doFixContent

public void doFixContent(boolean state)

setAutomaticNsPrefix

public void setAutomaticNsPrefix(String prefix)

Parameters:

prefix - Prefix to use as the base for automatically generated namespace prefixes ("namespace prefix prefix", so to speak).

setTextEscaperFactory

public void setTextEscaperFactory(org.codehaus.stax2.io.EscapingWriterFactory f)

setAttrValueEscaperFactory

public void setAttrValueEscaperFactory(org.codehaus.stax2.io.EscapingWriterFactory f)

setProblemReporter

public void setProblemReporter(XMLReporter rep)

setInvalidCharHandler

public void setInvalidCharHandler(InvalidCharHandler h)

setEmptyElementHandler

public void setEmptyElementHandler(EmptyElementHandler h)

configureForXmlConformance

public void configureForXmlConformance()

For Woodstox, this profile enables all basic well-formedness checks, including checking for name validity.

configureForRobustness

public void configureForRobustness()

For Woodstox, this profile enables all basic well-formedness checks, including checking for name validity, and also enables all matching "fix-me" properties (currently only content-fixing property exists).

configureForSpeed

public void configureForSpeed()

For Woodstox, setting this profile disables most checks for validity; specifically anything that can have measurable performance impact.

allocMediumCBuffer

public char[] allocMediumCBuffer(int minSize)

Method called to allocate intermediate recyclable copy buffers

freeMediumCBuffer

public void freeMediumCBuffer(char[] buffer)

allocFullCBuffer

public char[] allocFullCBuffer(int minSize)

freeFullCBuffer

public void freeFullCBuffer(char[] buffer)

allocFullBBuffer

public byte[] allocFullBBuffer(int minSize)

freeFullBBuffer

public void freeFullBBuffer(byte[] buffer)

getProperty

public Object getProperty(String propName)

isPropertySupported

public boolean isPropertySupported(String propName)

setProperty

public boolean setProperty(String propName,
                  Object value)

Returns:

True, if the specified property was successfully set to specified value; false if its value was not changed

reportUnknownProperty

protected void reportUnknownProperty(String propName)

safeGetProperty

public final Object safeGetProperty(String propName)

getImplName

public static String getImplName()

Method used to figure out the official implementation name for input/output/validation factories.

getImplVersion

public static String getImplVersion()

Method used to figure out the official implementation version for input/output/validation factories.

doesSupportXml11

public boolean doesSupportXml11()

doesSupportXmlId

public boolean doesSupportXmlId()

returnNullForDefaultNamespace

public boolean returnNullForDefaultNamespace()

findStdPropertyId

protected int findStdPropertyId(String propName)

setStdProperty

protected boolean setStdProperty(String propName,
                     int id,
                     Object value)

Parameters:

propName - Name of standard property to set

id - Internal id matching the name

value - Value to set the standard property to

getStdProperty

protected Object getStdProperty(int id)