Woodstox 6.5.1 · com.ctc.wstx.api.WriterConfig · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
pack-priv static final boolean	DEFAULT_ADD_SPACE_AFTER_EMPTY_ELEM 09-Aug-2007, TSa: Space has always been added after empty element (before closing "/>"), but now it is configurable.
protected static final String	DEFAULT_AUTOMATIC_NS_PREFIX
pack-priv static final boolean	DEFAULT_COPY_DEFAULT_ATTRS
pack-priv static final boolean	DEFAULT_ESCAPE_CR
pack-priv static final boolean	DEFAULT_FIX_CONTENT As per [WSTX-120], default was changed to false, from true (default prior to wstx 4.0)
pack-priv static final int	DEFAULT_FLAGS_FULL For now, full instances start with same settings as J2ME subset
pack-priv static final int	DEFAULT_FLAGS_J2ME Default config flags are converted from individual settings, to conform to Stax 1.0 specifications.
pack-priv static final boolean	DEFAULT_OUTPUT_CDATA_AS_TEXT
pack-priv static final boolean	DEFAULT_USE_DOUBLE_QUOTES_IN_XML_DECL
pack-priv static final boolean	DEFAULT_VALIDATE_ATTR
pack-priv static final boolean	DEFAULT_VALIDATE_CONTENT
pack-priv static final boolean	DEFAULT_VALIDATE_NAMES
pack-priv static final boolean	DEFAULT_VALIDATE_STRUCTURE
protected int	mConfigFlags
pack-priv BufferRecycler	mCurrRecycler This is the actually container of the recyclable buffers.
pack-priv final boolean	mIsJ2MESubset
pack-priv static final ThreadLocal<SoftReference<BufferRecycler>>	mRecyclerRef This `ThreadLocal` contains a `SoftRerefence` to a `BufferRecycler` used to provide a low-cost buffer recycling between Reader instances.
pack-priv Object[]	mSpecialProperties
pack-priv static final int	PROP_ADD_SPACE_AFTER_EMPTY_ELEM
pack-priv static final int	PROP_ATTR_VALUE_ESCAPER
pack-priv static final int	PROP_AUTO_CLOSE_OUTPUT
pack-priv static final int	PROP_AUTOMATIC_EMPTY_ELEMENTS
pack-priv static final int	PROP_AUTOMATIC_END_ELEMENTS
pack-priv static final int	PROP_AUTOMATIC_NS
pack-priv static final int	PROP_AUTOMATIC_NS_PREFIX
pack-priv static final int	PROP_COPY_DEFAULT_ATTRS
pack-priv static final int	PROP_ENABLE_NS
pack-priv static final int	PROP_ESCAPE_CR
pack-priv static final int	PROP_FIX_CONTENT
pack-priv static final int	PROP_OUTPUT_CDATA_AS_TEXT
pack-priv static final int	PROP_OUTPUT_EMPTY_ELEMENT_HANDLER
pack-priv static final int	PROP_OUTPUT_INVALID_CHAR_HANDLER
pack-priv static final int	PROP_PROBLEM_REPORTER
pack-priv static final int	PROP_TEXT_ESCAPER
pack-priv static final int	PROP_UNDERLYING_STREAM
pack-priv static final int	PROP_UNDERLYING_WRITER
pack-priv static final int	PROP_USE_DOUBLE_QUOTES_IN_XML_DECL
pack-priv static final int	PROP_VALIDATE_ATTR
pack-priv static final int	PROP_VALIDATE_CONTENT
pack-priv static final int	PROP_VALIDATE_NAMES
pack-priv static final int	PROP_VALIDATE_STRUCTURE
private static final int	SP_IX_ATTR_VALUE_ESCAPER_FACTORY
private static final int	SP_IX_AUTO_NS_PREFIX
private static final int	SP_IX_EMPTY_ELEMENT_HANDLER
private static final int	SP_IX_INVALID_CHAR_HANDLER
private static final int	SP_IX_PROBLEM_REPORTER
private static final int	SP_IX_TEXT_ESCAPER_FACTORY
private static final int	SPEC_PROC_COUNT
pack-priv static final HashMap<String, Integer>	sProperties Map to use for converting from String property ids to ints described above; useful to allow use of switch later on.

Inherited from com.ctc.wstx.api.CommonConfig:: CPROP_IMPL_NAME CPROP_IMPL_VERSION CPROP_RETURN_NULL_FOR_DEFAULT_NAMESPACE CPROP_SUPPORT_XMLID CPROP_SUPPORTS_XML11 IMPL_NAME IMPL_VERSION mReturnNullForDefaultNamespace sStdProperties

Constructor Summary

Access	Constructor and Description
private	WriterConfig(WriterConfig base, boolean j2meSubset, int flags, Object[] specProps)

Method Summary

Modifier and Type	Method and Description
public byte[]	allocFullBBuffer(int minSize)
public char[]	allocFullCBuffer(int minSize)
public char[]	allocMediumCBuffer(int minSize) Method called to allocate intermediate recyclable copy buffers
public boolean	automaticEmptyElementsEnabled()
public boolean	automaticEndElementsEnabled()
public boolean	automaticNamespacesEnabled()
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).
public void	configureForSpeed() For Woodstox, setting this profile disables most checks for validity; specifically anything that can have measurable performance impact.
public void	configureForXmlConformance() For Woodstox, this profile enables all basic well-formedness checks, including checking for name validity.
public static WriterConfig	createFullDefaults()
public static WriterConfig	createJ2MEDefaults()
public WriterConfig	createNonShared()
private BufferRecycler	createRecycler()
public void	doAddSpaceAfterEmptyElem(boolean state)
public void	doAutoCloseOutput(boolean state)
public void	doCopyDefaultAttrs(boolean state)
public void	doEscapeCr(boolean state)
public void	doFixContent(boolean state)
public void	doOutputCDataAsText(boolean state)
public void	doSupportNamespaces(boolean state)
public void	doUseDoubleQuotesInXmlDecl(boolean state)
public void	doValidateAttributes(boolean state)
public void	doValidateContent(boolean state)
public void	doValidateNames(boolean state)
public void	doValidateStructure(boolean state)
public void	enableAutomaticEmptyElements(boolean state)
public void	enableAutomaticEndElements(boolean state)
public void	enableAutomaticNamespaces(boolean state)
protected int	findPropertyId(String propName) Implements abstract com.ctc.wstx.api.CommonConfig.findPropertyId.
public void	freeFullBBuffer(byte[] buffer)
public void	freeFullCBuffer(char[] buffer)
public void	freeMediumCBuffer(char[] buffer)
public EscapingWriterFactory	getAttrValueEscaperFactory()
public String	Returns: Prefix to use as the base for automatically generated namespace prefixes ("namespace prefix prefix", so to speak). Defaults to "wstxns". getAutomaticNsPrefix()
public int	getConfigFlags()
public EmptyElementHandler	getEmptyElementHandler()
public InvalidCharHandler	getInvalidCharHandler()
public XMLReporter	getProblemReporter()
public Object	getProperty(int id) Implements abstract com.ctc.wstx.api.CommonConfig.getProperty.
private final Object	getSpecialProperty(int ix)
public EscapingWriterFactory	getTextEscaperFactory()
private final boolean	hasConfigFlag(int flag)
public void	setAttrValueEscaperFactory(EscapingWriterFactory f)
public void	setAutomaticNsPrefix(String Prefix to use as the base for automatically generated namespace prefixes ("namespace prefix prefix", so to speak). prefix)
private void	setConfigFlag(int flag, boolean state)
public void	setEmptyElementHandler(EmptyElementHandler h)
public void	setInvalidCharHandler(InvalidCharHandler h)
public void	setProblemReporter(XMLReporter rep)
public boolean	Returns: True, if the specified property was succesfully set to specified value; false if its value was not changed setProperty(String name, int id, Object value) Implements abstract com.ctc.wstx.api.CommonConfig.setProperty.
private final void	setSpecialProperty(int ix, Object value)
public void	setTextEscaperFactory(EscapingWriterFactory f)
public boolean	willAddSpaceAfterEmptyElem()
public boolean	willAutoCloseOutput()
public boolean	willCopyDefaultAttrs()
public boolean	willEscapeCr()
public boolean	willFixContent()
public boolean	willOutputCDataAsText()
public boolean	willSupportNamespaces()
public boolean	willUseDoubleQuotesInXmlDecl()
public boolean	willValidateAttributes()
public boolean	willValidateContent()
public boolean	willValidateNames()
public boolean	willValidateStructure()

Inherited from com.ctc.wstx.api.CommonConfig:: doesSupportXml11 doesSupportXmlId findStdPropertyId getImplName getImplVersion getProperty getStdProperty isPropertySupported reportUnknownProperty returnNullForDefaultNamespace safeGetProperty setProperty setStdProperty

Field Detail

DEFAULT_ADD_SPACE_AFTER_EMPTY_ELEM	back to summary
pack-priv static final boolean DEFAULT_ADD_SPACE_AFTER_EMPTY_ELEM 09-Aug-2007, TSa: Space has always been added after empty element (before closing "/>"), but now it is configurable. 31-Dec-2009, TSa: Intention was to leave it enabled for backwards compatibility: but due to a bug this was NOT the case... ugh.

DEFAULT_AUTOMATIC_NS_PREFIX	back to summary
protected static final String DEFAULT_AUTOMATIC_NS_PREFIX

DEFAULT_COPY_DEFAULT_ATTRS	back to summary
pack-priv static final boolean DEFAULT_COPY_DEFAULT_ATTRS

DEFAULT_ESCAPE_CR	back to summary
pack-priv static final boolean DEFAULT_ESCAPE_CR

DEFAULT_FIX_CONTENT	back to summary
pack-priv static final boolean DEFAULT_FIX_CONTENT As per [WSTX-120], default was changed to false, from true (default prior to wstx 4.0)

DEFAULT_FLAGS_FULL	back to summary
pack-priv static final int DEFAULT_FLAGS_FULL For now, full instances start with same settings as J2ME subset

DEFAULT_FLAGS_J2ME	back to summary
pack-priv static final int DEFAULT_FLAGS_J2ME Default config flags are converted from individual settings, to conform to Stax 1.0 specifications.

DEFAULT_OUTPUT_CDATA_AS_TEXT	back to summary
pack-priv static final boolean DEFAULT_OUTPUT_CDATA_AS_TEXT

DEFAULT_USE_DOUBLE_QUOTES_IN_XML_DECL	back to summary
pack-priv static final boolean DEFAULT_USE_DOUBLE_QUOTES_IN_XML_DECL

DEFAULT_VALIDATE_ATTR	back to summary
pack-priv static final boolean DEFAULT_VALIDATE_ATTR

DEFAULT_VALIDATE_CONTENT	back to summary
pack-priv static final boolean DEFAULT_VALIDATE_CONTENT

DEFAULT_VALIDATE_NAMES	back to summary
pack-priv static final boolean DEFAULT_VALIDATE_NAMES

DEFAULT_VALIDATE_STRUCTURE	back to summary
pack-priv static final boolean DEFAULT_VALIDATE_STRUCTURE

mConfigFlags	back to summary
protected int mConfigFlags

mCurrRecycler	back to summary
pack-priv BufferRecycler mCurrRecycler This is the actually container of the recyclable buffers. It is obtained via ThreadLocal/SoftReference combination, if one exists, when Config instance is created. If one does not exists, it will created first time a buffer is returned.

mIsJ2MESubset	back to summary
pack-priv final boolean mIsJ2MESubset

mRecyclerRef	back to summary
pack-priv static final ThreadLocal<SoftReference<BufferRecycler>> mRecyclerRef This `ThreadLocal` contains a `SoftRerefence` to a `BufferRecycler` used to provide a low-cost buffer recycling between Reader instances.

mSpecialProperties	back to summary
pack-priv Object[] mSpecialProperties

PROP_ADD_SPACE_AFTER_EMPTY_ELEM	back to summary
pack-priv static final int PROP_ADD_SPACE_AFTER_EMPTY_ELEM

PROP_ATTR_VALUE_ESCAPER	back to summary
pack-priv static final int PROP_ATTR_VALUE_ESCAPER

PROP_AUTO_CLOSE_OUTPUT	back to summary
pack-priv static final int PROP_AUTO_CLOSE_OUTPUT

PROP_AUTOMATIC_EMPTY_ELEMENTS	back to summary
pack-priv static final int PROP_AUTOMATIC_EMPTY_ELEMENTS

PROP_AUTOMATIC_END_ELEMENTS	back to summary
pack-priv static final int PROP_AUTOMATIC_END_ELEMENTS

PROP_AUTOMATIC_NS	back to summary
pack-priv static final int PROP_AUTOMATIC_NS

PROP_AUTOMATIC_NS_PREFIX	back to summary
pack-priv static final int PROP_AUTOMATIC_NS_PREFIX

PROP_COPY_DEFAULT_ATTRS	back to summary
pack-priv static final int PROP_COPY_DEFAULT_ATTRS

PROP_ENABLE_NS	back to summary
pack-priv static final int PROP_ENABLE_NS

PROP_ESCAPE_CR	back to summary
pack-priv static final int PROP_ESCAPE_CR

PROP_FIX_CONTENT	back to summary
pack-priv static final int PROP_FIX_CONTENT

PROP_OUTPUT_CDATA_AS_TEXT	back to summary
pack-priv static final int PROP_OUTPUT_CDATA_AS_TEXT

PROP_OUTPUT_EMPTY_ELEMENT_HANDLER	back to summary
pack-priv static final int PROP_OUTPUT_EMPTY_ELEMENT_HANDLER

PROP_OUTPUT_INVALID_CHAR_HANDLER	back to summary
pack-priv static final int PROP_OUTPUT_INVALID_CHAR_HANDLER

PROP_PROBLEM_REPORTER	back to summary
pack-priv static final int PROP_PROBLEM_REPORTER

PROP_TEXT_ESCAPER	back to summary
pack-priv static final int PROP_TEXT_ESCAPER

PROP_UNDERLYING_STREAM	back to summary
pack-priv static final int PROP_UNDERLYING_STREAM

PROP_UNDERLYING_WRITER	back to summary
pack-priv static final int PROP_UNDERLYING_WRITER

PROP_USE_DOUBLE_QUOTES_IN_XML_DECL	back to summary
pack-priv static final int PROP_USE_DOUBLE_QUOTES_IN_XML_DECL

PROP_VALIDATE_ATTR	back to summary
pack-priv static final int PROP_VALIDATE_ATTR

PROP_VALIDATE_CONTENT	back to summary
pack-priv static final int PROP_VALIDATE_CONTENT

PROP_VALIDATE_NAMES	back to summary
pack-priv static final int PROP_VALIDATE_NAMES

PROP_VALIDATE_STRUCTURE	back to summary
pack-priv static final int PROP_VALIDATE_STRUCTURE

SP_IX_ATTR_VALUE_ESCAPER_FACTORY	back to summary
private static final int SP_IX_ATTR_VALUE_ESCAPER_FACTORY

SP_IX_AUTO_NS_PREFIX	back to summary
private static final int SP_IX_AUTO_NS_PREFIX

SP_IX_EMPTY_ELEMENT_HANDLER	back to summary
private static final int SP_IX_EMPTY_ELEMENT_HANDLER

SP_IX_INVALID_CHAR_HANDLER	back to summary
private static final int SP_IX_INVALID_CHAR_HANDLER

SP_IX_PROBLEM_REPORTER	back to summary
private static final int SP_IX_PROBLEM_REPORTER

SP_IX_TEXT_ESCAPER_FACTORY	back to summary
private static final int SP_IX_TEXT_ESCAPER_FACTORY

SPEC_PROC_COUNT	back to summary
private static final int SPEC_PROC_COUNT

sProperties	back to summary
pack-priv static final HashMap<String, Integer> sProperties Map to use for converting from String property ids to ints described above; useful to allow use of switch later on.

Constructor Detail

WriterConfig	back to summary
private WriterConfig(WriterConfig base, boolean j2meSubset, int flags, Object[] specProps)

Method Detail

allocFullBBuffer	back to summary
public byte[] allocFullBBuffer(int minSize)

allocFullCBuffer	back to summary
public char[] allocFullCBuffer(int minSize)

allocMediumCBuffer	back to summary
public char[] allocMediumCBuffer(int minSize) Method called to allocate intermediate recyclable copy buffers

automaticEmptyElementsEnabled	back to summary
public boolean automaticEmptyElementsEnabled()

automaticEndElementsEnabled	back to summary
public boolean automaticEndElementsEnabled()

automaticNamespacesEnabled	back to summary
public boolean automaticNamespacesEnabled()

configureForRobustness	back to summary
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	back to summary
public void configureForSpeed() For Woodstox, setting this profile disables most checks for validity; specifically anything that can have measurable performance impact.

configureForXmlConformance	back to summary
public void configureForXmlConformance() For Woodstox, this profile enables all basic well-formedness checks, including checking for name validity.

createFullDefaults	back to summary
public static WriterConfig createFullDefaults()

createJ2MEDefaults	back to summary
public static WriterConfig createJ2MEDefaults()

createNonShared	back to summary
public WriterConfig createNonShared()

createRecycler	back to summary
private BufferRecycler createRecycler()

doAddSpaceAfterEmptyElem	back to summary
public void doAddSpaceAfterEmptyElem(boolean state)

doAutoCloseOutput	back to summary
public void doAutoCloseOutput(boolean state)

doCopyDefaultAttrs	back to summary
public void doCopyDefaultAttrs(boolean state)

doEscapeCr	back to summary
public void doEscapeCr(boolean state)

doFixContent	back to summary
public void doFixContent(boolean state)

doOutputCDataAsText	back to summary
public void doOutputCDataAsText(boolean state)

doSupportNamespaces	back to summary
public void doSupportNamespaces(boolean state)

doUseDoubleQuotesInXmlDecl	back to summary
public void doUseDoubleQuotesInXmlDecl(boolean state) Since 4.2.2

doValidateAttributes	back to summary
public void doValidateAttributes(boolean state)

doValidateContent	back to summary
public void doValidateContent(boolean state)

doValidateNames	back to summary
public void doValidateNames(boolean state)

doValidateStructure	back to summary
public void doValidateStructure(boolean state)

enableAutomaticEmptyElements	back to summary
public void enableAutomaticEmptyElements(boolean state)

enableAutomaticEndElements	back to summary
public void enableAutomaticEndElements(boolean state)

enableAutomaticNamespaces	back to summary
public void enableAutomaticNamespaces(boolean state)

findPropertyId

back to summary

protected int findPropertyId(String propName)

Implements abstract com.ctc.wstx.api.CommonConfig.findPropertyId.

Returns:int

Doc from com.ctc.wstx.api.CommonConfig.findPropertyId.

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

Annotations

@Override

freeFullBBuffer	back to summary
public void freeFullBBuffer(byte[] buffer)

freeFullCBuffer	back to summary
public void freeFullCBuffer(char[] buffer)

freeMediumCBuffer	back to summary
public void freeMediumCBuffer(char[] buffer)

getAttrValueEscaperFactory	back to summary
public EscapingWriterFactory getAttrValueEscaperFactory()

getAutomaticNsPrefix	back to summary
public String getAutomaticNsPrefix() Returns:String Prefix to use as the base for automatically generated namespace prefixes ("namespace prefix prefix", so to speak). Defaults to "wstxns".

getConfigFlags	back to summary
public int getConfigFlags()

getEmptyElementHandler	back to summary
public EmptyElementHandler getEmptyElementHandler()

getInvalidCharHandler	back to summary
public InvalidCharHandler getInvalidCharHandler()

getProblemReporter	back to summary
public XMLReporter getProblemReporter()

getProperty

back to summary

public Object getProperty(int id)

Implements abstract com.ctc.wstx.api.CommonConfig.getProperty.

Annotations

@Override

getSpecialProperty	back to summary
private final Object getSpecialProperty(int ix)

getTextEscaperFactory	back to summary
public EscapingWriterFactory getTextEscaperFactory()

hasConfigFlag	back to summary
private final boolean hasConfigFlag(int flag)

setAttrValueEscaperFactory	back to summary
public void setAttrValueEscaperFactory(EscapingWriterFactory f)

setAutomaticNsPrefix	back to summary
public void setAutomaticNsPrefix(String prefix) Parameters prefix:String Prefix to use as the base for automatically generated namespace prefixes ("namespace prefix prefix", so to speak).

setConfigFlag	back to summary
private void setConfigFlag(int flag, boolean state)

setEmptyElementHandler	back to summary
public void setEmptyElementHandler(EmptyElementHandler h)

setInvalidCharHandler	back to summary
public void setInvalidCharHandler(InvalidCharHandler h)

setProblemReporter	back to summary
public void setProblemReporter(XMLReporter rep)

setProperty

back to summary

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

Implements abstract com.ctc.wstx.api.CommonConfig.setProperty.

Returns:boolean

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

Annotations

@Override

setSpecialProperty	back to summary
private final void setSpecialProperty(int ix, Object value)

setTextEscaperFactory	back to summary
public void setTextEscaperFactory(EscapingWriterFactory f)

willAddSpaceAfterEmptyElem	back to summary
public boolean willAddSpaceAfterEmptyElem()

willAutoCloseOutput	back to summary
public boolean willAutoCloseOutput()

willCopyDefaultAttrs	back to summary
public boolean willCopyDefaultAttrs()

willEscapeCr	back to summary
public boolean willEscapeCr()

willFixContent	back to summary
public boolean willFixContent()

willOutputCDataAsText	back to summary
public boolean willOutputCDataAsText()

willSupportNamespaces	back to summary
public boolean willSupportNamespaces()

willUseDoubleQuotesInXmlDecl	back to summary
public boolean willUseDoubleQuotesInXmlDecl() Since 4.2.2

willValidateAttributes	back to summary
public boolean willValidateAttributes()

willValidateContent	back to summary
public boolean willValidateContent()

willValidateNames	back to summary
public boolean willValidateNames()

willValidateStructure	back to summary
public boolean willValidateStructure()

public final Class WriterConfig

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail