This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
javax.xml.stream.util
interface XMLEventConsumer
- All Known Subinterfaces:
- XMLEventWriter
public interface XMLEventConsumer
This interface defines an event consumer interface. The contract of the
of a consumer is to accept the event. This interface can be used to
mark an object as able to receive events. Add may be called several
times in immediate succession so a consumer must be able to cache
events it hasn't processed yet.
Method Summary |
void |
This method adds an event to the consumer.
|
add
public void add(XMLEvent event)
throws XMLStreamException
-
This method adds an event to the consumer. Calling this method
invalidates the event parameter. The client application should
discard all references to this event upon calling add.
The behavior of an application that continues to use such references
is undefined.
- Parameters:
event
- the event to add, may not be null
- Throws:
XMLStreamException
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.