com.ctc.wstx.api
public final class WriterConfig extends java.lang.Object implements OutputConfigFlags
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
DEFAULT_AUTOMATIC_NS_PREFIX |
protected static java.lang.String |
IMPL_NAME |
protected static java.lang.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)
|
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_VALIDATE_ATTR, CFG_VALIDATE_CONTENT, CFG_VALIDATE_NAMES, CFG_VALIDATE_STRUCTURE
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
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 |
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) |
protected int |
findStdPropertyId(java.lang.String propName) |
void |
freeFullBBuffer(byte[] buffer) |
void |
freeFullCBuffer(char[] buffer) |
void |
freeMediumCBuffer(char[] buffer) |
EscapingWriterFactory |
getAttrValueEscaperFactory() |
java.lang.String |
getAutomaticNsPrefix() |
int |
getConfigFlags() |
EmptyElementHandler |
getEmptyElementHandler() |
static java.lang.String |
getImplName()
Method used to figure out the official implementation name
for input/output/validation factories.
|
static java.lang.String |
getImplVersion()
Method used to figure out the official implementation version
for input/output/validation factories.
|
InvalidCharHandler |
getInvalidCharHandler() |
javax.xml.stream.XMLReporter |
getProblemReporter() |
java.lang.Object |
getProperty(int id) |
java.lang.Object |
getProperty(java.lang.String propName) |
protected java.lang.Object |
getStdProperty(int id) |
EscapingWriterFactory |
getTextEscaperFactory() |
boolean |
isPropertySupported(java.lang.String propName) |
protected void |
reportUnknownProperty(java.lang.String propName) |
boolean |
returnNullForDefaultNamespace() |
java.lang.Object |
safeGetProperty(java.lang.String propName) |
void |
setAttrValueEscaperFactory(EscapingWriterFactory f) |
void |
setAutomaticNsPrefix(java.lang.String prefix) |
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) |
boolean |
setProperty(java.lang.String propName,
java.lang.Object value) |
protected boolean |
setStdProperty(java.lang.String propName,
int id,
java.lang.Object value) |
void |
setTextEscaperFactory(EscapingWriterFactory f) |
boolean |
willAddSpaceAfterEmptyElem() |
boolean |
willAutoCloseOutput() |
boolean |
willCopyDefaultAttrs() |
boolean |
willEscapeCr() |
boolean |
willFixContent() |
boolean |
willOutputCDataAsText() |
boolean |
willSupportNamespaces() |
boolean |
willValidateAttributes() |
boolean |
willValidateContent() |
boolean |
willValidateNames() |
boolean |
willValidateStructure() |
protected static final java.lang.String DEFAULT_AUTOMATIC_NS_PREFIX
protected int mConfigFlags
protected static final java.lang.String IMPL_NAME
protected static final java.lang.String IMPL_VERSION
protected boolean mReturnNullForDefaultNamespace
public static WriterConfig createJ2MEDefaults()
public static WriterConfig createFullDefaults()
public WriterConfig createNonShared()
protected int findPropertyId(java.lang.String propName)
public java.lang.Object getProperty(int id)
public boolean setProperty(java.lang.String name, int id, java.lang.Object value)
public int getConfigFlags()
public boolean automaticNamespacesEnabled()
public boolean automaticEmptyElementsEnabled()
public boolean willAutoCloseOutput()
public boolean willSupportNamespaces()
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 EscapingWriterFactory getTextEscaperFactory()
public 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 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(EscapingWriterFactory f)
public void setAttrValueEscaperFactory(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)
public java.lang.Object getProperty(java.lang.String propName)
public boolean isPropertySupported(java.lang.String propName)
public boolean setProperty(java.lang.String propName, java.lang.Object value)
protected void reportUnknownProperty(java.lang.String propName)
public final java.lang.Object safeGetProperty(java.lang.String propName)
public static java.lang.String getImplName()
public static java.lang.String getImplVersion()
public boolean doesSupportXml11()
public boolean doesSupportXmlId()
public boolean returnNullForDefaultNamespace()
protected int findStdPropertyId(java.lang.String propName)
protected boolean setStdProperty(java.lang.String propName, int id, java.lang.Object value)
propName
- Name of standard property to setid
- Internal id matching the namevalue
- Value to set the standard property toprotected java.lang.Object getStdProperty(int id)