public abstract class BaseStreamWriter extends org.codehaus.stax2.ri.Stax2WriterImpl implements org.codehaus.stax2.validation.ValidationContext, OutputConfigFlags
XMLStreamWriter implementations Woodstox has.
Contains partial stream writer implementation, plus utility methods
shared by concrete implementation classes. Main reason for such
abstract base class is to allow other parts of Woodstox core to refer
to any of stream writer implementations in general way.| Modifier and Type | Field and Description |
|---|---|
protected static int |
ATTR_MIN_ARRAYCOPY |
protected static char |
CHAR_SPACE |
protected static int |
DEFAULT_COPYBUFFER_LEN |
protected boolean |
mAnyOutput
Flag that is set to true first time something has been output.
|
protected boolean |
mCfgAutomaticEmptyElems |
protected boolean |
mCfgCDataAsText |
protected boolean |
mCfgCopyDefaultAttrs |
protected boolean |
mCheckAttrs |
protected boolean |
mCheckStructure |
protected WriterConfig |
mConfig |
protected char[] |
mCopyBuffer
Intermediate buffer into which characters of a String can be
copied, in cases where such a copy followed by array access
is faster than calling
String.charAt() (which
perhaps surprisingly is often case, and especially significant
for longer buffers). |
protected java.lang.String |
mDtdRootElem
Value passed as the expected root element, when using the multiple
argument
writeDTD(java.lang.String) method. |
protected boolean |
mEmptyElement
Flag that indicates that current element is an empty element (one
that is explicitly defined as one, by calling a method -- NOT one
that just happens to be empty).
|
protected java.lang.String |
mEncoding
Encoding to use; may be passed from the factory (when
a method that defines encoding is used), updated by
a call to
writeStartDocument(), or null if
neither. |
protected static int |
MIN_ARRAYCOPY
This constant defines minimum length of a String, for which it
is beneficial to do an intermediate copy (using String.getChars()),
and iterate over intermediate array, instead of iterating using
String.charAt().
|
protected boolean |
mReturnNullForDefaultNamespace |
protected boolean |
mStartElementOpen
Flag that is set during time that a start element is "open", ie.
|
protected int |
mState |
protected org.codehaus.stax2.validation.XMLValidator |
mValidator
Optional validator to use for validating output against
one or more schemas, and/or for safe pretty-printing (indentation).
|
protected int |
mVldContent
State value used with validation, to track types of content
that is allowed at this point in output stream.
|
protected org.codehaus.stax2.validation.ValidationProblemHandler |
mVldProbHandler
Custom validation problem handler, if any.
|
protected XmlWriter |
mWriter
Actual physical writer to output serialized XML content to
|
protected boolean |
mXml11
Since XML 1.1 has some differences to 1.0, we need to keep a flag
to indicate if we were to output XML 1.1 document.
|
protected static int |
STATE_EPILOG |
protected static int |
STATE_PROLOG |
protected static int |
STATE_TREE |
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 |
|---|---|
protected |
BaseStreamWriter(XmlWriter xw,
java.lang.String enc,
WriterConfig cfg) |
| Modifier and Type | Method and Description |
|---|---|
private void |
_finishDocument(boolean forceRealClose) |
int |
addDefaultAttribute(java.lang.String localName,
java.lang.String uri,
java.lang.String prefix,
java.lang.String value)
Adding default attribute values does not usually make sense on
output side, so the implementation is a NOP for now.
|
void |
close() |
void |
closeCompletely() |
protected abstract void |
closeStartElement(boolean emptyElem)
Method called to close an open start element, when another
main-level element (not namespace declaration or attribute)
is being output; except for end element which is handled differently.
|
void |
copyEventFromReader(org.codehaus.stax2.XMLStreamReader2 sr,
boolean preserveEventData)
Method that essentially copies event that the specified reader has
just read.
|
abstract void |
copyStartElement(InputElementStack elemStack,
AttributeCollector attrCollector)
Implementation-dependant method called to fully copy START_ELEMENT
event that the passed-in stream reader points to
|
protected void |
doReportProblem(javax.xml.stream.XMLReporter rep,
java.lang.String probType,
java.lang.String msg,
javax.xml.stream.Location loc) |
protected void |
doReportProblem(javax.xml.stream.XMLReporter rep,
org.codehaus.stax2.validation.XMLValidationProblem prob) |
protected void |
doWriteStartDocument(java.lang.String version,
java.lang.String encoding,
java.lang.String standAlone) |
int |
findAttributeIndex(java.lang.String nsURI,
java.lang.String localName) |
void |
flush() |
int |
getAttributeCount() |
java.lang.String |
getAttributeLocalName(int index) |
java.lang.String |
getAttributeNamespace(int index) |
java.lang.String |
getAttributePrefix(int index) |
java.lang.String |
getAttributeType(int index) |
java.lang.String |
getAttributeValue(int index) |
java.lang.String |
getAttributeValue(java.lang.String nsURI,
java.lang.String localName) |
java.lang.String |
getBaseUri()
As of now, there is no way to specify the base URI.
|
protected char[] |
getCopyBuffer() |
protected char[] |
getCopyBuffer(int minLen) |
abstract javax.xml.namespace.QName |
getCurrentElementName() |
java.lang.String |
getEncoding() |
org.codehaus.stax2.XMLStreamLocation2 |
getLocation() |
abstract javax.xml.namespace.NamespaceContext |
getNamespaceContext() |
abstract java.lang.String |
getNamespaceURI(java.lang.String prefix) |
abstract java.lang.String |
getPrefix(java.lang.String uri) |
java.lang.Object |
getProperty(java.lang.String name) |
protected abstract java.lang.String |
getTopElementDesc()
Method needed for error message generation
|
javax.xml.stream.Location |
getValidationLocation() |
java.lang.String |
getXmlVersion() |
protected boolean |
inPrologOrEpilog() |
boolean |
isNotationDeclared(java.lang.String name) |
boolean |
isPropertySupported(java.lang.String name) |
boolean |
isUnparsedEntityDeclared(java.lang.String name) |
protected boolean |
isValidating()
Method that is used by output classes to determine whether we
are in validating mode.
|
protected static void |
reportIllegalArg(java.lang.String msg) |
protected static void |
reportIllegalMethod(java.lang.String msg)
Method called when an illegal method (namespace-specific method
on non-ns writer) is called by the application.
|
protected void |
reportInvalidContent(int evtType) |
protected static void |
reportNwfAttr(java.lang.String msg)
This is the method called when an output method call violates
attribute well-formedness checks (trying to output dup attrs)
and
WstxOutputProperties.P_OUTPUT_VALIDATE_NAMES is
is enabled. |
protected static void |
reportNwfAttr(java.lang.String msg,
java.lang.Object arg) |
protected static void |
reportNwfContent(java.lang.String msg)
This is the method called when an output method call violates
content well-formedness checks
and
WstxOutputProperties.P_OUTPUT_VALIDATE_CONTENT is
is enabled. |
protected static void |
reportNwfContent(java.lang.String msg,
java.lang.Object arg) |
protected static void |
reportNwfStructure(java.lang.String msg)
This is the method called when an output method call violates
structural well-formedness checks
and
WstxOutputProperties.P_OUTPUT_VALIDATE_STRUCTURE is
is enabled. |
protected static void |
reportNwfStructure(java.lang.String msg,
java.lang.Object arg) |
void |
reportProblem(org.codehaus.stax2.validation.XMLValidationProblem prob) |
void |
reportValidationProblem(javax.xml.stream.Location loc,
java.lang.String msg) |
void |
reportValidationProblem(java.lang.String msg) |
void |
reportValidationProblem(java.lang.String msg,
int severity) |
void |
reportValidationProblem(java.lang.String msg,
javax.xml.stream.Location loc,
int severity) |
void |
reportValidationProblem(java.lang.String format,
java.lang.Object arg) |
void |
reportValidationProblem(java.lang.String format,
java.lang.Object arg,
java.lang.Object arg2) |
private void |
resetValidationFlags() |
abstract void |
setDefaultNamespace(java.lang.String uri) |
abstract void |
setNamespaceContext(javax.xml.namespace.NamespaceContext context) |
abstract void |
setPrefix(java.lang.String prefix,
java.lang.String uri) |
boolean |
setProperty(java.lang.String name,
java.lang.Object value) |
org.codehaus.stax2.validation.ValidationProblemHandler |
setValidationProblemHandler(org.codehaus.stax2.validation.ValidationProblemHandler h) |
org.codehaus.stax2.validation.XMLValidator |
stopValidatingAgainst(org.codehaus.stax2.validation.XMLValidationSchema schema) |
org.codehaus.stax2.validation.XMLValidator |
stopValidatingAgainst(org.codehaus.stax2.validation.XMLValidator validator) |
protected static void |
throwFromIOE(java.io.IOException ioe) |
protected static void |
throwOutputError(java.lang.String msg) |
protected static void |
throwOutputError(java.lang.String format,
java.lang.Object arg) |
java.lang.String |
toString() |
org.codehaus.stax2.validation.XMLValidator |
validateAgainst(org.codehaus.stax2.validation.XMLValidationSchema schema) |
abstract java.lang.String |
validateQNamePrefix(javax.xml.namespace.QName name)
Method called before writing a QName via Typed Access API.
|
protected void |
verifyRootElement(java.lang.String localName,
java.lang.String prefix) |
protected void |
verifyWriteCData() |
protected void |
verifyWriteDTD() |
java.io.Writer |
wrapAsRawWriter()
Method that can be called to get a wrapper instance that
can be used to essentially call the
writeRaw
method via regular Writer interface. |
java.io.Writer |
wrapAsTextWriter()
Method that can be called to get a wrapper instance that
can be used to essentially call the
writeCharacters
method via regular Writer interface. |
abstract void |
writeAttribute(java.lang.String localName,
java.lang.String value) |
abstract void |
writeAttribute(java.lang.String nsURI,
java.lang.String localName,
java.lang.String value) |
abstract void |
writeAttribute(java.lang.String prefix,
java.lang.String nsURI,
java.lang.String localName,
java.lang.String value) |
void |
writeCData(char[] cbuf,
int start,
int len) |
void |
writeCData(java.lang.String data) |
void |
writeCharacters(char[] text,
int start,
int len) |
void |
writeCharacters(javax.xml.stream.events.Characters ch)
Method called by
XMLEventWriter
(instead of more generic
text output methods), so that we can verify (if necessary) that
this character output type is legal in this context. |
void |
writeCharacters(java.lang.String text) |
void |
writeComment(java.lang.String data) |
abstract void |
writeDefaultNamespace(java.lang.String nsURI) |
void |
writeDTD(org.codehaus.stax2.DTDInfo info) |
void |
writeDTD(java.lang.String dtd) |
void |
writeDTD(java.lang.String rootName,
java.lang.String systemId,
java.lang.String publicId,
java.lang.String internalSubset) |
abstract void |
writeEmptyElement(java.lang.String localName) |
abstract void |
writeEmptyElement(java.lang.String nsURI,
java.lang.String localName) |
abstract void |
writeEmptyElement(java.lang.String prefix,
java.lang.String localName,
java.lang.String nsURI) |
void |
writeEndDocument() |
abstract void |
writeEndElement() |
abstract void |
writeEndElement(javax.xml.namespace.QName name)
Method called by
XMLEventWriter
(instead of the version
that takes no argument), so that we can verify it does match the
start element if necessary. |
void |
writeEntityRef(java.lang.String name) |
abstract void |
writeFullEndElement() |
abstract void |
writeNamespace(java.lang.String prefix,
java.lang.String nsURI) |
void |
writeProcessingInstruction(java.lang.String target) |
void |
writeProcessingInstruction(java.lang.String target,
java.lang.String data) |
void |
writeRaw(char[] text,
int start,
int offset) |
void |
writeRaw(java.lang.String text) |
void |
writeRaw(java.lang.String text,
int start,
int offset) |
void |
writeSpace(char[] text,
int offset,
int length) |
void |
writeSpace(java.lang.String text) |
void |
writeStartDocument() |
void |
writeStartDocument(java.lang.String version) |
void |
writeStartDocument(java.lang.String encoding,
java.lang.String version) |
void |
writeStartDocument(java.lang.String version,
java.lang.String encoding,
boolean standAlone) |
abstract void |
writeStartElement(javax.xml.stream.events.StartElement elem)
Convenience method needed by
XMLEventWriter
implementation, to use when
writing a start element, and possibly its attributes and namespace
declarations. |
abstract void |
writeStartElement(java.lang.String localName) |
abstract void |
writeStartElement(java.lang.String nsURI,
java.lang.String localName) |
abstract void |
writeStartElement(java.lang.String prefix,
java.lang.String localName,
java.lang.String nsURI) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitwriteBinary, writeBinary, writeBinaryAttribute, writeBinaryAttribute, writeBoolean, writeBooleanAttribute, writeDecimal, writeDecimalAttribute, writeDouble, writeDoubleArray, writeDoubleArrayAttribute, writeDoubleAttribute, writeFloat, writeFloatArray, writeFloatArrayAttribute, writeFloatAttribute, writeInt, writeIntArray, writeIntArrayAttribute, writeIntAttribute, writeInteger, writeIntegerAttribute, writeLong, writeLongArray, writeLongArrayAttribute, writeLongAttribute, writeQName, writeQNameAttributeprotected static final int STATE_PROLOG
protected static final int STATE_TREE
protected static final int STATE_EPILOG
protected static final char CHAR_SPACE
protected static final int MIN_ARRAYCOPY
protected static final int ATTR_MIN_ARRAYCOPY
protected static final int DEFAULT_COPYBUFFER_LEN
protected final XmlWriter mWriter
protected char[] mCopyBuffer
String.charAt() (which
perhaps surprisingly is often case, and especially significant
for longer buffers).protected final WriterConfig mConfig
protected final boolean mCfgCDataAsText
protected final boolean mCfgCopyDefaultAttrs
protected final boolean mCfgAutomaticEmptyElems
protected boolean mCheckStructure
protected boolean mCheckAttrs
protected java.lang.String mEncoding
writeStartDocument(), or null if
neither. Is passed to the escaping writer factory to
allow escaping writers to do additional escaping if
necessary (like encapsulating non-ascii chars in a doc
encoded usig ascii).protected org.codehaus.stax2.validation.XMLValidator mValidator
protected boolean mXml11
protected org.codehaus.stax2.validation.ValidationProblemHandler mVldProbHandler
protected int mState
protected boolean mAnyOutput
protected boolean mStartElementOpen
protected boolean mEmptyElement
protected int mVldContent
protected java.lang.String mDtdRootElem
writeDTD(java.lang.String) method. Will be used in structurally
validating mode (and in dtd-validating mode, since that automatically
enables structural validation as well, to pre-filter well-formedness
errors that validators might have trouble dealing with).protected boolean mReturnNullForDefaultNamespace
protected BaseStreamWriter(XmlWriter xw, java.lang.String enc, WriterConfig cfg)
public void close()
throws javax.xml.stream.XMLStreamException
close in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void flush()
throws javax.xml.stream.XMLStreamException
flush in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic abstract javax.xml.namespace.NamespaceContext getNamespaceContext()
getNamespaceContext in interface javax.xml.stream.XMLStreamWriterpublic abstract java.lang.String getPrefix(java.lang.String uri)
getPrefix in interface javax.xml.stream.XMLStreamWriterpublic java.lang.Object getProperty(java.lang.String name)
getProperty in interface javax.xml.stream.XMLStreamWriterpublic abstract void setDefaultNamespace(java.lang.String uri)
throws javax.xml.stream.XMLStreamException
setDefaultNamespace in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic abstract void setNamespaceContext(javax.xml.namespace.NamespaceContext context)
throws javax.xml.stream.XMLStreamException
setNamespaceContext in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic abstract void setPrefix(java.lang.String prefix,
java.lang.String uri)
throws javax.xml.stream.XMLStreamException
setPrefix in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic abstract void writeAttribute(java.lang.String localName,
java.lang.String value)
throws javax.xml.stream.XMLStreamException
writeAttribute in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic abstract void writeAttribute(java.lang.String nsURI,
java.lang.String localName,
java.lang.String value)
throws javax.xml.stream.XMLStreamException
writeAttribute in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic abstract void writeAttribute(java.lang.String prefix,
java.lang.String nsURI,
java.lang.String localName,
java.lang.String value)
throws javax.xml.stream.XMLStreamException
writeAttribute in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeCData(java.lang.String data)
throws javax.xml.stream.XMLStreamException
writeCData in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeCharacters(char[] text,
int start,
int len)
throws javax.xml.stream.XMLStreamException
writeCharacters in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeCharacters(java.lang.String text)
throws javax.xml.stream.XMLStreamException
writeCharacters in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeComment(java.lang.String data)
throws javax.xml.stream.XMLStreamException
writeComment in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic abstract void writeDefaultNamespace(java.lang.String nsURI)
throws javax.xml.stream.XMLStreamException
writeDefaultNamespace in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeDTD(java.lang.String dtd)
throws javax.xml.stream.XMLStreamException
writeDTD in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic abstract void writeEmptyElement(java.lang.String localName)
throws javax.xml.stream.XMLStreamException
writeEmptyElement in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic abstract void writeEmptyElement(java.lang.String nsURI,
java.lang.String localName)
throws javax.xml.stream.XMLStreamException
writeEmptyElement in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic abstract void writeEmptyElement(java.lang.String prefix,
java.lang.String localName,
java.lang.String nsURI)
throws javax.xml.stream.XMLStreamException
writeEmptyElement in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeEndDocument()
throws javax.xml.stream.XMLStreamException
writeEndDocument in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic abstract void writeEndElement()
throws javax.xml.stream.XMLStreamException
writeEndElement in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeEntityRef(java.lang.String name)
throws javax.xml.stream.XMLStreamException
writeEntityRef in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic abstract void writeNamespace(java.lang.String prefix,
java.lang.String nsURI)
throws javax.xml.stream.XMLStreamException
writeNamespace in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeProcessingInstruction(java.lang.String target)
throws javax.xml.stream.XMLStreamException
writeProcessingInstruction in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeProcessingInstruction(java.lang.String target,
java.lang.String data)
throws javax.xml.stream.XMLStreamException
writeProcessingInstruction in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeStartDocument()
throws javax.xml.stream.XMLStreamException
writeStartDocument in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeStartDocument(java.lang.String version)
throws javax.xml.stream.XMLStreamException
writeStartDocument in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void writeStartDocument(java.lang.String encoding,
java.lang.String version)
throws javax.xml.stream.XMLStreamException
writeStartDocument in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionprotected void doWriteStartDocument(java.lang.String version,
java.lang.String encoding,
java.lang.String standAlone)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionpublic abstract void writeStartElement(java.lang.String localName)
throws javax.xml.stream.XMLStreamException
writeStartElement in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic abstract void writeStartElement(java.lang.String nsURI,
java.lang.String localName)
throws javax.xml.stream.XMLStreamException
writeStartElement in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic abstract void writeStartElement(java.lang.String prefix,
java.lang.String localName,
java.lang.String nsURI)
throws javax.xml.stream.XMLStreamException
writeStartElement in interface javax.xml.stream.XMLStreamWriterjavax.xml.stream.XMLStreamExceptionpublic void copyEventFromReader(org.codehaus.stax2.XMLStreamReader2 sr,
boolean preserveEventData)
throws javax.xml.stream.XMLStreamException
copyEventFromReader in interface org.codehaus.stax2.XMLStreamWriter2copyEventFromReader in class org.codehaus.stax2.ri.Stax2WriterImplsr - Stream reader to use for accessing event to copypreserveEventData - If true, writer is not allowed to change
the state of the reader (so that all the data associated with the
current event has to be preserved); if false, writer is allowed
to use methods that may cause some data to be discarded. Setting
this to false may improve the performance, since it may allow
full no-copy streaming of data, especially textual contents.javax.xml.stream.XMLStreamExceptionpublic void closeCompletely()
throws javax.xml.stream.XMLStreamException
closeCompletely in interface org.codehaus.stax2.XMLStreamWriter2javax.xml.stream.XMLStreamExceptionpublic boolean isPropertySupported(java.lang.String name)
isPropertySupported in interface org.codehaus.stax2.XMLStreamWriter2isPropertySupported in class org.codehaus.stax2.ri.Stax2WriterImplpublic boolean setProperty(java.lang.String name,
java.lang.Object value)
setProperty in interface org.codehaus.stax2.XMLStreamWriter2setProperty in class org.codehaus.stax2.ri.Stax2WriterImplname - Name of the property to setvalue - Value to set property to.public org.codehaus.stax2.validation.XMLValidator validateAgainst(org.codehaus.stax2.validation.XMLValidationSchema schema)
throws javax.xml.stream.XMLStreamException
validateAgainst in interface org.codehaus.stax2.validation.ValidatablevalidateAgainst in class org.codehaus.stax2.ri.Stax2WriterImpljavax.xml.stream.XMLStreamExceptionpublic org.codehaus.stax2.validation.XMLValidator stopValidatingAgainst(org.codehaus.stax2.validation.XMLValidationSchema schema)
throws javax.xml.stream.XMLStreamException
stopValidatingAgainst in interface org.codehaus.stax2.validation.ValidatablestopValidatingAgainst in class org.codehaus.stax2.ri.Stax2WriterImpljavax.xml.stream.XMLStreamExceptionpublic org.codehaus.stax2.validation.XMLValidator stopValidatingAgainst(org.codehaus.stax2.validation.XMLValidator validator)
throws javax.xml.stream.XMLStreamException
stopValidatingAgainst in interface org.codehaus.stax2.validation.ValidatablestopValidatingAgainst in class org.codehaus.stax2.ri.Stax2WriterImpljavax.xml.stream.XMLStreamExceptionpublic org.codehaus.stax2.validation.ValidationProblemHandler setValidationProblemHandler(org.codehaus.stax2.validation.ValidationProblemHandler h)
setValidationProblemHandler in interface org.codehaus.stax2.validation.ValidatablesetValidationProblemHandler in class org.codehaus.stax2.ri.Stax2WriterImplprivate void resetValidationFlags()
public org.codehaus.stax2.XMLStreamLocation2 getLocation()
getLocation in interface org.codehaus.stax2.XMLStreamWriter2getLocation in class org.codehaus.stax2.ri.Stax2WriterImplpublic java.lang.String getEncoding()
getEncoding in interface org.codehaus.stax2.XMLStreamWriter2getEncoding in class org.codehaus.stax2.ri.Stax2WriterImplpublic void writeCData(char[] cbuf,
int start,
int len)
throws javax.xml.stream.XMLStreamException
writeCData in interface org.codehaus.stax2.XMLStreamWriter2writeCData in class org.codehaus.stax2.ri.Stax2WriterImpljavax.xml.stream.XMLStreamExceptionpublic void writeDTD(org.codehaus.stax2.DTDInfo info)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionpublic void writeDTD(java.lang.String rootName,
java.lang.String systemId,
java.lang.String publicId,
java.lang.String internalSubset)
throws javax.xml.stream.XMLStreamException
writeDTD in interface org.codehaus.stax2.XMLStreamWriter2writeDTD in class org.codehaus.stax2.ri.Stax2WriterImpljavax.xml.stream.XMLStreamExceptionpublic abstract void writeFullEndElement()
throws javax.xml.stream.XMLStreamException
writeFullEndElement in interface org.codehaus.stax2.XMLStreamWriter2writeFullEndElement in class org.codehaus.stax2.ri.Stax2WriterImpljavax.xml.stream.XMLStreamExceptionpublic void writeStartDocument(java.lang.String version,
java.lang.String encoding,
boolean standAlone)
throws javax.xml.stream.XMLStreamException
writeStartDocument in interface org.codehaus.stax2.XMLStreamWriter2writeStartDocument in class org.codehaus.stax2.ri.Stax2WriterImpljavax.xml.stream.XMLStreamExceptionpublic void writeRaw(java.lang.String text)
throws javax.xml.stream.XMLStreamException
writeRaw in interface org.codehaus.stax2.XMLStreamWriter2writeRaw in class org.codehaus.stax2.ri.Stax2WriterImpljavax.xml.stream.XMLStreamExceptionpublic void writeRaw(java.lang.String text,
int start,
int offset)
throws javax.xml.stream.XMLStreamException
writeRaw in interface org.codehaus.stax2.XMLStreamWriter2writeRaw in class org.codehaus.stax2.ri.Stax2WriterImpljavax.xml.stream.XMLStreamExceptionpublic void writeRaw(char[] text,
int start,
int offset)
throws javax.xml.stream.XMLStreamException
writeRaw in interface org.codehaus.stax2.XMLStreamWriter2writeRaw in class org.codehaus.stax2.ri.Stax2WriterImpljavax.xml.stream.XMLStreamExceptionpublic void writeSpace(java.lang.String text)
throws javax.xml.stream.XMLStreamException
writeSpace in interface org.codehaus.stax2.XMLStreamWriter2writeSpace in class org.codehaus.stax2.ri.Stax2WriterImpljavax.xml.stream.XMLStreamExceptionpublic void writeSpace(char[] text,
int offset,
int length)
throws javax.xml.stream.XMLStreamException
writeSpace in interface org.codehaus.stax2.XMLStreamWriter2writeSpace in class org.codehaus.stax2.ri.Stax2WriterImpljavax.xml.stream.XMLStreamExceptionpublic java.lang.String getXmlVersion()
getXmlVersion in interface org.codehaus.stax2.validation.ValidationContextpublic abstract javax.xml.namespace.QName getCurrentElementName()
getCurrentElementName in interface org.codehaus.stax2.validation.ValidationContextpublic abstract java.lang.String getNamespaceURI(java.lang.String prefix)
getNamespaceURI in interface org.codehaus.stax2.validation.ValidationContextpublic java.lang.String getBaseUri()
getBaseUri in interface org.codehaus.stax2.validation.ValidationContextpublic javax.xml.stream.Location getValidationLocation()
getValidationLocation in interface org.codehaus.stax2.validation.ValidationContextpublic void reportProblem(org.codehaus.stax2.validation.XMLValidationProblem prob)
throws javax.xml.stream.XMLStreamException
reportProblem in interface org.codehaus.stax2.validation.ValidationContextjavax.xml.stream.XMLStreamExceptionpublic int addDefaultAttribute(java.lang.String localName,
java.lang.String uri,
java.lang.String prefix,
java.lang.String value)
addDefaultAttribute in interface org.codehaus.stax2.validation.ValidationContextpublic boolean isNotationDeclared(java.lang.String name)
isNotationDeclared in interface org.codehaus.stax2.validation.ValidationContextpublic boolean isUnparsedEntityDeclared(java.lang.String name)
isUnparsedEntityDeclared in interface org.codehaus.stax2.validation.ValidationContextpublic int getAttributeCount()
getAttributeCount in interface org.codehaus.stax2.validation.ValidationContextpublic java.lang.String getAttributeLocalName(int index)
getAttributeLocalName in interface org.codehaus.stax2.validation.ValidationContextpublic java.lang.String getAttributeNamespace(int index)
getAttributeNamespace in interface org.codehaus.stax2.validation.ValidationContextpublic java.lang.String getAttributePrefix(int index)
getAttributePrefix in interface org.codehaus.stax2.validation.ValidationContextpublic java.lang.String getAttributeValue(int index)
getAttributeValue in interface org.codehaus.stax2.validation.ValidationContextpublic java.lang.String getAttributeValue(java.lang.String nsURI,
java.lang.String localName)
getAttributeValue in interface org.codehaus.stax2.validation.ValidationContextpublic java.lang.String getAttributeType(int index)
getAttributeType in interface org.codehaus.stax2.validation.ValidationContextpublic int findAttributeIndex(java.lang.String nsURI,
java.lang.String localName)
findAttributeIndex in interface org.codehaus.stax2.validation.ValidationContextpublic final java.io.Writer wrapAsRawWriter()
writeRaw
method via regular Writer interface.public final java.io.Writer wrapAsTextWriter()
writeCharacters
method via regular Writer interface.protected boolean isValidating()
Note: current implementation of this method is not perfect; it may be possible it can return true even if we are only using a DTD to get some limited info, without validating?
public abstract void writeStartElement(javax.xml.stream.events.StartElement elem)
throws javax.xml.stream.XMLStreamException
XMLEventWriter
implementation, to use when
writing a start element, and possibly its attributes and namespace
declarations.javax.xml.stream.XMLStreamExceptionpublic abstract void writeEndElement(javax.xml.namespace.QName name)
throws javax.xml.stream.XMLStreamException
XMLEventWriter
(instead of the version
that takes no argument), so that we can verify it does match the
start element if necessary.javax.xml.stream.XMLStreamExceptionpublic void writeCharacters(javax.xml.stream.events.Characters ch)
throws javax.xml.stream.XMLStreamException
XMLEventWriter
(instead of more generic
text output methods), so that we can verify (if necessary) that
this character output type is legal in this context. Specifically,
it's not acceptable to add non-whitespace content outside root
element (in prolog/epilog).
Note: cut'n pasted from the main writeCharacters; not
good... but done to optimize white-space cases.
javax.xml.stream.XMLStreamExceptionprotected abstract void closeStartElement(boolean emptyElem)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected final boolean inPrologOrEpilog()
private final void _finishDocument(boolean forceRealClose)
throws javax.xml.stream.XMLStreamException
forceRealClose - If true, will force calling of close() on the
underlying physical result (stream, writer). If false, will let
XmlWriter decide whether to call close(); will be done if auto-closing
enabled, but not otherwise.javax.xml.stream.XMLStreamExceptionpublic abstract void copyStartElement(InputElementStack elemStack, AttributeCollector attrCollector) throws java.io.IOException, javax.xml.stream.XMLStreamException
java.io.IOExceptionjavax.xml.stream.XMLStreamExceptionpublic abstract java.lang.String validateQNamePrefix(javax.xml.namespace.QName name)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected final void verifyWriteCData()
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected final void verifyWriteDTD()
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected void verifyRootElement(java.lang.String localName,
java.lang.String prefix)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected static void throwOutputError(java.lang.String msg)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected static void throwOutputError(java.lang.String format,
java.lang.Object arg)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected static void reportIllegalMethod(java.lang.String msg)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected static void reportNwfStructure(java.lang.String msg)
throws javax.xml.stream.XMLStreamException
WstxOutputProperties.P_OUTPUT_VALIDATE_STRUCTURE is
is enabled.javax.xml.stream.XMLStreamExceptionprotected static void reportNwfStructure(java.lang.String msg,
java.lang.Object arg)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected static void reportNwfContent(java.lang.String msg)
throws javax.xml.stream.XMLStreamException
WstxOutputProperties.P_OUTPUT_VALIDATE_CONTENT is
is enabled.javax.xml.stream.XMLStreamExceptionprotected static void reportNwfContent(java.lang.String msg,
java.lang.Object arg)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected static void reportNwfAttr(java.lang.String msg)
throws javax.xml.stream.XMLStreamException
WstxOutputProperties.P_OUTPUT_VALIDATE_NAMES is
is enabled.javax.xml.stream.XMLStreamExceptionprotected static void reportNwfAttr(java.lang.String msg,
java.lang.Object arg)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected static void throwFromIOE(java.io.IOException ioe)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected static void reportIllegalArg(java.lang.String msg)
throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentExceptionprotected void reportInvalidContent(int evtType)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionpublic void reportValidationProblem(java.lang.String msg,
javax.xml.stream.Location loc,
int severity)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionpublic void reportValidationProblem(java.lang.String msg,
int severity)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionpublic void reportValidationProblem(java.lang.String msg)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionpublic void reportValidationProblem(javax.xml.stream.Location loc,
java.lang.String msg)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionpublic void reportValidationProblem(java.lang.String format,
java.lang.Object arg)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionpublic void reportValidationProblem(java.lang.String format,
java.lang.Object arg,
java.lang.Object arg2)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected void doReportProblem(javax.xml.stream.XMLReporter rep,
java.lang.String probType,
java.lang.String msg,
javax.xml.stream.Location loc)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected void doReportProblem(javax.xml.stream.XMLReporter rep,
org.codehaus.stax2.validation.XMLValidationProblem prob)
throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamExceptionprotected abstract java.lang.String getTopElementDesc()
protected final char[] getCopyBuffer()
protected final char[] getCopyBuffer(int minLen)
public java.lang.String toString()
toString in class java.lang.Object