javax.xml.stream.util

public Interface XMLEventConsumer

Known Direct Subinterfaces: javax.xml.stream.XMLEventWriter
Imports: javax.xml.stream.events.XMLEvent, javax.xml.stream.XMLStreamException

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.

Author: Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
Since: 1.6
Version: 1.0

Method Summary

Modifier and Type	Method and Description
public void	add(XMLEvent the event to add, may not be null event) This method adds an event to the consumer.

Method Detail

add	back to summary
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:XMLEvent the event to add, may not be null Exceptions XMLStreamException: if there is an error in adding the event

add

back to summary

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:XMLEvent: the event to add, may not be null

Exceptions

XMLStreamException:: if there is an error in adding the event