aalto-xml 1.3.2 · com.fasterxml.aalto.out.CharXmlWriter

Modifier and Type	Field and Description
protected Writer	_out Actual Writer to use for outputting buffered data as appropriate.
protected char[]	_outputBuffer
protected final int	_outputBufferLen
protected int	_outputPtr
pack-priv static final int	DEFAULT_FULL_BUFFER_SIZE And this value determines size of the intermediate copy buffer to use.
pack-priv static final int	DEFAULT_SMALL_SIZE This value determines a threshold to choose how much data do we want to buffer at minimum, before output.
pack-priv final XmlCharTypes	mCharTypes Validation tables used for verifying validity (and need for quoting)
private final int	mEncHighChar First Unicode character (one with lowest value) after (and including) which character entities have to be used.
protected final int	mSmallWriteSize 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.
private final int	mTableCheckEnd First Unicode character that is NOT to be checked against static validity table.

Access	Constructor and Description
public	CharXmlWriter(WriterConfig cfg, Writer out)

Method Summary

Modifier and Type	Method and Description
public void	_closeTarget(boolean doClose) Implements abstract com.fasterxml.aalto.out.XmlWriter._closeTarget.
public void	_releaseBuffers() Overrides com.fasterxml.aalto.out.XmlWriter._releaseBuffers.
public WName	constructName(String localName) Implements abstract com.fasterxml.aalto.out.XmlWriter.constructName.
public WName	constructName(String prefix, String localName) Implements abstract com.fasterxml.aalto.out.XmlWriter.constructName.
private final void	fastWriteRaw(char c)
private final void	fastWriteRaw(char c1, char c2)
private final void	fastWriteRaw(String str)
public final void	flush() Implements abstract com.fasterxml.aalto.out.XmlWriter.flush.
private final void	flushBuffer()
public int	getHighestEncodable() Implements abstract com.fasterxml.aalto.out.XmlWriter.getHighestEncodable. Method called by error reporting code, to figure out if a given character is encodable (without using character entities) with the current encoding or not.
protected int	getOutputPtr() Implements abstract com.fasterxml.aalto.out.XmlWriter.getOutputPtr.
protected int	Returns: Index at which a problem was found, if any; -1 if there's no problem. verifyCDataContent(String content)
protected int	verifyCDataContent(char[] c, int start, int end)
protected int	verifyCommentContent(String content)
protected final void	writeAsEntity(int c)
public void	writeAttribute(WName name, String value) Implements abstract com.fasterxml.aalto.out.XmlWriter.writeAttribute. 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 void	writeAttribute(WName name, char[] value, int offset, int vlen) Implements abstract com.fasterxml.aalto.out.XmlWriter.writeAttribute.
public final void	writeAttribute(WName name, AsciiValueEncoder enc) Implements abstract com.fasterxml.aalto.out.XmlWriter.writeAttribute.
private final void	writeAttrValue(String value, int len)
private final void	writeAttrValue(char[] cbuf, int offset, int len)
public int	Returns: -1 to indicate succesful write, or index of the problematic character in input (first ']' from "]]>" sequence, in non-fixing mode) writeCData(String Contents of the CDATA section to write out data) Implements abstract com.fasterxml.aalto.out.XmlWriter.writeCData.
public int	writeCData(char[] cbuf, int offset, int len) Implements abstract com.fasterxml.aalto.out.XmlWriter.writeCData.
private int	writeCDataContents(char[] cbuf, int offset, int len)
public final void	writeCDataEnd()
public final void	writeCDataStart()
public void	writeCharacters(String text) Implements abstract com.fasterxml.aalto.out.XmlWriter.writeCharacters.
public void	writeCharacters(char[] cbuf, int offset, int len) Implements abstract com.fasterxml.aalto.out.XmlWriter.writeCharacters.
public int	writeComment(String data) Implements abstract com.fasterxml.aalto.out.XmlWriter.writeComment. Method that will try to output the content as specified.
private int	writeCommentContents(char[] cbuf, int offset, int len, boolean last) Note the only way to fix comment contents is to inject a space to split up consequtive '--' (or '-' that ends a comment).
public final void	writeCommentEnd()
public final void	writeCommentStart()
public void	writeDTD(String data) Implements abstract com.fasterxml.aalto.out.XmlWriter.writeDTD. Older "legacy" output method for outputting DOCTYPE declaration.
public void	writeDTD(WName rootName, String systemId, String publicId, String internalSubset) Implements abstract com.fasterxml.aalto.out.XmlWriter.writeDTD.
public void	writeEndTag(WName name) Implements abstract com.fasterxml.aalto.out.XmlWriter.writeEndTag.
public void	writeEntityReference(WName name) Implements abstract com.fasterxml.aalto.out.XmlWriter.writeEntityReference.
protected final void	writeName(WName name)
public int	writePI(WName target, String data) Implements abstract com.fasterxml.aalto.out.XmlWriter.writePI.
private int	writePIContents(char[] cbuf, int offset, int len)
public void	writeRaw(char[] cbuf, int offset, int len) Implements abstract com.fasterxml.aalto.out.XmlWriter.writeRaw.
public void	writeRaw(String str, int offset, int len) Implements abstract com.fasterxml.aalto.out.XmlWriter.writeRaw.
protected void	writeSegmentedCData(String content, int index)
protected void	writeSegmentedCData(char[] c, int start, int len, int index)
protected void	writeSegmentedComment(String content, int index)
public void	writeSpace(String data) Implements abstract com.fasterxml.aalto.out.XmlWriter.writeSpace.
public void	writeSpace(char[] cbuf, int offset, int len) Implements abstract com.fasterxml.aalto.out.XmlWriter.writeSpace.
private final void	writeSplitAttrValue(char[] cbuf, int offset, int len)
public void	writeStartTagEmptyEnd() Implements abstract com.fasterxml.aalto.out.XmlWriter.writeStartTagEmptyEnd.
public void	writeStartTagEnd() Implements abstract com.fasterxml.aalto.out.XmlWriter.writeStartTagEnd.
public void	writeStartTagStart(WName name) Implements abstract com.fasterxml.aalto.out.XmlWriter.writeStartTagStart. 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 void	writeTypedValue(AsciiValueEncoder enc) Implements abstract com.fasterxml.aalto.out.XmlWriter.writeTypedValue.
public void	writeXmlDeclaration(String version, String encoding, String standalone) Implements abstract com.fasterxml.aalto.out.XmlWriter.writeXmlDeclaration.

Inherited from com.fasterxml.aalto.out.XmlWriter:: close enableXml11 getAbsOffset getColumn getRow guessEncodingBitSize reportFailedEscaping reportInvalidChar reportInvalidEmptyName reportNwfContent reportNwfContent reportNwfName reportNwfName throwOutputError throwOutputError

_out	back to summary
protected Writer _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	back to summary
protected char[] _outputBuffer

_outputBufferLen	back to summary
protected final int _outputBufferLen

_outputPtr	back to summary
protected int _outputPtr

DEFAULT_FULL_BUFFER_SIZE	back to summary
pack-priv static final int DEFAULT_FULL_BUFFER_SIZE And this value determines size of the intermediate copy buffer to use.

DEFAULT_SMALL_SIZE	back to summary
pack-priv static final int DEFAULT_SMALL_SIZE This value determines a threshold to choose how much data do we want to buffer at minimum, before output. This is done since actual underlying writer may have significant per-call overhead, and if so, it is much cheaper to coalesce content. But on the other hand, this extra buffering has overhead of its own, so we'll try to find a sweet spot.

mCharTypes	back to summary
pack-priv final XmlCharTypes mCharTypes Validation tables used for verifying validity (and need for quoting)

mEncHighChar	back to summary
private final int mEncHighChar First Unicode character (one with lowest value) after (and including) which character entities have to be used.

mSmallWriteSize	back to summary
protected final int mSmallWriteSize 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.

mTableCheckEnd	back to summary
private final int mTableCheckEnd First Unicode character that is NOT to be checked against static validity table. Usually the size of check table, but lower for some encodings (like ascii)

CharXmlWriter	back to summary
public CharXmlWriter(WriterConfig cfg, Writer out)

Method Detail

_closeTarget	back to summary
public void _closeTarget(boolean doClose) throws IOException Implements abstract com.fasterxml.aalto.out.XmlWriter._closeTarget. Annotations @Override

_closeTarget

back to summary

public void _closeTarget(boolean doClose) throws IOException

Implements abstract com.fasterxml.aalto.out.XmlWriter._closeTarget.

Annotations

@Override

_releaseBuffers	back to summary
public void _releaseBuffers() Overrides com.fasterxml.aalto.out.XmlWriter._releaseBuffers. Annotations @Override

_releaseBuffers

back to summary

public void _releaseBuffers()

Overrides com.fasterxml.aalto.out.XmlWriter._releaseBuffers.

Annotations

@Override

constructName	back to summary
public WName constructName(String localName) Implements abstract com.fasterxml.aalto.out.XmlWriter.constructName. Annotations @Override

constructName

back to summary

public WName constructName(String localName)

Implements abstract com.fasterxml.aalto.out.XmlWriter.constructName.

Annotations

@Override

constructName	back to summary
public WName constructName(String prefix, String localName) Implements abstract com.fasterxml.aalto.out.XmlWriter.constructName. Annotations @Override

constructName

back to summary

public WName constructName(String prefix, String localName)

Implements abstract com.fasterxml.aalto.out.XmlWriter.constructName.

Annotations

@Override

fastWriteRaw	back to summary
private final void fastWriteRaw(char c) throws IOException

fastWriteRaw	back to summary
private final void fastWriteRaw(char c1, char c2) throws IOException

fastWriteRaw	back to summary
private final void fastWriteRaw(String str) throws IOException

flush	back to summary
public final void flush() throws IOException Implements abstract com.fasterxml.aalto.out.XmlWriter.flush. Annotations @Override

flush

back to summary

public final void flush() throws IOException

Implements abstract com.fasterxml.aalto.out.XmlWriter.flush.

Annotations

@Override

flushBuffer	back to summary
private final void flushBuffer() throws IOException

getHighestEncodable	back to summary
public int getHighestEncodable() Implements abstract com.fasterxml.aalto.out.XmlWriter.getHighestEncodable. Doc from com.fasterxml.aalto.out.XmlWriter.getHighestEncodable. Method called by error reporting code, to figure out if a given character is encodable (without using character entities) with the current encoding or not. Returns:int Character code of the highest character that can be natively encoded. Annotations @Override

getHighestEncodable

back to summary

public int getHighestEncodable()

Implements abstract com.fasterxml.aalto.out.XmlWriter.getHighestEncodable.

Doc from com.fasterxml.aalto.out.XmlWriter.getHighestEncodable.

Method called by error reporting code, to figure out if a given character is encodable (without using character entities) with the current encoding or not.

Returns:int

Character code of the highest character that can be natively encoded.

Annotations

@Override

getOutputPtr	back to summary
protected int getOutputPtr() Implements abstract com.fasterxml.aalto.out.XmlWriter.getOutputPtr. Annotations @Override

getOutputPtr

back to summary

protected int getOutputPtr()

Implements abstract com.fasterxml.aalto.out.XmlWriter.getOutputPtr.

Annotations

@Override

verifyCDataContent	back to summary
protected int verifyCDataContent(String content) Returns:int Index at which a problem was found, if any; -1 if there's no problem.

verifyCDataContent	back to summary
protected int verifyCDataContent(char[] c, int start, int end)

verifyCommentContent	back to summary
protected int verifyCommentContent(String content)

writeAsEntity	back to summary
protected final void writeAsEntity(int c) throws IOException

writeAttribute	back to summary
public void writeAttribute(WName name, String value) throws IOException, XMLStreamException Implements abstract com.fasterxml.aalto.out.XmlWriter.writeAttribute. Doc from com.fasterxml.aalto.out.XmlWriter.writeAttribute. 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) Annotations @Override

writeAttribute

back to summary

public void writeAttribute(WName name, String value) throws IOException, XMLStreamException

Implements abstract com.fasterxml.aalto.out.XmlWriter.writeAttribute.

Doc from com.fasterxml.aalto.out.XmlWriter.writeAttribute.

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)

Annotations

@Override

writeAttribute	back to summary
public void writeAttribute(WName name, char[] value, int offset, int vlen) throws IOException, XMLStreamException Implements abstract com.fasterxml.aalto.out.XmlWriter.writeAttribute. Annotations @Override

writeAttribute

back to summary

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

Implements abstract com.fasterxml.aalto.out.XmlWriter.writeAttribute.

Annotations

@Override

writeAttribute	back to summary
public final void writeAttribute(WName name, AsciiValueEncoder enc) throws IOException, XMLStreamException Implements abstract com.fasterxml.aalto.out.XmlWriter.writeAttribute. Annotations @Override

writeAttribute

back to summary

public final void writeAttribute(WName name, AsciiValueEncoder enc) throws IOException, XMLStreamException

Implements abstract com.fasterxml.aalto.out.XmlWriter.writeAttribute.

Annotations

@Override

writeAttrValue	back to summary
private final void writeAttrValue(String value, int len) throws IOException, XMLStreamException

writeAttrValue	back to summary
private final void writeAttrValue(char[] cbuf, int offset, int len) throws IOException, XMLStreamException

writeCData	back to summary
public int writeCData(String data) throws IOException, XMLStreamException Implements abstract com.fasterxml.aalto.out.XmlWriter.writeCData. Parameters data:String Doc from com.fasterxml.aalto.out.XmlWriter.writeCData. Contents of the CDATA section to write out Returns:int -1 to indicate succesful write, or index of the problematic character in input (first ']' from "]]>" sequence, in non-fixing mode) Annotations @Override

writeCData

back to summary

public int writeCData(String data) throws IOException, XMLStreamException

Implements abstract com.fasterxml.aalto.out.XmlWriter.writeCData.

Parameters

data:String

Doc from com.fasterxml.aalto.out.XmlWriter.writeCData.

Contents of the CDATA section to write out

Returns:int

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

Annotations

@Override

writeCData	back to summary
public int writeCData(char[] cbuf, int offset, int len) throws IOException, XMLStreamException Implements abstract com.fasterxml.aalto.out.XmlWriter.writeCData. Annotations @Override

writeCData

back to summary

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

Implements abstract com.fasterxml.aalto.out.XmlWriter.writeCData.

Annotations

@Override

writeCDataContents	back to summary
private int writeCDataContents(char[] cbuf, int offset, int len) throws IOException, XMLStreamException

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

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

writeCharacters	back to summary
public void writeCharacters(String text) throws IOException, XMLStreamException Implements abstract com.fasterxml.aalto.out.XmlWriter.writeCharacters. Annotations @Override

writeCharacters

back to summary

public void writeCharacters(String text) throws IOException, XMLStreamException

Implements abstract com.fasterxml.aalto.out.XmlWriter.writeCharacters.

Annotations

@Override

writeCharacters	back to summary
public void writeCharacters(char[] cbuf, int offset, int len) throws IOException, XMLStreamException Implements abstract com.fasterxml.aalto.out.XmlWriter.writeCharacters. Annotations @Override

writeCharacters

back to summary

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

Implements abstract com.fasterxml.aalto.out.XmlWriter.writeCharacters.

Annotations

@Override

writeComment	back to summary
public int writeComment(String data) throws IOException, XMLStreamException Implements abstract com.fasterxml.aalto.out.XmlWriter.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. Annotations @Override

writeComment

back to summary

public int writeComment(String data) throws IOException, XMLStreamException

Implements abstract com.fasterxml.aalto.out.XmlWriter.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.

Annotations

@Override

writeCommentContents	back to summary
private int writeCommentContents(char[] cbuf, int offset, int len, boolean last) throws IOException, XMLStreamException Note the only way to fix comment contents is to inject a space to split up consequtive '--' (or '-' that ends a comment).

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

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

writeDTD	back to summary
public void writeDTD(String data) throws IOException, XMLStreamException Implements abstract com.fasterxml.aalto.out.XmlWriter.writeDTD. Doc from com.fasterxml.aalto.out.XmlWriter.writeDTD. Older "legacy" output method for outputting DOCTYPE declaration. Assumes that the passed-in String contains a complete DOCTYPE declaration properly quoted. Annotations @Override

writeDTD

back to summary

public void writeDTD(String data) throws IOException, XMLStreamException

Implements abstract com.fasterxml.aalto.out.XmlWriter.writeDTD.

Doc from com.fasterxml.aalto.out.XmlWriter.writeDTD.

Older "legacy" output method for outputting DOCTYPE declaration. Assumes that the passed-in String contains a complete DOCTYPE declaration properly quoted.

Annotations

@Override

writeDTD	back to summary
public void writeDTD(WName rootName, String systemId, String publicId, String internalSubset) throws IOException, XMLStreamException Implements abstract com.fasterxml.aalto.out.XmlWriter.writeDTD. Annotations @Override

writeDTD

back to summary

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

Implements abstract com.fasterxml.aalto.out.XmlWriter.writeDTD.

Annotations

@Override

writeEndTag	back to summary
public void writeEndTag(WName name) throws IOException, XMLStreamException Implements abstract com.fasterxml.aalto.out.XmlWriter.writeEndTag. Annotations @Override

writeEndTag

back to summary

public void writeEndTag(WName name) throws IOException, XMLStreamException

Implements abstract com.fasterxml.aalto.out.XmlWriter.writeEndTag.

Annotations

@Override

writeEntityReference	back to summary
public void writeEntityReference(WName name) throws IOException, XMLStreamException Implements abstract com.fasterxml.aalto.out.XmlWriter.writeEntityReference. Annotations @Override

writeEntityReference

back to summary

public void writeEntityReference(WName name) throws IOException, XMLStreamException

Implements abstract com.fasterxml.aalto.out.XmlWriter.writeEntityReference.

Annotations

@Override

writeName	back to summary
protected final void writeName(WName name) throws IOException

writePI

back to summary

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

Implements abstract com.fasterxml.aalto.out.XmlWriter.writePI.

Annotations

@Override

writePIContents	back to summary
private int writePIContents(char[] cbuf, int offset, int len) throws IOException, XMLStreamException

writeRaw

back to summary

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

Implements abstract com.fasterxml.aalto.out.XmlWriter.writeRaw.

Annotations

@Override

writeRaw

back to summary

public void writeRaw(String str, int offset, int len) throws IOException

Implements abstract com.fasterxml.aalto.out.XmlWriter.writeRaw.

Annotations

@Override

writeSegmentedCData	back to summary
protected void writeSegmentedCData(String content, int index) throws IOException

writeSegmentedCData	back to summary
protected void writeSegmentedCData(char[] c, int start, int len, int index) throws IOException

writeSegmentedComment	back to summary
protected void writeSegmentedComment(String content, int index) throws IOException

writeSpace

back to summary

public void writeSpace(String data) throws IOException, XMLStreamException

Implements abstract com.fasterxml.aalto.out.XmlWriter.writeSpace.

Annotations

@Override

writeSpace

back to summary

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

Implements abstract com.fasterxml.aalto.out.XmlWriter.writeSpace.

Annotations

@Override

writeSplitAttrValue	back to summary
private final void writeSplitAttrValue(char[] cbuf, int offset, int len) throws IOException, XMLStreamException

writeStartTagEmptyEnd

back to summary

public void writeStartTagEmptyEnd() throws IOException

Implements abstract com.fasterxml.aalto.out.XmlWriter.writeStartTagEmptyEnd.

Annotations

@Override

writeStartTagEnd

back to summary

public void writeStartTagEnd() throws IOException, XMLStreamException

Implements abstract com.fasterxml.aalto.out.XmlWriter.writeStartTagEnd.

Annotations

@Override

writeStartTagStart

back to summary

public void writeStartTagStart(WName name) throws IOException, XMLStreamException

Implements abstract com.fasterxml.aalto.out.XmlWriter.writeStartTagStart.

Doc from com.fasterxml.aalto.out.XmlWriter.writeStartTagStart.

Note

Annotations

@Override

writeTypedValue

back to summary

public void writeTypedValue(AsciiValueEncoder enc) throws IOException, XMLStreamException

Implements abstract com.fasterxml.aalto.out.XmlWriter.writeTypedValue.

Annotations

@Override

writeXmlDeclaration

back to summary

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

Implements abstract com.fasterxml.aalto.out.XmlWriter.writeXmlDeclaration.

Annotations

@Override

public final Class CharXmlWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail