XMLEventConsumer (Java SE 23 & JDK 23)
Description: declaration: module: java.xml, package: javax.xml.stream.util, interface: XMLEventConsumer
Keywords: javax.xml.stream.util.XMLEventConsumer interface

# 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.

Since:
  1.6

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `add(XMLEvent event)`
  This method adds an event to the consumer.

- ## Method Details

  - ### add

    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` - if there is an error in adding the event