public final class WriterConfig extends CommonConfig implements OutputConfigFlags
Modifier and Type | Field and Description |
---|---|
(package private) static 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 java.lang.String |
DEFAULT_AUTOMATIC_NS_PREFIX |
(package private) static boolean |
DEFAULT_COPY_DEFAULT_ATTRS |
(package private) static boolean |
DEFAULT_ESCAPE_CR |
(package private) static boolean |
DEFAULT_FIX_CONTENT
As per [WSTX-120], default was changed to false,
from true (default prior to wstx 4.0)
|
(package private) static int |
DEFAULT_FLAGS_FULL
For now, full instances start with same settings as J2ME subset
|
(package private) static int |
DEFAULT_FLAGS_J2ME
Default config flags are converted from individual settings,
to conform to Stax 1.0 specifications.
|
(package private) static boolean |
DEFAULT_OUTPUT_CDATA_AS_TEXT |
(package private) static boolean |
DEFAULT_USE_DOUBLE_QUOTES_IN_XML_DECL |
(package private) static boolean |
DEFAULT_VALIDATE_ATTR |
(package private) static boolean |
DEFAULT_VALIDATE_CONTENT |
(package private) static boolean |
DEFAULT_VALIDATE_NAMES |
(package private) static boolean |
DEFAULT_VALIDATE_STRUCTURE |
protected int |
mConfigFlags |
(package private) BufferRecycler |
mCurrRecycler
This is the actually container of the recyclable buffers.
|
(package private) boolean |
mIsJ2MESubset |
(package private) static java.lang.ThreadLocal<java.lang.ref.SoftReference<BufferRecycler>> |
mRecyclerRef
This
ThreadLocal contains a SoftRerefence
to a BufferRecycler used to provide a low-cost
buffer recycling between Reader instances. |
(package private) java.lang.Object[] |
mSpecialProperties |
(package private) static int |
PROP_ADD_SPACE_AFTER_EMPTY_ELEM |
(package private) static int |
PROP_ATTR_VALUE_ESCAPER |
(package private) static int |
PROP_AUTO_CLOSE_OUTPUT |
(package private) static int |
PROP_AUTOMATIC_EMPTY_ELEMENTS |
(package private) static int |
PROP_AUTOMATIC_END_ELEMENTS |
(package private) static int |
PROP_AUTOMATIC_NS |
(package private) static int |
PROP_AUTOMATIC_NS_PREFIX |
(package private) static int |
PROP_COPY_DEFAULT_ATTRS |
(package private) static int |
PROP_ENABLE_NS |
(package private) static int |
PROP_ESCAPE_CR |
(package private) static int |
PROP_FIX_CONTENT |
(package private) static int |
PROP_OUTPUT_CDATA_AS_TEXT |
(package private) static int |
PROP_OUTPUT_EMPTY_ELEMENT_HANDLER |
(package private) static int |
PROP_OUTPUT_INVALID_CHAR_HANDLER |
(package private) static int |
PROP_PROBLEM_REPORTER |
(package private) static int |
PROP_TEXT_ESCAPER |
(package private) static int |
PROP_UNDERLYING_STREAM |
(package private) static int |
PROP_UNDERLYING_WRITER |
(package private) static int |
PROP_USE_DOUBLE_QUOTES_IN_XML_DECL |
(package private) static int |
PROP_VALIDATE_ATTR |
(package private) static int |
PROP_VALIDATE_CONTENT |
(package private) static int |
PROP_VALIDATE_NAMES |
(package private) static int |
PROP_VALIDATE_STRUCTURE |
private static int |
SP_IX_ATTR_VALUE_ESCAPER_FACTORY |
private static int |
SP_IX_AUTO_NS_PREFIX |
private static int |
SP_IX_EMPTY_ELEMENT_HANDLER |
private static int |
SP_IX_INVALID_CHAR_HANDLER |
private static int |
SP_IX_PROBLEM_REPORTER |
private static int |
SP_IX_TEXT_ESCAPER_FACTORY |
private static int |
SPEC_PROC_COUNT |
(package private) static java.util.HashMap<java.lang.String,java.lang.Integer> |
sProperties
Map to use for converting from String property ids to ints
described above; useful to allow use of switch later on.
|
IMPL_NAME, IMPL_VERSION, mReturnNullForDefaultNamespace, PROP_IMPL_NAME, PROP_IMPL_VERSION, PROP_RETURN_NULL_FOR_DEFAULT_NAMESPACE, PROP_SUPPORT_XMLID, PROP_SUPPORTS_XML11, sStdProperties
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
Modifier | Constructor and Description |
---|---|
private |
WriterConfig(WriterConfig base,
boolean j2meSubset,
int flags,
java.lang.Object[] specProps) |
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() |
private BufferRecycler |
createRecycler() |
void |
doAddSpaceAfterEmptyElem(boolean state) |
void |
doAutoCloseOutput(boolean state) |
void |
doCopyDefaultAttrs(boolean state) |
void |
doEscapeCr(boolean state) |
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(java.lang.String propName) |
void |
freeFullBBuffer(byte[] buffer) |
void |
freeFullCBuffer(char[] buffer) |
void |
freeMediumCBuffer(char[] buffer) |
org.codehaus.stax2.io.EscapingWriterFactory |
getAttrValueEscaperFactory() |
java.lang.String |
getAutomaticNsPrefix() |
int |
getConfigFlags() |
EmptyElementHandler |
getEmptyElementHandler() |
InvalidCharHandler |
getInvalidCharHandler() |
javax.xml.stream.XMLReporter |
getProblemReporter() |
java.lang.Object |
getProperty(int id) |
private java.lang.Object |
getSpecialProperty(int ix) |
org.codehaus.stax2.io.EscapingWriterFactory |
getTextEscaperFactory() |
private boolean |
hasConfigFlag(int flag) |
void |
setAttrValueEscaperFactory(org.codehaus.stax2.io.EscapingWriterFactory f) |
void |
setAutomaticNsPrefix(java.lang.String prefix) |
private void |
setConfigFlag(int flag,
boolean state) |
void |
setEmptyElementHandler(EmptyElementHandler h) |
void |
setInvalidCharHandler(InvalidCharHandler h) |
void |
setProblemReporter(javax.xml.stream.XMLReporter rep) |
boolean |
setProperty(java.lang.String name,
int id,
java.lang.Object value) |
private void |
setSpecialProperty(int ix,
java.lang.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() |
doesSupportXml11, doesSupportXmlId, findStdPropertyId, getImplName, getImplVersion, getProperty, getStdProperty, isPropertySupported, reportUnknownProperty, returnNullForDefaultNamespace, safeGetProperty, setProperty, setStdProperty
protected static final java.lang.String DEFAULT_AUTOMATIC_NS_PREFIX
static final int PROP_AUTOMATIC_NS
static final int PROP_AUTOMATIC_EMPTY_ELEMENTS
static final int PROP_AUTO_CLOSE_OUTPUT
static final int PROP_ENABLE_NS
static final int PROP_AUTOMATIC_NS_PREFIX
static final int PROP_TEXT_ESCAPER
static final int PROP_ATTR_VALUE_ESCAPER
static final int PROP_PROBLEM_REPORTER
static final int PROP_USE_DOUBLE_QUOTES_IN_XML_DECL
static final int PROP_OUTPUT_CDATA_AS_TEXT
static final int PROP_COPY_DEFAULT_ATTRS
static final int PROP_ESCAPE_CR
static final int PROP_ADD_SPACE_AFTER_EMPTY_ELEM
static final int PROP_AUTOMATIC_END_ELEMENTS
static final int PROP_VALIDATE_STRUCTURE
static final int PROP_VALIDATE_CONTENT
static final int PROP_VALIDATE_ATTR
static final int PROP_VALIDATE_NAMES
static final int PROP_FIX_CONTENT
static final int PROP_OUTPUT_INVALID_CHAR_HANDLER
static final int PROP_OUTPUT_EMPTY_ELEMENT_HANDLER
static final int PROP_UNDERLYING_STREAM
static final int PROP_UNDERLYING_WRITER
static final boolean DEFAULT_USE_DOUBLE_QUOTES_IN_XML_DECL
static final boolean DEFAULT_OUTPUT_CDATA_AS_TEXT
static final boolean DEFAULT_COPY_DEFAULT_ATTRS
static final boolean DEFAULT_ESCAPE_CR
static final boolean DEFAULT_ADD_SPACE_AFTER_EMPTY_ELEM
static final boolean DEFAULT_VALIDATE_STRUCTURE
static final boolean DEFAULT_VALIDATE_CONTENT
static final boolean DEFAULT_VALIDATE_ATTR
static final boolean DEFAULT_VALIDATE_NAMES
static final boolean DEFAULT_FIX_CONTENT
static final int DEFAULT_FLAGS_J2ME
static final int DEFAULT_FLAGS_FULL
static final java.util.HashMap<java.lang.String,java.lang.Integer> sProperties
final boolean mIsJ2MESubset
protected int mConfigFlags
java.lang.Object[] mSpecialProperties
private static final int SPEC_PROC_COUNT
private static final int SP_IX_AUTO_NS_PREFIX
private static final int SP_IX_TEXT_ESCAPER_FACTORY
private static final int SP_IX_ATTR_VALUE_ESCAPER_FACTORY
private static final int SP_IX_PROBLEM_REPORTER
private static final int SP_IX_INVALID_CHAR_HANDLER
private static final int SP_IX_EMPTY_ELEMENT_HANDLER
static final java.lang.ThreadLocal<java.lang.ref.SoftReference<BufferRecycler>> mRecyclerRef
ThreadLocal
contains a SoftRerefence
to a BufferRecycler
used to provide a low-cost
buffer recycling between Reader instances.BufferRecycler mCurrRecycler
private WriterConfig(WriterConfig base, boolean j2meSubset, int flags, java.lang.Object[] specProps)
public static WriterConfig createJ2MEDefaults()
public static WriterConfig createFullDefaults()
public WriterConfig createNonShared()
protected int findPropertyId(java.lang.String propName)
findPropertyId
in class CommonConfig
public java.lang.Object getProperty(int id)
getProperty
in class CommonConfig
public boolean setProperty(java.lang.String name, int id, java.lang.Object value)
setProperty
in class CommonConfig
public int getConfigFlags()
public boolean automaticNamespacesEnabled()
public boolean automaticEmptyElementsEnabled()
public boolean willAutoCloseOutput()
public boolean willSupportNamespaces()
public boolean willUseDoubleQuotesInXmlDecl()
public boolean willOutputCDataAsText()
public boolean willCopyDefaultAttrs()
public boolean willEscapeCr()
public boolean willAddSpaceAfterEmptyElem()
public boolean automaticEndElementsEnabled()
public boolean willValidateStructure()
public boolean willValidateContent()
public boolean willValidateAttributes()
public boolean willValidateNames()
public boolean willFixContent()
public java.lang.String getAutomaticNsPrefix()
public org.codehaus.stax2.io.EscapingWriterFactory getTextEscaperFactory()
public org.codehaus.stax2.io.EscapingWriterFactory getAttrValueEscaperFactory()
public javax.xml.stream.XMLReporter getProblemReporter()
public InvalidCharHandler getInvalidCharHandler()
public EmptyElementHandler getEmptyElementHandler()
public void enableAutomaticNamespaces(boolean state)
public void enableAutomaticEmptyElements(boolean state)
public void doAutoCloseOutput(boolean state)
public void doSupportNamespaces(boolean state)
public void doUseDoubleQuotesInXmlDecl(boolean state)
public void doOutputCDataAsText(boolean state)
public void doCopyDefaultAttrs(boolean state)
public void doEscapeCr(boolean state)
public void doAddSpaceAfterEmptyElem(boolean state)
public void enableAutomaticEndElements(boolean state)
public void doValidateStructure(boolean state)
public void doValidateContent(boolean state)
public void doValidateAttributes(boolean state)
public void doValidateNames(boolean state)
public void doFixContent(boolean state)
public void setAutomaticNsPrefix(java.lang.String prefix)
prefix
- Prefix to use as the base for automatically generated
namespace prefixes ("namespace prefix prefix", so to speak).public void setTextEscaperFactory(org.codehaus.stax2.io.EscapingWriterFactory f)
public void setAttrValueEscaperFactory(org.codehaus.stax2.io.EscapingWriterFactory f)
public void setProblemReporter(javax.xml.stream.XMLReporter rep)
public void setInvalidCharHandler(InvalidCharHandler h)
public void setEmptyElementHandler(EmptyElementHandler h)
public void configureForXmlConformance()
public void configureForRobustness()
public void configureForSpeed()
public char[] allocMediumCBuffer(int minSize)
public void freeMediumCBuffer(char[] buffer)
public char[] allocFullCBuffer(int minSize)
public void freeFullCBuffer(char[] buffer)
public byte[] allocFullBBuffer(int minSize)
public void freeFullBBuffer(byte[] buffer)
private BufferRecycler createRecycler()
private void setConfigFlag(int flag, boolean state)
private final boolean hasConfigFlag(int flag)
private final java.lang.Object getSpecialProperty(int ix)
private final void setSpecialProperty(int ix, java.lang.Object value)