Woodstox 6.5.1 · com.ctc.wstx.sw.XmlWriter · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
protected static final char	DEFAULT_QUOTE_CHAR
pack-priv final boolean	mAddSpaceAfterEmptyElem Whether to add a space after empty element (before closing "/>") or not.
protected Writer	mAttrValueWriter Optional escaping writer used for escaping characters like '"' '&' and '<' in attribute values.
protected final boolean	mAutoCloseOutput Flag that defines whether close() on this writer should call close on the underlying output object (stream, writer)
protected final boolean	mCheckContent
protected final boolean	mCheckNames
protected final boolean	mCheckStructure
protected final WriterConfig	mConfig
protected final String	mEncoding
pack-priv final boolean	mEscapeCR Whether to escape CR (\r) character.
protected final boolean	mFixContent
protected int	mLocPastChars Number of characters output prior to currently buffered output
protected int	mLocRowNr
protected int	mLocRowStartOffset Offset of the first character on this line.
protected final boolean	mNsAware
protected XmlWriterWrapper	mRawWrapper Lazy-constructed wrapper object, which will route all calls to Writer API, to matching `writeRaw` methods of this XmlWriter instance.
protected XmlWriterWrapper	mTextWrapper Lazy-constructed wrapper object, which will route all calls to Writer API, to matching `writeCharacters` methods of this XmlWriter instance.
protected Writer	mTextWriter Optional escaping writer used for escaping characters like '<' '&' and '>' in textual content.
pack-priv final boolean	mUseDoubleQuotesInXmlDecl Whether to use double quotes in XML declaration or not.
protected boolean	mXml11 Indicates whether output is to be compliant; if false, is to be xml 1.0 compliant, if true, xml 1.1 compliant.
protected static final int	SURR1_FIRST
protected static final int	SURR1_LAST
protected static final int	SURR2_FIRST
protected static final int	SURR2_LAST

Constructor Summary

Access	Constructor and Description
protected	XmlWriter(WriterConfig cfg, String encoding, boolean autoclose)

Method Summary

Modifier and Type	Method and Description
public abstract void	close(boolean forceRealClose) Method called to flush the buffer(s), and close the output sink (stream or writer) if enabled (auto-closing) or forced.
public void	enableXml11()
public abstract void	flush()
public int	getAbsOffset()
public int	getColumn()
protected abstract int	getOutputPtr()
protected abstract OutputStream	Returns: Underlying OutputStream used for physical output, if the writer was constructed using one getOutputStream()
public int	getRow()
protected abstract Writer	Returns: Underlying Writer used for physical output, if the writer was constructed with one, or one was created to be used with an OutputStream. getWriter()
protected char	handleInvalidChar(int c) Method called to handle invalid character in textual content requested to be output.
protected void	reportNwfContent(String msg)
protected void	reportNwfName(String msg) This is the method called when an output method call violates name well-formedness checks and `WstxOutputProperties#P_OUTPUT_VALIDATE_NAMES` is is enabled.
protected void	throwOutputError(String msg)
protected void	throwOutputError(String format, Object arg)
public final void	verifyNameValidity(String name, boolean checkNs) Method called to verify that the name is a legal XML name.
public final Writer	wrapAsRawWriter() Method that can be called to get a wrapper instance that can be used to essentially call the `writeRaw` method.
public final Writer	wrapAsTextWriter()
public abstract void	writeAttribute(String localName, String value) Note can throw XMLStreamException, if name checking is enabled, and name is invalid (name check has to be in this writer, not caller, since it depends not only on xml limitations, but also on encoding limitations)
public abstract void	writeAttribute(String localName, char[] value, int offset, int len)
public abstract void	writeAttribute(String prefix, String localName, String value) Note can throw XMLStreamException, if name checking is enabled, and name is invalid (name check has to be in this writer, not caller, since it depends not only on xml limitations, but also on encoding limitations)
public abstract void	writeAttribute(String prefix, String localName, char[] value, int offset, int len)
public abstract int	Returns: offset of the (first) illegal content segment ("]]>") in passed content and not in repairing mode; or -1 if none or is repairing writeCData(String Contents of the CDATA section to write out data)
public abstract int	writeCData(char[] cbuf, int offset, int len)
public abstract void	writeCDataEnd()
public abstract void	writeCDataStart()
public abstract void	writeCharacters(String data)
public abstract void	writeCharacters(char[] cbuf, int offset, int len)
public abstract int	writeComment(String data) Method that will try to output the content as specified.
public abstract void	writeCommentEnd()
public abstract void	writeCommentStart()
public abstract void	writeDTD(String data) Older "legacy" output method for outputting DOCTYPE declaration.
public abstract void	writeDTD(String rootName, String systemId, String publicId, String internalSubset)
public abstract void	writeEndTag(String localName)
public abstract void	writeEndTag(String prefix, String localName)
public abstract void	writeEntityReference(String name)
public abstract int	writePI(String target, String data)
public abstract void	writePIEnd()
public abstract void	writePIStart(String target, boolean addSpace)
public abstract void	writeRaw(String str, int offset, int len)
public void	writeRaw(String str)
public abstract void	writeRaw(char[] cbuf, int offset, int len)
public abstract void	writeRawAscii(char[] cbuf, int offset, int len) Like `writeRaw`, but caller guarantees that the contents additionally are known to be in 7-bit ascii range.
public abstract void	writeStartTagEmptyEnd()
public abstract void	writeStartTagEnd()
public abstract void	writeStartTagStart(String localName) Note can throw XMLStreamException, if name checking is enabled, and name is invalid (name check has to be in this writer, not caller, since it depends not only on xml limitations, but also on encoding limitations)
public abstract void	writeStartTagStart(String prefix, String localName) Note can throw XMLStreamException, if name checking is enabled, and name is invalid (name check has to be in this writer, not caller, since it depends not only on xml limitations, but also on encoding limitations)
public abstract void	writeTypedAttribute(String localName, AsciiValueEncoder enc) Method similar to `writeAttribute(String, String, char[], int, int)` but where is known not to require escaping.
public abstract void	writeTypedAttribute(String prefix, String localName, AsciiValueEncoder enc) Method similar to `writeAttribute(String, String, char[], int, int)` but where is known not to require escaping.
public abstract void	writeTypedAttribute(String prefix, String localName, String nsURI, AsciiValueEncoder enc, XMLValidator validator, char[] copyBuffer) Method similar to `writeAttribute(String, String, char[], int, int)` but where is known not to require escaping.
public abstract void	writeTypedElement(AsciiValueEncoder Encoder that will produce content enc) Like `writeRaw`, but caller guarantees that the contents additionally are known to be in 7-bit ascii range, and also passes an encoder object that will encode values only when being handed a buffer to append to.
public abstract void	writeTypedElement(AsciiValueEncoder Encoder that will produce content enc, XMLValidator Validator to use for validating serialized textual content (can not be null) validator, char[] Temporary buffer that writer can use for temporary copies as necessary copyBuffer) Like `writeRaw`, but caller guarantees that the contents additionally are known to be in 7-bit ascii range, and also passes an encoder object that will encode values only when being handed a buffer to append to.
public abstract void	writeXmlDeclaration(String version, String enc, String standalone)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DEFAULT_QUOTE_CHAR	back to summary
protected static final char DEFAULT_QUOTE_CHAR

mAddSpaceAfterEmptyElem	back to summary
pack-priv final boolean mAddSpaceAfterEmptyElem Whether to add a space after empty element (before closing "/>") or not.

mAttrValueWriter	back to summary
protected Writer mAttrValueWriter Optional escaping writer used for escaping characters like '"' '&' and '<' in attribute values. Constructed if calling code has installed a special escaping writer factory for text content. Null if the default escaper is to be used.

mAutoCloseOutput	back to summary
protected final boolean mAutoCloseOutput Flag that defines whether close() on this writer should call close on the underlying output object (stream, writer)

mCheckContent	back to summary
protected final boolean mCheckContent

mCheckNames	back to summary
protected final boolean mCheckNames

mCheckStructure	back to summary
protected final boolean mCheckStructure

mConfig	back to summary
protected final WriterConfig mConfig

mEncoding	back to summary
protected final String mEncoding

mEscapeCR	back to summary
pack-priv final boolean mEscapeCR Whether to escape CR (\r) character.

mFixContent	back to summary
protected final boolean mFixContent

mLocPastChars	back to summary
protected int mLocPastChars Number of characters output prior to currently buffered output

mLocRowNr	back to summary
protected int mLocRowNr

mLocRowStartOffset	back to summary
protected int mLocRowStartOffset Offset of the first character on this line. May be negative, if the offset was in a buffer that has been flushed out.

mNsAware	back to summary
protected final boolean mNsAware

mRawWrapper	back to summary
protected XmlWriterWrapper mRawWrapper Lazy-constructed wrapper object, which will route all calls to Writer API, to matching `writeRaw` methods of this XmlWriter instance.

mTextWrapper	back to summary
protected XmlWriterWrapper mTextWrapper Lazy-constructed wrapper object, which will route all calls to Writer API, to matching `writeCharacters` methods of this XmlWriter instance.

mTextWriter	back to summary
protected Writer mTextWriter Optional escaping writer used for escaping characters like '<' '&' and '>' in textual content. Constructed if calling code has installed a special escaping writer factory for text content. Null if the default escaper is to be used.

mUseDoubleQuotesInXmlDecl	back to summary
pack-priv final boolean mUseDoubleQuotesInXmlDecl Whether to use double quotes in XML declaration or not.

mXml11	back to summary
protected boolean mXml11 Indicates whether output is to be compliant; if false, is to be xml 1.0 compliant, if true, xml 1.1 compliant.

SURR1_FIRST	back to summary
protected static final int SURR1_FIRST

SURR1_LAST	back to summary
protected static final int SURR1_LAST

SURR2_FIRST	back to summary
protected static final int SURR2_FIRST

SURR2_LAST	back to summary
protected static final int SURR2_LAST

Constructor Detail

XmlWriter	back to summary
protected XmlWriter(WriterConfig cfg, String encoding, boolean autoclose) throws IOException

Method Detail

close	back to summary
public abstract void close(boolean forceRealClose) throws IOException Method called to flush the buffer(s), and close the output sink (stream or writer) if enabled (auto-closing) or forced.

enableXml11	back to summary
public void enableXml11()

flush	back to summary
public abstract void flush() throws IOException

getAbsOffset	back to summary
public int getAbsOffset()

getColumn	back to summary
public int getColumn()

getOutputPtr	back to summary
protected abstract int getOutputPtr()

getOutputStream	back to summary
protected abstract OutputStream getOutputStream() Returns:OutputStream Underlying OutputStream used for physical output, if the writer was constructed using one

getRow	back to summary
public int getRow()

getWriter	back to summary
protected abstract Writer getWriter() Returns:Writer Underlying Writer used for physical output, if the writer was constructed with one, or one was created to be used with an OutputStream.

handleInvalidChar back to summary

handleInvalidChar	back to summary
protected char handleInvalidChar(int c) throws IOException Method called to handle invalid character in textual content requested to be output. Content may be part of textual events (CHARACTER, CDATA), attribute value, COMMENT content or PROCESSING_INSTRUCTION data. The default behavior is to just throw an exception, but this can be configured via property `WstxOutputProperties#P_OUTPUT_INVALID_CHAR_HANDLER`.

protected char handleInvalidChar(int c) throws IOException

Method called to handle invalid character in textual content requested to be output. Content may be part of textual events (CHARACTER, CDATA), attribute value, COMMENT content or PROCESSING_INSTRUCTION data. The default behavior is to just throw an exception, but this can be configured via property WstxOutputProperties#P_OUTPUT_INVALID_CHAR_HANDLER.

reportNwfContent	back to summary
protected void reportNwfContent(String msg) throws XMLStreamException

reportNwfName	back to summary
protected void reportNwfName(String msg) throws XMLStreamException This is the method called when an output method call violates name well-formedness checks and `WstxOutputProperties#P_OUTPUT_VALIDATE_NAMES` is is enabled.

throwOutputError	back to summary
protected void throwOutputError(String msg) throws XMLStreamException

throwOutputError	back to summary
protected void throwOutputError(String format, Object arg) throws XMLStreamException

verifyNameValidity	back to summary
public final void verifyNameValidity(String name, boolean checkNs) throws XMLStreamException Method called to verify that the name is a legal XML name.

wrapAsRawWriter	back to summary
public final Writer wrapAsRawWriter() Method that can be called to get a wrapper instance that can be used to essentially call the `writeRaw` method.

wrapAsTextWriter	back to summary
public final Writer wrapAsTextWriter()

writeAttribute	back to summary
public abstract void writeAttribute(String localName, String value) throws IOException, XMLStreamException Note can throw XMLStreamException, if name checking is enabled, and name is invalid (name check has to be in this writer, not caller, since it depends not only on xml limitations, but also on encoding limitations)

writeAttribute	back to summary
public abstract void writeAttribute(String localName, char[] value, int offset, int len) throws IOException, XMLStreamException

writeAttribute	back to summary
public abstract void writeAttribute(String prefix, String localName, String value) throws IOException, XMLStreamException Note can throw XMLStreamException, if name checking is enabled, and name is invalid (name check has to be in this writer, not caller, since it depends not only on xml limitations, but also on encoding limitations)

writeAttribute	back to summary
public abstract void writeAttribute(String prefix, String localName, char[] value, int offset, int len) throws IOException, XMLStreamException

writeCData	back to summary
public abstract int writeCData(String data) throws IOException, XMLStreamException Parameters data:String Contents of the CDATA section to write out Returns:int offset of the (first) illegal content segment ("]]>") in passed content and not in repairing mode; or -1 if none or is repairing

writeCData	back to summary
public abstract int writeCData(char[] cbuf, int offset, int len) throws IOException, XMLStreamException

writeCDataEnd	back to summary
public abstract void writeCDataEnd() throws IOException

writeCDataStart	back to summary
public abstract void writeCDataStart() throws IOException

writeCharacters	back to summary
public abstract void writeCharacters(String data) throws IOException

writeCharacters	back to summary
public abstract void writeCharacters(char[] cbuf, int offset, int len) throws IOException

writeComment	back to summary
public abstract int writeComment(String data) throws IOException, XMLStreamException Method that will try to output the content as specified. If the content passed in has embedded "--" in it, it will either add an intervening space between consequtive hyphens (if content fixing is enabled), or return the offset of the first hyphen in multi-hyphen sequence.

writeCommentEnd	back to summary
public abstract void writeCommentEnd() throws IOException

writeCommentStart	back to summary
public abstract void writeCommentStart() throws IOException

writeDTD	back to summary
public abstract void writeDTD(String data) throws IOException, XMLStreamException Older "legacy" output method for outputting DOCTYPE declaration. Assumes that the passed-in String contains a complete DOCTYPE declaration properly quoted.

writeDTD	back to summary
public abstract void writeDTD(String rootName, String systemId, String publicId, String internalSubset) throws IOException, XMLStreamException

writeEndTag	back to summary
public abstract void writeEndTag(String localName) throws IOException

writeEndTag	back to summary
public abstract void writeEndTag(String prefix, String localName) throws IOException

writeEntityReference	back to summary
public abstract void writeEntityReference(String name) throws IOException, XMLStreamException

writePI	back to summary
public abstract int writePI(String target, String data) throws IOException, XMLStreamException

writePIEnd	back to summary
public abstract void writePIEnd() throws IOException

writePIStart	back to summary
public abstract void writePIStart(String target, boolean addSpace) throws IOException

writeRaw	back to summary
public abstract void writeRaw(String str, int offset, int len) throws IOException

writeRaw	back to summary
public void writeRaw(String str) throws IOException

writeRaw	back to summary
public abstract void writeRaw(char[] cbuf, int offset, int len) throws IOException

writeRawAscii	back to summary
public abstract void writeRawAscii(char[] cbuf, int offset, int len) throws IOException Like `writeRaw`, but caller guarantees that the contents additionally are known to be in 7-bit ascii range.

writeStartTagEmptyEnd	back to summary
public abstract void writeStartTagEmptyEnd() throws IOException

writeStartTagEnd	back to summary
public abstract void writeStartTagEnd() throws IOException

writeStartTagStart	back to summary
public abstract void writeStartTagStart(String localName) throws IOException, XMLStreamException Note can throw XMLStreamException, if name checking is enabled, and name is invalid (name check has to be in this writer, not caller, since it depends not only on xml limitations, but also on encoding limitations)

writeStartTagStart	back to summary
public abstract void writeStartTagStart(String prefix, String localName) throws IOException, XMLStreamException Note can throw XMLStreamException, if name checking is enabled, and name is invalid (name check has to be in this writer, not caller, since it depends not only on xml limitations, but also on encoding limitations)

writeTypedAttribute	back to summary
public abstract void writeTypedAttribute(String localName, AsciiValueEncoder enc) throws IOException, XMLStreamException Method similar to `writeAttribute(String, String, char[], int, int)` but where is known not to require escaping. No validation needs to be performed.

writeTypedAttribute	back to summary
public abstract void writeTypedAttribute(String prefix, String localName, AsciiValueEncoder enc) throws IOException, XMLStreamException Method similar to `writeAttribute(String, String, char[], int, int)` but where is known not to require escaping. No validation needs to be performed.

writeTypedAttribute back to summary

public abstract void writeTypedAttribute(String prefix, String localName, String nsURI, AsciiValueEncoder enc, XMLValidator validator, char[] copyBuffer) throws IOException, XMLStreamException

Method similar to writeAttribute(String, String, char[], int, int) but where is known not to require escaping. Validation of the attribute value must be done by calling given validator appropriately.

writeTypedElement back to summary

public abstract void writeTypedElement(AsciiValueEncoder enc) throws IOException

Like writeRaw, but caller guarantees that the contents additionally are known to be in 7-bit ascii range, and also passes an encoder object that will encode values only when being handed a buffer to append to.

Parameters

enc:AsciiValueEncoder: Encoder that will produce content

writeTypedElement back to summary

public abstract void writeTypedElement(AsciiValueEncoder enc, XMLValidator validator, char[] copyBuffer) throws IOException, XMLStreamException

Parameters

enc:AsciiValueEncoder: Encoder that will produce content
validator:XMLValidator: Validator to use for validating serialized textual content (can not be null)
copyBuffer:char[]: Temporary buffer that writer can use for temporary copies as necessary

writeXmlDeclaration	back to summary
public abstract void writeXmlDeclaration(String version, String enc, String standalone) throws IOException

public abstract Class XmlWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail