XmlReader (legaldocml-core 0.5.0 API)

All Known Implementing Classes:

XmlChannelReader
```
public interface XmlReader
```
Author:

Jacques Militello

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`<T extends Externalizable> void`	`forEach(T object, AttributeConsumer<T> consumer)`
`<T extends XmlReaderContext> T`	`getContext()`
`int`	`getDepth()` Returns an integer depth that indicates depth in the xml hierarchy.
`int`	`getEventType()` Returns an integer code that indicates the type of the event the cursor is pointing to.
`Namespaces`	`getNamespaces()`
`ProcessingInstruction`	`getPIData()` Returns the current Processing Instruction of a PROCESSING_INSTRUCTION event.
`ProcessingInstruction`	`getProlog()` Returns the current Processing Instruction of the prolog.
`QName`	`getQName()` Returns the qualidied name of the current event.
`CharArray`	`getText()` Returns the current value of the parse event as a string, this returns the string value of a CHARACTERS event.
`int`	`next()` Get next parsing event - a processor may return all contiguous character data in a single chunk, or it may split it into several chunks.
`void`	`nextStartOrEndElement()` Go to the next START_ELEMENT or END_ELEMENT.
`void`	`preserveSpace()`
`<T extends XmlReaderContext> void`	`setContext(T context)`

- Method Detail
  - next
```
int next()
```
    Get next parsing event - a processor may return all contiguous character data in a single chunk, or it may split it into several chunks.
    By default entity references must be expanded and reported transparently to the application. An exception will be thrown if an entity reference cannot be expanded. If element content is empty (i.e. content is "") then no CHARACTERS event will be reported.
    
    Returns:
    
    the integer code corresponding to the current parse event
  - nextStartOrEndElement
```
void nextStartOrEndElement()
```
    Go to the next START_ELEMENT or END_ELEMENT.
  - getEventType
```
int getEventType()
```
    Returns an integer code that indicates the type of the event the cursor is pointing to.
  - getDepth
```
int getDepth()
```
    Returns an integer depth that indicates depth in the xml hierarchy.
  - getQName
```
QName getQName()
```
    Returns the qualidied name of the current event.
  - getText
```
CharArray getText()
```
    Returns the current value of the parse event as a string, this returns the string value of a CHARACTERS event.
  - getPIData
```
ProcessingInstruction getPIData()
```
    Returns the current Processing Instruction of a PROCESSING_INSTRUCTION event.
  - getProlog
```
ProcessingInstruction getProlog()
```
    Returns the current Processing Instruction of the prolog.
  - getNamespaces
```
Namespaces getNamespaces()
```
  - forEach
```
<T extends Externalizable> void forEach(T object,
                                        AttributeConsumer<T> consumer)
```
  - preserveSpace
```
void preserveSpace()
```
  - setContext
```
<T extends XmlReaderContext> void setContext(T context)
```
  - getContext
```
<T extends XmlReaderContext> T getContext()
```

Interface XmlReader

Method Summary

Method Detail

next

nextStartOrEndElement

getEventType

getDepth

getQName

getText

getPIData

getProlog

getNamespaces

forEach

preserveSpace

setContext

getContext