Package com.bea.xml.stream
Class XMLEventReaderBase
java.lang.Object
com.bea.xml.stream.XMLEventReaderBase
- All Implemented Interfaces:
Iterator
,XMLEventConsumer
,XMLEventReader
- Direct Known Subclasses:
XMLEventPlayer
The base reader class.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionXMLEventReaderBase
(XMLStreamReader reader) XMLEventReaderBase
(XMLStreamReader reader, XMLEventAllocator alloc) -
Method Summary
Modifier and TypeMethodDescriptionvoid
This method adds an event to the consumer.void
close()
Frees any resources associated with this Reader.protected XMLEvent
get()
Reads the content of a text-only element.getProperty
(String name) Get the value of a feature/property from the underlying implementationboolean
hasNext()
Check if there are more events.protected void
protected boolean
isOpen()
static void
protected boolean
next()
Get the next XMLEventnextTag()
Skips any insignificant space events until a START_ELEMENT or END_ELEMENT is reached.protected boolean
peek()
Check the next XMLEvent without reading it from the stream.void
remove()
void
setAllocator
(XMLEventAllocator allocator) void
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.util.Iterator
forEachRemaining
-
Field Details
-
reader
-
allocator
-
-
Constructor Details
-
XMLEventReaderBase
- Throws:
XMLStreamException
-
XMLEventReaderBase
public XMLEventReaderBase(XMLStreamReader reader, XMLEventAllocator alloc) throws XMLStreamException - Throws:
XMLStreamException
-
-
Method Details
-
setAllocator
-
getElementText
Description copied from interface:javax.xml.stream.XMLEventReader
Reads the content of a text-only element. Precondition: the current event is START_ELEMENT. Postcondition: The current event is the corresponding END_ELEMENT.- Specified by:
getElementText
in interfaceXMLEventReader
- Throws:
XMLStreamException
- if the current event is not a START_ELEMENT or if a non text element is encountered
-
nextTag
Description copied from interface:javax.xml.stream.XMLEventReader
Skips any insignificant space events until a START_ELEMENT or END_ELEMENT is reached. If anything other than space characters are encountered, an exception is thrown. This method should be used when processing element-only content because the parser is not able to recognize ignorable whitespace if the DTD is missing or not interpreted.- Specified by:
nextTag
in interfaceXMLEventReader
- Throws:
XMLStreamException
- if anything other than space characters are encountered
-
next
-
nextEvent
Description copied from interface:javax.xml.stream.XMLEventReader
Get the next XMLEvent- Specified by:
nextEvent
in interfaceXMLEventReader
- Throws:
XMLStreamException
- See Also:
-
hasNext
public boolean hasNext()Description copied from interface:javax.xml.stream.XMLEventReader
Check if there are more events. Returns true if there are more events and false otherwise.- Specified by:
hasNext
in interfaceIterator
- Specified by:
hasNext
in interfaceXMLEventReader
- Returns:
- true if the event reader has more events, false otherwise
-
peek
Description copied from interface:javax.xml.stream.XMLEventReader
Check the next XMLEvent without reading it from the stream. Returns null if the stream is at EOF or has no more XMLEvents. A call to peek() will be equal to the next return of next().- Specified by:
peek
in interfaceXMLEventReader
- Throws:
XMLStreamException
- See Also:
-
add
Description copied from interface:javax.xml.stream.util.XMLEventConsumer
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.- Specified by:
add
in interfaceXMLEventConsumer
- Parameters:
event
- the event to add, may not be null- Throws:
XMLStreamException
-
needsMore
protected boolean needsMore() -
get
- Throws:
XMLStreamException
-
isOpen
protected boolean isOpen() -
internal_close
protected void internal_close() -
close
Description copied from interface:javax.xml.stream.XMLEventReader
Frees any resources associated with this Reader. This method does not close the underlying input source.- Specified by:
close
in interfaceXMLEventReader
- Throws:
XMLStreamException
- if there are errors freeing associated resources
-
parseSome
- Throws:
XMLStreamException
-
setConfigurationContext
-
getProperty
Description copied from interface:javax.xml.stream.XMLEventReader
Get the value of a feature/property from the underlying implementation- Specified by:
getProperty
in interfaceXMLEventReader
- Parameters:
name
- The name of the property- Returns:
- The value of the property
-
remove
public void remove() -
main
- Throws:
Exception
-