Package com.fasterxml.aalto.out

Class ByteXmlWriter

java.lang.Object

com.fasterxml.aalto.out.WNameFactory

com.fasterxml.aalto.out.XmlWriter

com.fasterxml.aalto.out.ByteXmlWriter

Direct Known Subclasses:

SingleByteXmlWriter, Utf8XmlWriter

public abstract class ByteXmlWriter
extends XmlWriter

This abstract base class (partial implementation of XmlWriter) is used if the destination is byte-based OutputStream.

Further, all existing implementations are for encodings that are 7-bit ascii compatible. This is important since this means that marker and separator characters are identical independent of actual encoding. This would not hold if support for encodings like EBCDIC were supported using this class.

Field Summary

Fields

Modifier and Type	Field	Description
protected final XmlCharTypes	_charTypes	Validation tables used for verifying validity (and need for quoting)
protected OutputStream	_out	Actual Writer to use for outputting buffered data as appropriate.
protected byte[]	_outputBuffer
protected final int	_outputBufferLen
protected int	_outputPtr
protected int	_surrogate	In case a split surrogate pair is output (which can occur for only some of the methods, possibly depending on encoding), the first part is temporarily stored within this member variable.
(package private) static final byte	BYTE_A
(package private) static final byte	BYTE_AMP
(package private) static final byte	BYTE_APOS
(package private) static final byte	BYTE_COLON
(package private) static final byte	BYTE_EQ
(package private) static final byte	BYTE_G
(package private) static final byte	BYTE_GT
(package private) static final byte	BYTE_HASH
(package private) static final byte	BYTE_HYPHEN
(package private) static final byte	BYTE_L
(package private) static final byte	BYTE_LBRACKET
(package private) static final byte	BYTE_LT
(package private) static final byte	BYTE_M
(package private) static final byte	BYTE_O
(package private) static final byte	BYTE_P
(package private) static final byte	BYTE_Q
(package private) static final byte	BYTE_QMARK
(package private) static final byte	BYTE_QUOT
(package private) static final byte	BYTE_RBRACKET
(package private) static final byte	BYTE_S
(package private) static final byte	BYTE_SEMICOLON
(package private) static final byte	BYTE_SLASH
(package private) static final byte	BYTE_SPACE
(package private) static final byte	BYTE_T
(package private) static final byte	BYTE_U
(package private) static final byte	BYTE_X
(package private) static final byte[]	BYTES_CDATA_END
(package private) static final byte[]	BYTES_CDATA_START
(package private) static final byte[]	BYTES_COMMENT_END
(package private) static final byte[]	BYTES_COMMENT_START
(package private) static final byte[]	BYTES_XMLDECL_ENCODING
(package private) static final byte[]	BYTES_XMLDECL_STANDALONE
(package private) static final byte[]	BYTES_XMLDECL_START
(package private) static final int	DEFAULT_COPY_BUFFER_SIZE	Default intermediate copy buffer size, to be used for efficient access to String content.
(package private) static final int	DEFAULT_FULL_BUFFER_SIZE	And this value determines size of the intermediate copy buffer to use.
(package private) static final int	SMALL_WRITE	Let's try avoid short writes, since some output streams have high per-call penalty (like network streams).

Fields inherited from class com.fasterxml.aalto.out.XmlWriter

_cfgNsAware, _checkContent, _checkNames, _config, _copyBuffer, _copyBufferLen, _locPastChars, _locRowNr, _locRowStartOffset, _xml11, ATTR_MIN_ARRAYCOPY, DEFAULT_COPYBUFFER_LEN, MIN_ARRAYCOPY, SURR1_FIRST, SURR1_LAST, SURR2_FIRST, SURR2_LAST

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ByteXmlWriter(WriterConfig cfg, OutputStream out, XmlCharTypes charTypes)

Method Summary

Modifier and Type	Method	Description
void	_closeTarget(boolean doClose)
void	_releaseBuffers()
protected final int	calcSurrogate(int surr1, int surr2, String context)
final WName	constructName(String localName)
WName	constructName(String prefix, String localName)
protected abstract WName	doConstructName(String localName)
protected abstract WName	doConstructName(String prefix, String localName)
protected final int	fastWriteAttrValue(char[] vbuf, int offset, int len, byte[] bbuf, int ptr)	Method called to copy given attribute value, when it's known that it will completely fit in the output buffer without further checks
final void	flush()
protected final void	flushBuffer()
protected static final byte[]	getAscii(String str)
protected static final void	getAscii(String str, byte[] result)
protected static final void	getAscii(String str, byte[] result, int offset)
protected final int	getOutputPtr()
private final void	longWriteCharacters(String text)
protected abstract void	output2ByteChar(int ch)
protected abstract int	outputMultiByteChar(int ch, char[] cbuf, int inputOffset, int inputLen)	Method called to output a character beyond basic 1- or 2-byte encoding (code 0x0800 and above); possibly using character entities, if necessary
protected abstract int	outputStrictMultiByteChar(int ch, char[] cbuf, int inputOffset, int inputLen)	Method called to output a character beyond basic 1- or 2-byte encoding (code 0x0800 and above), without being able to use character entities
protected abstract void	outputSurrogates(int surr1, int surr2)	Method called to output a composite character, result of combining 2 surrogate characters.
protected final void	throwUnpairedSurrogate()
protected final void	throwUnpairedSurrogate(int code)
protected void	verifyNameComponent(String part)	Method used to verify that a name component (prefix, local name) is a legal as per xml 1.0 specification.
protected final void	writeAsEntity(int c)
final void	writeAttribute(WName name, char[] vbuf, int offset, int vlen)
final void	writeAttribute(WName name, 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)
final void	writeAttribute(WName name, org.codehaus.stax2.ri.typed.AsciiValueEncoder enc)
private final void	writeAttrNameEqQ(WName name)
protected final void	writeAttrValue(char[] vbuf, int offset, int len)
int	writeCData(char[] cbuf, int offset, int len)
int	writeCData(String data)
protected int	writeCDataContents(char[] cbuf, int offset, int len)
protected final void	writeCDataEnd()
protected final void	writeCDataStart()
final void	writeCharacters(char[] cbuf, int offset, int len)
final void	writeCharacters(String text)
int	writeComment(String data)	Method that will try to output the content as specified.
protected int	writeCommentContents(char[] cbuf, int offset, int len)	Note: the only way to fix comment contents is to inject a space to split up consecutive '--' (or '-' that ends a comment).
protected final void	writeCommentEnd()
protected final void	writeCommentStart()
void	writeDTD(WName rootName, String systemId, String publicId, String internalSubset)
void	writeDTD(String data)	Older "legacy" output method for outputting DOCTYPE declaration.
final void	writeEndTag(WName name)
void	writeEntityReference(WName name)
protected final void	writeLongAttribute(WName name, String value, int vlen)
protected final void	writeName(byte preChar, WName name)
protected final void	writeName(WName name)
protected final void	writeName(WName name, byte postChar)
int	writePI(WName target, String data)
protected int	writePIData(char[] cbuf, int offset, int len)
protected final void	writeRaw(byte b)
protected final void	writeRaw(byte[] buf)
protected final void	writeRaw(byte[] buf, int offset, int len)
protected final void	writeRaw(byte b1, byte b2)
abstract void	writeRaw(char[] cbuf, int offset, int len)	This method is heavily encoding-dependant, so it needs to be deferred to sub-classes
final void	writeRaw(String text, int offset, int len)
void	writeSpace(char[] cbuf, int offset, int len)
final void	writeSpace(String data)
private final void	writeSplitCharacters(char[] cbuf, int offset, int len)	This method is called when it is possible that the output may cross the output buffer boundary.
void	writeStartTagEmptyEnd()
final void	writeStartTagEnd()
final void	writeStartTagStart(WName name)	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	writeTypedValue(org.codehaus.stax2.ri.typed.AsciiValueEncoder enc)
void	writeXmlDeclaration(String version, String encoding, String standalone)

Methods inherited from class com.fasterxml.aalto.out.XmlWriter

close, enableXml11, getAbsOffset, getColumn, getHighestEncodable, getRow, guessEncodingBitSize, reportFailedEscaping, reportInvalidChar, reportInvalidEmptyName, reportNwfContent, reportNwfContent, reportNwfName, reportNwfName, throwOutputError, throwOutputError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_FULL_BUFFER_SIZE

static final int DEFAULT_FULL_BUFFER_SIZE

And this value determines size of the intermediate copy buffer to use.

See Also:

• Constant Field Values

DEFAULT_COPY_BUFFER_SIZE

static final int DEFAULT_COPY_BUFFER_SIZE

Default intermediate copy buffer size, to be used for efficient access to String content. Smaller, since it's in characters, plus will not be used for actual write operations

See Also:

• Constant Field Values

SMALL_WRITE

static final int SMALL_WRITE

Let's try avoid short writes, since some output streams have high per-call penalty (like network streams).

See Also:

• Constant Field Values

BYTE_SPACE

static final byte BYTE_SPACE

See Also:

• Constant Field Values

BYTE_COLON

static final byte BYTE_COLON

See Also:

• Constant Field Values

BYTE_SEMICOLON

static final byte BYTE_SEMICOLON

See Also:

• Constant Field Values

BYTE_LBRACKET

static final byte BYTE_LBRACKET

See Also:

• Constant Field Values

BYTE_RBRACKET

static final byte BYTE_RBRACKET

See Also:

• Constant Field Values

BYTE_QMARK

static final byte BYTE_QMARK

See Also:

• Constant Field Values

BYTE_EQ

static final byte BYTE_EQ

See Also:

• Constant Field Values

BYTE_SLASH

static final byte BYTE_SLASH

See Also:

• Constant Field Values

BYTE_HASH

static final byte BYTE_HASH

See Also:

• Constant Field Values

BYTE_HYPHEN

static final byte BYTE_HYPHEN

See Also:

• Constant Field Values

BYTE_LT

static final byte BYTE_LT

See Also:

• Constant Field Values

BYTE_GT

static final byte BYTE_GT

See Also:

• Constant Field Values

BYTE_AMP

static final byte BYTE_AMP

See Also:

• Constant Field Values

BYTE_QUOT

static final byte BYTE_QUOT

See Also:

• Constant Field Values

BYTE_APOS

static final byte BYTE_APOS

See Also:

• Constant Field Values

BYTE_A

static final byte BYTE_A

See Also:

• Constant Field Values

BYTE_G

static final byte BYTE_G

See Also:

• Constant Field Values

BYTE_L

static final byte BYTE_L

See Also:

• Constant Field Values

BYTE_M

static final byte BYTE_M

See Also:

• Constant Field Values

BYTE_O

static final byte BYTE_O

See Also:

• Constant Field Values

BYTE_P

static final byte BYTE_P

See Also:

• Constant Field Values

BYTE_Q

static final byte BYTE_Q

See Also:

• Constant Field Values

BYTE_S

static final byte BYTE_S

See Also:

• Constant Field Values

BYTE_T

static final byte BYTE_T

See Also:

• Constant Field Values

BYTE_U

static final byte BYTE_U

See Also:

• Constant Field Values

BYTE_X

static final byte BYTE_X

See Also:

• Constant Field Values

BYTES_CDATA_START

static final byte[] BYTES_CDATA_START

BYTES_CDATA_END

static final byte[] BYTES_CDATA_END

BYTES_COMMENT_START

static final byte[] BYTES_COMMENT_START

BYTES_COMMENT_END

static final byte[] BYTES_COMMENT_END

BYTES_XMLDECL_START

static final byte[] BYTES_XMLDECL_START

BYTES_XMLDECL_ENCODING

static final byte[] BYTES_XMLDECL_ENCODING

BYTES_XMLDECL_STANDALONE

static final byte[] BYTES_XMLDECL_STANDALONE

_out

protected OutputStream _out

Actual Writer to use for outputting buffered data as appropriate. During active usage, remains as the writer initially set; set to null when this writer is closed.

_outputBuffer

protected byte[] _outputBuffer

_outputPtr

protected int _outputPtr

_outputBufferLen

protected final int _outputBufferLen

_surrogate

protected int _surrogate

In case a split surrogate pair is output (which can occur for only some of the methods, possibly depending on encoding), the first part is temporarily stored within this member variable.

_charTypes

protected final XmlCharTypes _charTypes

Validation tables used for verifying validity (and need for quoting)

Constructor Details

ByteXmlWriter

protected ByteXmlWriter(WriterConfig cfg,
 OutputStream out,
 XmlCharTypes charTypes)

Method Details

getOutputPtr

protected final int getOutputPtr()

Specified by:

getOutputPtr in class XmlWriter

constructName

public final WName constructName(String localName)
                          throws XMLStreamException

Specified by:

constructName in class XmlWriter

Throws:

XMLStreamException

constructName

public WName constructName(String prefix,
 String localName)
                    throws XMLStreamException

Specified by:

constructName in class XmlWriter

Throws:

XMLStreamException

doConstructName

protected abstract WName doConstructName(String localName)
                                  throws XMLStreamException

Throws:

XMLStreamException

doConstructName

protected abstract WName doConstructName(String prefix,
 String localName)
                                  throws XMLStreamException

Throws:

XMLStreamException

verifyNameComponent

protected void verifyNameComponent(String part)
                            throws XMLStreamException

Method used to verify that a name component (prefix, local name) is a legal as per xml 1.0 specification.

Throws:

IllegalArgumentException - If name component contains an invalid (non-name; or for the initial characters, non-name-first) character.

XMLStreamException

outputSurrogates

protected abstract void outputSurrogates(int surr1,
 int surr2)
                                  throws IOException,
XMLStreamException

Method called to output a composite character, result of combining 2 surrogate characters.

Throws:

IOException

XMLStreamException

output2ByteChar

protected abstract void output2ByteChar(int ch)
                                 throws IOException,
XMLStreamException

Throws:

IOException

XMLStreamException

outputStrictMultiByteChar

protected abstract int outputStrictMultiByteChar(int ch,
 char[] cbuf,
 int inputOffset,
 int inputLen)
                                          throws IOException,
XMLStreamException

Method called to output a character beyond basic 1- or 2-byte encoding (code 0x0800 and above), without being able to use character entities

Throws:

IOException

XMLStreamException

outputMultiByteChar

protected abstract int outputMultiByteChar(int ch,
 char[] cbuf,
 int inputOffset,
 int inputLen)
                                    throws IOException,
XMLStreamException

Method called to output a character beyond basic 1- or 2-byte encoding (code 0x0800 and above); possibly using character entities, if necessary

Throws:

IOException

XMLStreamException

_releaseBuffers

public void _releaseBuffers()

Overrides:

_releaseBuffers in class XmlWriter

_closeTarget

public void _closeTarget(boolean doClose)
                  throws IOException

Specified by:

_closeTarget in class XmlWriter

Throws:

IOException

flush

public final void flush()
                 throws IOException

Specified by:

flush in class XmlWriter

Throws:

IOException

writeRaw

public final void writeRaw(String text,
 int offset,
 int len)
                    throws IOException,
XMLStreamException

Specified by:

writeRaw in class XmlWriter

Throws:

IOException

XMLStreamException

writeRaw

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

This method is heavily encoding-dependant, so it needs to be deferred to sub-classes

Specified by:

writeRaw in class XmlWriter

Throws:

IOException

XMLStreamException

writeStartTagStart

public final void writeStartTagStart(WName name)
                              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 class XmlWriter

Throws:

IOException

XMLStreamException

writeStartTagEnd

public final void writeStartTagEnd()
                            throws IOException,
XMLStreamException

Specified by:

writeStartTagEnd in class XmlWriter

Throws:

IOException

XMLStreamException

writeStartTagEmptyEnd

public void writeStartTagEmptyEnd()
                           throws IOException

Specified by:

writeStartTagEmptyEnd in class XmlWriter

Throws:

IOException

writeEndTag

public final void writeEndTag(WName name)
                       throws IOException,
XMLStreamException

Specified by:

writeEndTag in class XmlWriter

Throws:

IOException

XMLStreamException

writeAttribute

public final void writeAttribute(WName name,
 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 class XmlWriter

Throws:

IOException

XMLStreamException

writeAttribute

public final void writeAttribute(WName name,
 char[] vbuf,
 int offset,
 int vlen)
                          throws IOException,
XMLStreamException

Specified by:

writeAttribute in class XmlWriter

Throws:

IOException

XMLStreamException

fastWriteAttrValue

protected final int fastWriteAttrValue(char[] vbuf,
 int offset,
 int len,
 byte[] bbuf,
 int ptr)
                                throws IOException,
XMLStreamException

Method called to copy given attribute value, when it's known that it will completely fit in the output buffer without further checks

Throws:

IOException

XMLStreamException

writeAttrValue

protected final void writeAttrValue(char[] vbuf,
 int offset,
 int len)
                             throws IOException,
XMLStreamException

Throws:

IOException

XMLStreamException

writeLongAttribute

protected final void writeLongAttribute(WName name,
 String value,
 int vlen)
                                 throws IOException,
XMLStreamException

Throws:

IOException

XMLStreamException

writeName

protected final void writeName(WName name)
                        throws IOException

Throws:

IOException

writeName

protected final void writeName(byte preChar,
 WName name)
                        throws IOException

Throws:

IOException

writeName

protected final void writeName(WName name,
 byte postChar)
                        throws IOException

Throws:

IOException

writeAttrNameEqQ

private final void writeAttrNameEqQ(WName name)
                             throws IOException,
XMLStreamException

Throws:

IOException

XMLStreamException

writeCData

public int writeCData(String data)
               throws IOException,
XMLStreamException

Specified by:

writeCData in class XmlWriter

Parameters:

data - Contents of the CDATA section to write out

Returns:

-1 to indicate succesful write, or index of the problematic character in input (first ']' from "]]>" sequence, in non-fixing mode)

Throws:

IOException

XMLStreamException

writeCData

public int writeCData(char[] cbuf,
 int offset,
 int len)
               throws IOException,
XMLStreamException

Specified by:

writeCData in class XmlWriter

Throws:

IOException

XMLStreamException

writeCDataContents

protected int writeCDataContents(char[] cbuf,
 int offset,
 int len)
                          throws IOException,
XMLStreamException

Throws:

IOException

XMLStreamException

writeCharacters

public final void writeCharacters(String text)
                           throws IOException,
XMLStreamException

Specified by:

writeCharacters in class XmlWriter

Throws:

IOException

XMLStreamException

longWriteCharacters

private final void longWriteCharacters(String text)
                                throws IOException,
XMLStreamException

Throws:

IOException

XMLStreamException

writeCharacters

public final void writeCharacters(char[] cbuf,
 int offset,
 int len)
                           throws IOException,
XMLStreamException

Specified by:

writeCharacters in class XmlWriter

Throws:

IOException

XMLStreamException

writeSplitCharacters

private final void writeSplitCharacters(char[] cbuf,
 int offset,
 int len)
                                 throws IOException,
XMLStreamException

This method is called when it is possible that the output may cross the output buffer boundary. Because of this, code has to add more boundary checks.

Throws:

IOException

XMLStreamException

writeTypedValue

public void writeTypedValue(org.codehaus.stax2.ri.typed.AsciiValueEncoder enc)
                     throws IOException,
XMLStreamException

Specified by:

writeTypedValue in class XmlWriter

Throws:

IOException

XMLStreamException

writeAttribute

public final void writeAttribute(WName name,
 org.codehaus.stax2.ri.typed.AsciiValueEncoder enc)
                          throws IOException,
XMLStreamException

Specified by:

writeAttribute in class XmlWriter

Throws:

IOException

XMLStreamException

writeComment

public 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.

Specified by:

writeComment in class XmlWriter

Throws:

IOException

XMLStreamException

writeCommentContents

protected int writeCommentContents(char[] cbuf,
 int offset,
 int len)
                            throws IOException,
XMLStreamException

Note: the only way to fix comment contents is to inject a space to split up consecutive '--' (or '-' that ends a comment).

Throws:

IOException

XMLStreamException

writeDTD

public void writeDTD(String data)
              throws IOException,
XMLStreamException

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 class XmlWriter

Throws:

IOException

XMLStreamException

writeDTD

public void writeDTD(WName rootName,
 String systemId,
 String publicId,
 String internalSubset)
              throws IOException,
XMLStreamException

Specified by:

writeDTD in class XmlWriter

Throws:

IOException

XMLStreamException

writePIData

protected int writePIData(char[] cbuf,
 int offset,
 int len)
                   throws IOException,
XMLStreamException

Throws:

IOException

XMLStreamException

writeEntityReference

public void writeEntityReference(WName name)
                          throws IOException,
XMLStreamException

Specified by:

writeEntityReference in class XmlWriter

Throws:

IOException

XMLStreamException

writePI

public int writePI(WName target,
 String data)
            throws IOException,
XMLStreamException

Specified by:

writePI in class XmlWriter

Throws:

IOException

XMLStreamException

writeSpace

public final void writeSpace(String data)
                      throws IOException,
XMLStreamException

Specified by:

writeSpace in class XmlWriter

Throws:

IOException

XMLStreamException

writeSpace

public void writeSpace(char[] cbuf,
 int offset,
 int len)
                throws IOException,
XMLStreamException

Specified by:

writeSpace in class XmlWriter

Throws:

IOException

XMLStreamException

writeXmlDeclaration

public void writeXmlDeclaration(String version,
 String encoding,
 String standalone)
                         throws IOException,
XMLStreamException

Specified by:

writeXmlDeclaration in class XmlWriter

Throws:

IOException

XMLStreamException

writeCDataStart

protected final void writeCDataStart()
                              throws IOException

Throws:

IOException

writeCDataEnd

protected final void writeCDataEnd()
                            throws IOException

Throws:

IOException

writeCommentStart

protected final void writeCommentStart()
                                throws IOException

Throws:

IOException

writeCommentEnd

protected final void writeCommentEnd()
                              throws IOException

Throws:

IOException

writeRaw

protected final void writeRaw(byte b)
                       throws IOException

Throws:

IOException

writeRaw

protected final void writeRaw(byte b1,
 byte b2)
                       throws IOException

Throws:

IOException

writeRaw

protected final void writeRaw(byte[] buf)
                       throws IOException

Throws:

IOException

writeRaw

protected final void writeRaw(byte[] buf,
 int offset,
 int len)
                       throws IOException

Throws:

IOException

throwUnpairedSurrogate

protected final void throwUnpairedSurrogate()
                                     throws IOException

Throws:

IOException

throwUnpairedSurrogate

protected final void throwUnpairedSurrogate(int code)
                                     throws IOException

Throws:

IOException

flushBuffer

protected final void flushBuffer()
                          throws IOException

Throws:

IOException

writeAsEntity

protected final void writeAsEntity(int c)
                            throws IOException

Throws:

IOException

calcSurrogate

protected final int calcSurrogate(int surr1,
 int surr2,
 String context)
                           throws XMLStreamException

Throws:

XMLStreamException

getAscii

protected static final byte[] getAscii(String str)

getAscii

protected static final void getAscii(String str,
 byte[] result)

getAscii

protected static final void getAscii(String str,
 byte[] result,
 int offset)