Uses of Interface javax.xml.stream.XMLStreamReader (Java Platform SE 8 )
Date: 2020-03-26

## Uses of Interface
javax.xml.stream.XMLStreamReader

- Packages that use XMLStreamReader
  Package | Description
  --- | ---
  javax.xml.bind | Provides a runtime binding framework for client applications including unmarshalling, marshalling, and validation capabilities.
  javax.xml.bind.helpers | JAXB Provider Use Only: Provides partial default implementations for some of the `javax.xml.bind` interfaces.
  javax.xml.stream |
  javax.xml.stream.util |
  javax.xml.transform.stax | Provides for StAX-specific transformation APIs.

- - ### Uses of XMLStreamReader in javax.xml.bind

    Methods in javax.xml.bind with parameters of type XMLStreamReader
    Modifier and Type | Method and Description
    --- | ---
    `Object` | Unmarshaller.`unmarshal(XMLStreamReader reader)` Unmarshal XML data from the specified pull parser and return the resulting content tree.
    `<T> JAXBElement<T>` | Unmarshaller.`unmarshal(XMLStreamReader reader, Class<T> declaredType)` Unmarshal root element to JAXB mapped `declaredType` and return the resulting content tree.

  - ### Uses of XMLStreamReader in javax.xml.bind.helpers

    Methods in javax.xml.bind.helpers with parameters of type XMLStreamReader
    Modifier and Type | Method and Description
    --- | ---
    `Object` | AbstractUnmarshallerImpl.`unmarshal(XMLStreamReader reader)`
    `<T> JAXBElement<T>` | AbstractUnmarshallerImpl.`unmarshal(XMLStreamReader reader, Class<T> expectedType)`

  - ### Uses of XMLStreamReader in javax.xml.stream

    Methods in javax.xml.stream that return XMLStreamReader
    Modifier and Type | Method and Description
    --- | ---
    `abstract XMLStreamReader` | XMLInputFactory.`createFilteredReader(XMLStreamReader reader, StreamFilter filter)` Create a filtered reader that wraps the filter around the reader
    `abstract XMLStreamReader` | XMLInputFactory.`createXMLStreamReader(InputStream stream)` Create a new XMLStreamReader from a java.io.InputStream
    `abstract XMLStreamReader` | XMLInputFactory.`createXMLStreamReader(InputStream stream, String encoding)` Create a new XMLStreamReader from a java.io.InputStream
    `abstract XMLStreamReader` | XMLInputFactory.`createXMLStreamReader(Reader reader)` Create a new XMLStreamReader from a reader
    `abstract XMLStreamReader` | XMLInputFactory.`createXMLStreamReader(Source source)` Create a new XMLStreamReader from a JAXP source.
    `abstract XMLStreamReader` | XMLInputFactory.`createXMLStreamReader(String systemId, InputStream stream)` Create a new XMLStreamReader from a java.io.InputStream
    `abstract XMLStreamReader` | XMLInputFactory.`createXMLStreamReader(String systemId, Reader reader)` Create a new XMLStreamReader from a java.io.InputStream

    Methods in javax.xml.stream with parameters of type XMLStreamReader
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | StreamFilter.`accept(XMLStreamReader reader)` Tests whether the current state is part of this stream.
    `abstract XMLStreamReader` | XMLInputFactory.`createFilteredReader(XMLStreamReader reader, StreamFilter filter)` Create a filtered reader that wraps the filter around the reader
    `abstract XMLEventReader` | XMLInputFactory.`createXMLEventReader(XMLStreamReader reader)` Create a new XMLEventReader from an XMLStreamReader.

  - ### Uses of XMLStreamReader in javax.xml.stream.util

    Classes in javax.xml.stream.util that implement XMLStreamReader
    Modifier and Type | Class and Description
    --- | ---
    `class` | `StreamReaderDelegate` This is the base class for deriving an XMLStreamReader filter This class is designed to sit between an XMLStreamReader and an application's XMLStreamReader.

    Methods in javax.xml.stream.util that return XMLStreamReader
    Modifier and Type | Method and Description
    --- | ---
    `XMLStreamReader` | StreamReaderDelegate.`getParent()` Get the parent of this instance.

    Methods in javax.xml.stream.util with parameters of type XMLStreamReader
    Modifier and Type | Method and Description
    --- | ---
    `XMLEvent` | XMLEventAllocator.`allocate(XMLStreamReader reader)` This method allocates an event given the current state of the XMLStreamReader.
    `void` | XMLEventAllocator.`allocate(XMLStreamReader reader, XMLEventConsumer consumer)` This method allocates an event or set of events given the current state of the XMLStreamReader and adds the event or set of events to the consumer that was passed in.
    `void` | StreamReaderDelegate.`setParent(XMLStreamReader reader)` Set the parent of this instance.

    Constructors in javax.xml.stream.util with parameters of type XMLStreamReader
    Constructor and Description
    `StreamReaderDelegate(XMLStreamReader reader)` Construct an filter with the specified parent.

  - ### Uses of XMLStreamReader in javax.xml.transform.stax

    Methods in javax.xml.transform.stax that return XMLStreamReader
    Modifier and Type | Method and Description
    --- | ---
    `XMLStreamReader` | StAXSource.`getXMLStreamReader()` Get the `XMLStreamReader` used by this `StAXSource`.

    Constructors in javax.xml.transform.stax with parameters of type XMLStreamReader
    Constructor and Description
    `StAXSource(XMLStreamReader xmlStreamReader)` Creates a new instance of a `StAXSource` by supplying an `XMLStreamReader`.

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.