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

Field Summary

Modifier and Type	Field and Description
protected final boolean	_cfgNsAware
protected final boolean	_checkContent
protected final boolean	_checkNames
protected final WriterConfig	_config
protected char[]	_copyBuffer Intermediate buffer, in which content (esp.
protected final int	_copyBufferLen
protected int	_locPastChars Number of characters output prior to currently buffered output
protected int	_locRowNr
protected int	_locRowStartOffset Offset of the first character on this line.
protected boolean	_xml11 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	ATTR_MIN_ARRAYCOPY
protected static final int	DEFAULT_COPYBUFFER_LEN
protected static final int	MIN_ARRAYCOPY
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)

Method Summary

Modifier and Type	Method and Description
public abstract void	_closeTarget(boolean doClose)
public void	_releaseBuffers()
public final void	close(boolean forceTargetClose) Method called to flush the buffer(s), and close the output sink (stream or writer).
public abstract WName	constructName(String localName) Implements abstract com.fasterxml.aalto.out.WNameFactory.constructName.
public abstract WName	constructName(String prefix, String localName) Implements abstract com.fasterxml.aalto.out.WNameFactory.constructName.
public void	enableXml11()
public abstract void	flush()
public int	getAbsOffset()
public int	getColumn()
public abstract int	Returns: Character code of the highest character that can be natively encoded. 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 abstract int	getOutputPtr()
public int	getRow()
public static final int	guessEncodingBitSize(WriterConfig cfg) Method used to figure out which part of the Unicode char set the encoding can natively support.
protected void	reportFailedEscaping(String type, int ch)
protected void	reportInvalidChar(int c)
protected void	reportInvalidEmptyName()
protected void	reportNwfContent(String msg)
protected void	reportNwfContent(String format, Object arg1, Object arg2)
protected void	reportNwfName(String msg) This is the method called when an output method call violates name well-formedness checks and name validation is enabled.
protected void	reportNwfName(String msg, Object arg)
protected void	throwOutputError(String msg)
protected void	throwOutputError(String format, Object arg)
public abstract 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)
public abstract void	writeAttribute(WName name, char[] value, int offset, int len)
public abstract void	writeAttribute(WName name, AsciiValueEncoder enc)
public abstract int	Returns: offset of the (first) illegal content segment ("]]>") in passed content, if not in repairing mode; or -1 if none writeCData(String Contents of the CDATA section to write out data)
public abstract int	writeCData(char[] cbuf, int offset, int len)
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	writeDTD(String data) Older "legacy" output method for outputting DOCTYPE declaration.
public abstract void	writeDTD(WName rootName, String systemId, String publicId, String internalSubset)
public abstract void	writeEndTag(WName name)
public abstract void	writeEntityReference(WName name)
public abstract int	writePI(WName target, String data)
public abstract void	writeRaw(String str, int offset, int len)
public abstract void	writeRaw(char[] cbuf, int offset, int len)
public abstract void	writeSpace(String data)
public abstract void	writeSpace(char[] cbuf, int offset, int len)
public abstract void	writeStartTagEmptyEnd()
public abstract void	writeStartTagEnd()
public abstract 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)
public abstract void	writeTypedValue(AsciiValueEncoder enc)
public abstract void	writeXmlDeclaration(String version, String enc, String standalone)

Field Detail

_cfgNsAware	back to summary
protected final boolean _cfgNsAware

_checkContent	back to summary
protected final boolean _checkContent

_checkNames	back to summary
protected final boolean _checkNames

_config	back to summary
protected final WriterConfig _config

_copyBuffer	back to summary
protected char[] _copyBuffer Intermediate buffer, in which content (esp. Strings) can be copied to, before being output.

_copyBufferLen	back to summary
protected final int _copyBufferLen

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

_locRowNr	back to summary
protected int _locRowNr

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

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

ATTR_MIN_ARRAYCOPY	back to summary
protected static final int ATTR_MIN_ARRAYCOPY

DEFAULT_COPYBUFFER_LEN	back to summary
protected static final int DEFAULT_COPYBUFFER_LEN

MIN_ARRAYCOPY	back to summary
protected static final int MIN_ARRAYCOPY

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)

Method Detail

_closeTarget	back to summary
public abstract void _closeTarget(boolean doClose) throws IOException

_releaseBuffers	back to summary
public void _releaseBuffers()

close	back to summary
public final void close(boolean forceTargetClose) throws IOException Method called to flush the buffer(s), and close the output sink (stream or writer).

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

constructName

back to summary

public abstract WName constructName(String localName) throws XMLStreamException

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

Annotations

@Override

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

constructName

back to summary

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

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

Annotations

@Override

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()

getHighestEncodable	back to summary
public abstract int 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.

getHighestEncodable

back to summary

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

getOutputPtr	back to summary
protected abstract int getOutputPtr()

getRow	back to summary
public int getRow()

guessEncodingBitSize	back to summary
public static final int guessEncodingBitSize(WriterConfig cfg) 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.

reportFailedEscaping	back to summary
protected void reportFailedEscaping(String type, int ch) throws XMLStreamException

reportInvalidChar	back to summary
protected void reportInvalidChar(int c) throws XMLStreamException

reportInvalidEmptyName	back to summary
protected void reportInvalidEmptyName() throws XMLStreamException

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

reportNwfContent	back to summary
protected void reportNwfContent(String format, Object arg1, Object arg2) 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 name validation is enabled.

reportNwfName	back to summary
protected void reportNwfName(String msg, Object arg) throws XMLStreamException

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

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

writeAttribute	back to summary
public abstract void writeAttribute(WName name, 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(WName name, char[] value, int offset, int len) throws IOException, XMLStreamException

writeAttribute	back to summary
public abstract void writeAttribute(WName name, AsciiValueEncoder enc) 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, if not in repairing mode; or -1 if none

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

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

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

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.

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(WName rootName, String systemId, String publicId, String internalSubset) throws IOException, XMLStreamException

writeEndTag	back to summary
public abstract void writeEndTag(WName name) throws IOException, XMLStreamException

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

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

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

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

writeSpace	back to summary
public abstract void writeSpace(String data) throws IOException, XMLStreamException

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

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

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

writeStartTagStart	back to summary
public abstract void writeStartTagStart(WName name) 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)

writeTypedValue	back to summary
public abstract void writeTypedValue(AsciiValueEncoder enc) throws IOException, XMLStreamException

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

public abstract Class XmlWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail