Class BufferingXmlWriter
- All Implemented Interfaces:
XMLStreamConstants
XmlWriter
that will dispatch writes
to another writer (of type Writer
, and will NOT handle
encoding. It will, however, do basic buffering such that the underlying
Writer need (and thus, should) not do buffering.
One design goal for this class is to avoid unnecessary buffering: since there will be another Writer doing the actual encoding, amount of buffering needed should still be limited. To this end, a threshold is used to define what's the threshold of writes that we do want to coalesce, ie. buffer. Writes bigger than this should in general proceed without buffering.
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) static final int
Let's use a typical default to have a compromise between large enough chunks to output, and minimizing memory overhead.(package private) static final int
Choosing threshold for 'small size' is a compromise between excessive buffering (high small size), and too many fragmented calls to the underlying writer (low small size).protected static final int
Highest valued character that may need to be encoded (minus charset encoding requirements) when writing attribute values.protected static final int
Highest valued character that may need to be encoded (minus charset encoding requirements) when writing attribute values.private final int
First Unicode character (one with lowest value) after (and including) which character entities have to be used.(package private) final char
Character that is considered to be the enclosing quote character; for XML either single or double quote.(package private) final String
Entity String to use for escaping the quote character.protected final Writer
Actual Writer to use for outputting buffered data as appropriate.protected char[]
protected int
protected int
protected final int
This is the threshold used to check what is considered a "small" write; small writes will be buffered until resulting size will be above the threshold.protected final OutputStream
Actual physical stream that the writer is using, if known.protected static final int[]
Fields inherited from class com.ctc.wstx.sw.XmlWriter
DEFAULT_QUOTE_CHAR, mAddSpaceAfterEmptyElem, mAttrValueWriter, mAutoCloseOutput, mCheckContent, mCheckNames, mCheckStructure, mConfig, mEncoding, mEscapeCR, mFixContent, mLocPastChars, mLocRowNr, mLocRowStartOffset, mNsAware, mRawWrapper, mTextWrapper, mTextWriter, mUseDoubleQuotesInXmlDecl, mXml11, SURR1_FIRST, SURR1_LAST, SURR2_FIRST, SURR2_LAST
Fields inherited from interface javax.xml.stream.XMLStreamConstants
ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT
-
Constructor Summary
ConstructorsConstructorDescriptionBufferingXmlWriter
(Writer out, WriterConfig cfg, String enc, boolean autoclose, OutputStream outs, int bitsize) -
Method Summary
Modifier and TypeMethodDescriptionvoid
close
(boolean forceRealClose) Method called to flush the buffer(s), and close the output sink (stream or writer) if enabled (auto-closing) or forced.private final void
fastWriteRaw
(char c) private final void
fastWriteRaw
(char c1, char c2) private final void
fastWriteRaw
(String str) final void
flush()
private final void
protected int
protected final OutputStream
protected final Writer
static int
Method used to figure out which part of the Unicode char set the encoding can natively support.protected int
verifyCDataContent
(char[] c, int start, int end) protected int
verifyCDataContent
(String content) protected int
verifyCommentContent
(String content) protected final void
writeAsEntity
(int c) void
writeAttribute
(String localName, char[] value, int offset, int vlen) 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)void
writeAttribute
(String prefix, String localName, char[] value, int offset, int vlen) 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)private final void
writeAttrValue
(char[] value, int offset, int len) private final void
writeAttrValue
(String value, int len) int
writeCData
(char[] cbuf, int offset, int len) int
writeCData
(String data) final void
final void
void
writeCharacters
(char[] cbuf, int offset, int len) void
writeCharacters
(String text) int
writeComment
(String data) Method that will try to output the content as specified.final void
final void
void
Older "legacy" output method for outputting DOCTYPE declaration.void
void
writeEndTag
(String localName) void
writeEndTag
(String prefix, String localName) void
writeEntityReference
(String name) int
final void
final void
writePIStart
(String target, boolean addSpace) protected final void
writePrefixedName
(String prefix, String localName) void
writeRaw
(char[] cbuf, int offset, int len) void
void
final void
writeRawAscii
(char[] cbuf, int offset, int len) Method called to output typed values (int, long, double, float etc) that are known not to contain any escapable characters, or anything else beyond 7-bit ascii range.protected void
writeSegmentedCData
(char[] c, int start, int len, int index) protected void
writeSegmentedCData
(String content, int index) protected void
writeSegmentedComment
(String content, int index) void
void
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)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)void
writeTypedAttribute
(String prefix, String localName, String nsURI, org.codehaus.stax2.ri.typed.AsciiValueEncoder enc, org.codehaus.stax2.validation.XMLValidator validator, char[] copyBuffer) Method similar toXmlWriter.writeAttribute(String,String,char[],int,int)
but where is known not to require escaping.void
writeTypedAttribute
(String prefix, String localName, org.codehaus.stax2.ri.typed.AsciiValueEncoder enc) Method similar toXmlWriter.writeAttribute(String,String,char[],int,int)
but where is known not to require escaping.void
writeTypedAttribute
(String localName, org.codehaus.stax2.ri.typed.AsciiValueEncoder enc) Method similar toXmlWriter.writeAttribute(String,String,char[],int,int)
but where is known not to require escaping.final void
writeTypedElement
(org.codehaus.stax2.ri.typed.AsciiValueEncoder enc) LikeXmlWriter.writeRaw(java.lang.String, int, int)
, 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.final void
writeTypedElement
(org.codehaus.stax2.ri.typed.AsciiValueEncoder enc, org.codehaus.stax2.validation.XMLValidator validator, char[] copyBuffer) LikeXmlWriter.writeRaw(java.lang.String, int, int)
, 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.void
writeXmlDeclaration
(String version, String encoding, String standalone) Methods inherited from class com.ctc.wstx.sw.XmlWriter
enableXml11, getAbsOffset, getColumn, getRow, handleInvalidChar, reportNwfContent, reportNwfName, throwOutputError, throwOutputError, verifyNameValidity, wrapAsRawWriter, wrapAsTextWriter
-
Field Details
-
DEFAULT_BUFFER_SIZE
static final int DEFAULT_BUFFER_SIZELet's use a typical default to have a compromise between large enough chunks to output, and minimizing memory overhead. Compared to encoding writers, buffer size can be bit smaller since there's one more level of processing (at encoding), which may use bigger buffering.- See Also:
-
DEFAULT_SMALL_SIZE
static final int DEFAULT_SMALL_SIZEChoosing threshold for 'small size' is a compromise between excessive buffering (high small size), and too many fragmented calls to the underlying writer (low small size). Let's just use about 1/4 of the full buffer size.- See Also:
-
HIGHEST_ENCODABLE_ATTR_CHAR
protected static final int HIGHEST_ENCODABLE_ATTR_CHARHighest valued character that may need to be encoded (minus charset encoding requirements) when writing attribute values.- See Also:
-
HIGHEST_ENCODABLE_TEXT_CHAR
protected static final int HIGHEST_ENCODABLE_TEXT_CHARHighest valued character that may need to be encoded (minus charset encoding requirements) when writing attribute values.- See Also:
-
QUOTABLE_TEXT_CHARS
protected static final int[] QUOTABLE_TEXT_CHARS -
mOut
Actual Writer to use for outputting buffered data as appropriate. -
mOutputBuffer
protected char[] mOutputBuffer -
mSmallWriteSize
protected final int mSmallWriteSizeThis is the threshold used to check what is considered a "small" write; small writes will be buffered until resulting size will be above the threshold. -
mOutputPtr
protected int mOutputPtr -
mOutputBufLen
protected int mOutputBufLen -
mUnderlyingStream
Actual physical stream that the writer is using, if known. Not used for actual output, only needed so that calling application may (try to) figure out the original source. -
mEncHighChar
private final int mEncHighCharFirst Unicode character (one with lowest value) after (and including) which character entities have to be used. For -
mEncQuoteChar
final char mEncQuoteCharCharacter that is considered to be the enclosing quote character; for XML either single or double quote. -
mEncQuoteEntity
Entity String to use for escaping the quote character.
-
-
Constructor Details
-
BufferingXmlWriter
public BufferingXmlWriter(Writer out, WriterConfig cfg, String enc, boolean autoclose, OutputStream outs, int bitsize) throws IOException - Parameters:
outs
- Underlying OutputStream that the writer (out
) is using, if known. Needed to support (optional) access to the underlying stream- Throws:
IOException
-
-
Method Details
-
getOutputPtr
protected int getOutputPtr()- Specified by:
getOutputPtr
in classXmlWriter
-
getOutputStream
- Specified by:
getOutputStream
in classXmlWriter
- Returns:
- Underlying OutputStream used for physical output, if the writer was constructed using one
-
getWriter
-
close
Description copied from class:XmlWriter
Method called to flush the buffer(s), and close the output sink (stream or writer) if enabled (auto-closing) or forced.- Specified by:
close
in classXmlWriter
- Throws:
IOException
-
flush
- Specified by:
flush
in classXmlWriter
- Throws:
IOException
-
writeRaw
- Specified by:
writeRaw
in classXmlWriter
- Throws:
IOException
-
writeRawAscii
Method called to output typed values (int, long, double, float etc) that are known not to contain any escapable characters, or anything else beyond 7-bit ascii range.- Specified by:
writeRawAscii
in classXmlWriter
- Throws:
IOException
-
writeRaw
- Overrides:
writeRaw
in classXmlWriter
- Throws:
IOException
-
writeRaw
- Specified by:
writeRaw
in classXmlWriter
- Throws:
IOException
-
writeCDataStart
- Specified by:
writeCDataStart
in classXmlWriter
- Throws:
IOException
-
writeCDataEnd
- Specified by:
writeCDataEnd
in classXmlWriter
- Throws:
IOException
-
writeCommentStart
- Specified by:
writeCommentStart
in classXmlWriter
- Throws:
IOException
-
writeCommentEnd
- Specified by:
writeCommentEnd
in classXmlWriter
- Throws:
IOException
-
writePIStart
- Specified by:
writePIStart
in classXmlWriter
- Throws:
IOException
-
writePIEnd
- Specified by:
writePIEnd
in classXmlWriter
- Throws:
IOException
-
writeCData
- Specified by:
writeCData
in classXmlWriter
- Parameters:
data
- Contents of the CDATA section to write out- Returns:
- offset of the (first) illegal content segment ("]]>") in passed content and not in repairing mode; or -1 if none or is repairing
- Throws:
IOException
-
writeCData
- Specified by:
writeCData
in classXmlWriter
- Throws:
IOException
-
writeCharacters
- Specified by:
writeCharacters
in classXmlWriter
- Throws:
IOException
-
writeCharacters
- Specified by:
writeCharacters
in classXmlWriter
- Throws:
IOException
-
writeComment
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.- Specified by:
writeComment
in classXmlWriter
- Throws:
IOException
-
writeDTD
Description copied from class:XmlWriter
Older "legacy" output method for outputting DOCTYPE declaration. Assumes that the passed-in String contains a complete DOCTYPE declaration properly quoted.- Specified by:
writeDTD
in classXmlWriter
- Throws:
IOException
-
writeDTD
public void writeDTD(String rootName, String systemId, String publicId, String internalSubset) throws IOException, XMLStreamException - Specified by:
writeDTD
in classXmlWriter
- Throws:
IOException
XMLStreamException
-
writeEntityReference
- Specified by:
writeEntityReference
in classXmlWriter
- Throws:
IOException
XMLStreamException
-
writeXmlDeclaration
public void writeXmlDeclaration(String version, String encoding, String standalone) throws IOException - Specified by:
writeXmlDeclaration
in classXmlWriter
- Throws:
IOException
-
writePI
- Specified by:
writePI
in classXmlWriter
- Throws:
IOException
XMLStreamException
-
writeStartTagStart
Description copied from class:XmlWriter
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)
- Specified by:
writeStartTagStart
in classXmlWriter
- Throws:
IOException
XMLStreamException
-
writeStartTagStart
public void writeStartTagStart(String prefix, String localName) throws IOException, XMLStreamException Description copied from class:XmlWriter
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)
- Specified by:
writeStartTagStart
in classXmlWriter
- Throws:
IOException
XMLStreamException
-
writeStartTagEnd
- Specified by:
writeStartTagEnd
in classXmlWriter
- Throws:
IOException
-
writeStartTagEmptyEnd
- Specified by:
writeStartTagEmptyEnd
in classXmlWriter
- Throws:
IOException
-
writeEndTag
- Specified by:
writeEndTag
in classXmlWriter
- Throws:
IOException
-
writeEndTag
- Specified by:
writeEndTag
in classXmlWriter
- Throws:
IOException
-
writeAttribute
Description copied from class:XmlWriter
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)
- Specified by:
writeAttribute
in classXmlWriter
- Throws:
IOException
XMLStreamException
-
writeAttribute
public void writeAttribute(String localName, char[] value, int offset, int vlen) throws IOException, XMLStreamException - Specified by:
writeAttribute
in classXmlWriter
- Throws:
IOException
XMLStreamException
-
writeAttribute
public void writeAttribute(String prefix, String localName, String value) throws IOException, XMLStreamException Description copied from class:XmlWriter
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)
- Specified by:
writeAttribute
in classXmlWriter
- Throws:
IOException
XMLStreamException
-
writeAttribute
public void writeAttribute(String prefix, String localName, char[] value, int offset, int vlen) throws IOException, XMLStreamException - Specified by:
writeAttribute
in classXmlWriter
- Throws:
IOException
XMLStreamException
-
writeAttrValue
- Throws:
IOException
-
writeAttrValue
- Throws:
IOException
-
writeTypedElement
public final void writeTypedElement(org.codehaus.stax2.ri.typed.AsciiValueEncoder enc) throws IOException Description copied from class:XmlWriter
LikeXmlWriter.writeRaw(java.lang.String, int, int)
, 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.- Specified by:
writeTypedElement
in classXmlWriter
- Parameters:
enc
- Encoder that will produce content- Throws:
IOException
-
writeTypedElement
public final void writeTypedElement(org.codehaus.stax2.ri.typed.AsciiValueEncoder enc, org.codehaus.stax2.validation.XMLValidator validator, char[] copyBuffer) throws IOException, XMLStreamException Description copied from class:XmlWriter
LikeXmlWriter.writeRaw(java.lang.String, int, int)
, 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.- Specified by:
writeTypedElement
in classXmlWriter
- Parameters:
enc
- Encoder that will produce contentvalidator
- Validator to use for validating serialized textual content (can not be null)copyBuffer
- Temporary buffer that writer can use for temporary copies as necessary- Throws:
IOException
XMLStreamException
-
writeTypedAttribute
public void writeTypedAttribute(String localName, org.codehaus.stax2.ri.typed.AsciiValueEncoder enc) throws IOException, XMLStreamException Description copied from class:XmlWriter
Method similar toXmlWriter.writeAttribute(String,String,char[],int,int)
but where is known not to require escaping. No validation needs to be performed.- Specified by:
writeTypedAttribute
in classXmlWriter
- Throws:
IOException
XMLStreamException
-
writeTypedAttribute
public void writeTypedAttribute(String prefix, String localName, org.codehaus.stax2.ri.typed.AsciiValueEncoder enc) throws IOException, XMLStreamException Description copied from class:XmlWriter
Method similar toXmlWriter.writeAttribute(String,String,char[],int,int)
but where is known not to require escaping. No validation needs to be performed.- Specified by:
writeTypedAttribute
in classXmlWriter
- Throws:
IOException
XMLStreamException
-
writeTypedAttribute
public void writeTypedAttribute(String prefix, String localName, String nsURI, org.codehaus.stax2.ri.typed.AsciiValueEncoder enc, org.codehaus.stax2.validation.XMLValidator validator, char[] copyBuffer) throws IOException, XMLStreamException Description copied from class:XmlWriter
Method similar toXmlWriter.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.- Specified by:
writeTypedAttribute
in classXmlWriter
- Throws:
IOException
XMLStreamException
-
writePrefixedName
- Throws:
IOException
-
flushBuffer
- Throws:
IOException
-
fastWriteRaw
- Throws:
IOException
-
fastWriteRaw
- Throws:
IOException
-
fastWriteRaw
- Throws:
IOException
-
verifyCDataContent
- Returns:
- Index at which a problem was found, if any; -1 if there's no problem.
-
verifyCDataContent
protected int verifyCDataContent(char[] c, int start, int end) -
verifyCommentContent
-
writeSegmentedCData
- Throws:
IOException
-
writeSegmentedCData
- Throws:
IOException
-
writeSegmentedComment
- Throws:
IOException
-
guessEncodingBitSize
Method used to figure out which part of the Unicode char set the encoding can natively support. Values returned are 7, 8 and 16, to indicate (respectively) "ascii", "ISO-Latin" and "native Unicode". These just best guesses, but should work ok for the most common encodings. -
writeAsEntity
- Throws:
IOException
-