Package org.apache.axiom.ext.stax
Interface CharacterDataReader
public interface CharacterDataReader
Optional interface implemented by
XMLStreamReader
implementations that support writing character data directly to a
Writer.
All the requirements outlined in org.apache.axiom.ext.stax apply to
this extension interface. In particular, to get a reference to the extension,
the consumer MUST call XMLStreamReader.getProperty(String)
with PROPERTY as the property name.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe name of the property used to look up this extension interface from aXMLStreamReaderimplementation. -
Method Summary
Modifier and TypeMethodDescriptionvoidwriteTextTo(Writer writer) Output the character data for the current event to the given writer.
-
Field Details
-
PROPERTY
The name of the property used to look up this extension interface from aXMLStreamReaderimplementation.
-
-
Method Details
-
writeTextTo
Output the character data for the current event to the given writer. In general, the implementation behaves such thatreader.writeTextTo(writer)has the same effect aswriter.write(reader.getText()). However, the implementation MAY choose to split the character data differently. E.g. it MAY write the character data in multiple chunks or it MAY choose to process more character data in a single event than would be returned byXMLStreamReader.getText(). Therefore, using this method together withXMLStreamReader.getText(),XMLStreamReader.getTextCharacters(),XMLStreamReader.getTextStart(),XMLStreamReader.getTextLength()orXMLStreamReader.getTextCharacters(int, char[], int, int)is not supported and may lead to undefined results.The implementation SHOULD avoid any unnecessary conversions between strings and character arrays.
- Parameters:
writer- the writer to write the character data to- Throws:
XMLStreamException- if the underlying XML source is not well-formedIOException- if an I/O error occurs when writing the character dataIllegalStateException- if this state is not a valid text state.
-