SAXEventStream (BandM metatools API doc)

All Known Implementing Classes:

SAXEventQueue
```
@Runtime
public interface SAXEventStream
```
Storage for re-ified SAX events supporting look-ahead.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`SAXEventStream.EtherealMatcher`
`static class`	`SAXEventStream.MatchException` Raised by calls which expect definitely a certain tag.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`consume()` Consumes any event, and makes its successor the new head.
`String`	`consumeCharacters()` Consumes any chararcter data event, and returns the data.
`void`	`consumedEthereals(SAXEventStream.EtherealMatcher matcher)`
`String`	`getLocalName()` Returns the local name of the current head, i.e.
`Location<XMLDocumentIdentifier>`	`getLocation()` Delivers the location related to the next head element (tag or character data), Normally this should be the start of the textual representation of this element in the source text.
`NamespaceName`	`getNamespaceName()` Returns the namespace name of the current head, i.e.
`String`	`getNamespaceURI()` Returns the namespace URI of the current head, i.e.
`String`	`getQualifiedName()` Returns the qualified name of the current head, i.e.
`String`	`headToString()` Returns the conventional textual representation of the current head.
`boolean`	`lookaheadCharacters()` Returns whether the next SAX event represents character data.
`boolean`	`lookaheadEndDocument()` Returns whether the next SAX event is the "End of Document" element.
`boolean`	`lookaheadEndElement()` Returns whether the next SAX event is any end element event (= close element tag)
`boolean`	`lookaheadEndElement(NamespaceName name)` Returns whether the next SAX event is a certain end element event (= close element tag)
`boolean`	`lookaheadEndElement(String name)` Returns whether the next SAX event is a certain end element event (= close element tag)
`boolean`	`lookaheadStartElement()` Returns whether the next SAX event is any start element event (= open element tag)
`boolean`	`lookaheadStartElement(NamespaceName name)` Returns whether the next SAX event is a certain start element event (= open element tag)
`boolean`	`lookaheadStartElement(String name)` Returns whether the next SAX event is a certain start element event (= open element tag)
`Location<XMLDocumentIdentifier>`	`matchedEtherealLocation()`
`void`	`matchEndDocument()` Consumes the first element (if it is the indicated end document element).
`void`	`matchEndElement(NamespaceName name)` Consumes the first element (if it is the indicated end element).
`void`	`matchEndElement(String name)` Consumes the first element (if it is the indicated end element).
`Attributes`	`matchStartElement(NamespaceName name)` Consumes the first element (if it is the indicated start element) and returns its attribute set.
`Attributes`	`matchStartElement(String name)` Consumes the first element (if it is the indicated start element) and returns its attribute set.

- Method Detail
  - lookaheadCharacters
```
boolean lookaheadCharacters()
```
    Returns whether the next SAX event represents character data.
  - lookaheadStartElement
```
boolean lookaheadStartElement(NamespaceName name)
```
    Returns whether the next SAX event is a certain start element event (= open element tag)
  - lookaheadStartElement
```
boolean lookaheadStartElement(String name)
```
    Returns whether the next SAX event is a certain start element event (= open element tag)
  - lookaheadStartElement
```
boolean lookaheadStartElement()
```
    Returns whether the next SAX event is any start element event (= open element tag)
  - matchStartElement
```
Attributes matchStartElement(NamespaceName name)
                      throws SAXEventStream.MatchException
```
    Consumes the first element (if it is the indicated start element) and returns its attribute set.
    
    Throws:
    
    SAXEventStream.MatchException
  - matchStartElement
```
Attributes matchStartElement(String name)
                      throws SAXEventStream.MatchException
```
    Consumes the first element (if it is the indicated start element) and returns its attribute set.
    
    Throws:
    
    SAXEventStream.MatchException
  - lookaheadEndElement
```
boolean lookaheadEndElement(NamespaceName name)
```
    Returns whether the next SAX event is a certain end element event (= close element tag)
  - lookaheadEndElement
```
boolean lookaheadEndElement(String name)
```
    Returns whether the next SAX event is a certain end element event (= close element tag)
  - lookaheadEndElement
```
boolean lookaheadEndElement()
```
    Returns whether the next SAX event is any end element event (= close element tag)
  - matchEndElement
```
void matchEndElement(NamespaceName name)
              throws SAXEventStream.MatchException
```
    Consumes the first element (if it is the indicated end element).
    
    Throws:
    
    SAXEventStream.MatchException
  - matchEndElement
```
void matchEndElement(String name)
              throws SAXEventStream.MatchException
```
    Consumes the first element (if it is the indicated end element).
    
    Throws:
    
    SAXEventStream.MatchException
  - lookaheadEndDocument
```
boolean lookaheadEndDocument()
```
    Returns whether the next SAX event is the "End of Document" element.
  - matchEndDocument
```
void matchEndDocument()
               throws SAXEventStream.MatchException
```
    Consumes the first element (if it is the indicated end document element).
    
    Throws:
    
    SAXEventStream.MatchException
  - getNamespaceURI
```
String getNamespaceURI()
```
    Returns the namespace URI of the current head, i.e. the next element to consume.
  - getLocalName
```
String getLocalName()
```
    Returns the local name of the current head, i.e. the next element to consume.
  - getQualifiedName
```
String getQualifiedName()
```
    Returns the qualified name of the current head, i.e. the next element to consume.
  - getNamespaceName
```
NamespaceName getNamespaceName()
```
    Returns the namespace name of the current head, i.e. the next element to consume.
  - consume
```
void consume()
```
    Consumes any event, and makes its successor the new head.
  - consumeCharacters
```
String consumeCharacters()
```
    Consumes any chararcter data event, and returns the data.
  - consumedEthereals
```
void consumedEthereals(SAXEventStream.EtherealMatcher matcher)
```
  - matchedEtherealLocation
```
Location<XMLDocumentIdentifier> matchedEtherealLocation()
```
  - getLocation
```
Location<XMLDocumentIdentifier> getLocation()
```
    Delivers the location related to the next head element (tag or character data), Normally this should be the start of the textual representation of this element in the source text.
  - headToString
```
String headToString()
```
    Returns the conventional textual representation of the current head. Raises Nullpointer Exception if no such exists.

Interface SAXEventStream

Nested Class Summary

Method Summary

Method Detail

lookaheadCharacters

lookaheadStartElement

lookaheadStartElement

lookaheadStartElement

matchStartElement

matchStartElement

lookaheadEndElement

lookaheadEndElement

lookaheadEndElement

matchEndElement

matchEndElement

lookaheadEndDocument

matchEndDocument

getNamespaceURI

getLocalName

getQualifiedName

getNamespaceName

consume

consumeCharacters

consumedEthereals

matchedEtherealLocation

getLocation

headToString