XmlChannelReader (legaldocml-core 0.5.0 API)

java.lang.Object
- io.legaldocml.io.impl.XmlChannelReader

All Implemented Interfaces:: XmlReader, XMLStreamConstants

public final class XmlChannelReader
extends Object
implements XMLStreamConstants, XmlReader

Author:: Jacques Militello

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`STATE_CDATA` Internal State : Characters.
`static int`	`STATE_CHARACTERS` Internal State : Characters.
`static int`	`STATE_CLOSE_TAG_ELEM_NAME_READ` Internal State : Close Tag -> the element name is readed.
`static int`	`STATE_CLOSE_TAG_READ_ELEM_NAME` Internal State : Close Tag -> read element name.
`static int`	`STATE_COMMENT` Internal State : comment.
`static int`	`STATE_DTD` Internal State : DTD.
`static int`	`STATE_DTD_INTERNAL` Internal State : Internal DTD.
`static int`	`STATE_MARKUP` Internal State : Markup.
`static int`	`STATE_OPEN_TAG_ATTR_NAME_READ` Internal State : Open Tag -> the attribute name is reader.
`static int`	`STATE_OPEN_TAG_ELEM_NAME_READ` Internal State : Open Tag -> the name is readed.
`static int`	`STATE_OPEN_TAG_EMPTY_TAG` Internal State : Open Tag -> empty tag.
`static int`	`STATE_OPEN_TAG_EQUAL_READ` Internal State : Open Tag -> read.
`static int`	`STATE_OPEN_TAG_READ_ATTR_NAME` Internal State : Open Tag -> read the attribute name.
`static int`	`STATE_OPEN_TAG_READ_ATTR_VALUE_DOUBLE_QUOTE` Internal State : Open Tag -> Read attribute value with double quote.
`static int`	`STATE_OPEN_TAG_READ_ATTR_VALUE_SIMPLE_QUOTE` Internal State : Open Tag -> Read attribute value with simple quote.
`static int`	`STATE_OPEN_TAG_READ_ELEM_NAME` Internal State : Open Tag -> read the element name.
`static int`	`STATE_PI` Internal State : Processing instruction.

Fields inherited from interface javax.xml.stream.XMLStreamConstants
ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT

Constructor Summary

Constructors
Constructor and Description

XmlChannelReader()

XmlChannelReader(boolean clearCache)

Constructors
Constructor and Description
`XmlChannelReader()`
`XmlChannelReader(boolean clearCache)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`forEach(Externalizable object, AttributeConsumer 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()`
`protected void`	`reset()`
`void`	`setBuffer(MappedByteBuffer buf)`
`<T extends XmlReaderContext> void`	`setContext(T context)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - STATE_CHARACTERS
```
public static final int STATE_CHARACTERS
```
    Internal State : Characters.
    
    See Also:
    
    Constant Field Values
  - STATE_MARKUP
```
public static final int STATE_MARKUP
```
    Internal State : Markup.
    
    See Also:
    
    Constant Field Values
  - STATE_COMMENT
```
public static final int STATE_COMMENT
```
    Internal State : comment.
    
    See Also:
    
    Constant Field Values
  - STATE_PI
```
public static final int STATE_PI
```
    Internal State : Processing instruction.
    
    See Also:
    
    Constant Field Values
  - STATE_CDATA
```
public static final int STATE_CDATA
```
    Internal State : Characters.
    
    See Also:
    
    Constant Field Values
  - STATE_OPEN_TAG_READ_ELEM_NAME
```
public static final int STATE_OPEN_TAG_READ_ELEM_NAME
```
    Internal State : Open Tag -> read the element name.
    
    See Also:
    
    Constant Field Values
  - STATE_OPEN_TAG_ELEM_NAME_READ
```
public static final int STATE_OPEN_TAG_ELEM_NAME_READ
```
    Internal State : Open Tag -> the name is readed.
    
    See Also:
    
    Constant Field Values
  - STATE_OPEN_TAG_READ_ATTR_NAME
```
public static final int STATE_OPEN_TAG_READ_ATTR_NAME
```
    Internal State : Open Tag -> read the attribute name.
    
    See Also:
    
    Constant Field Values
  - STATE_OPEN_TAG_ATTR_NAME_READ
```
public static final int STATE_OPEN_TAG_ATTR_NAME_READ
```
    Internal State : Open Tag -> the attribute name is reader.
    
    See Also:
    
    Constant Field Values
  - STATE_OPEN_TAG_EQUAL_READ
```
public static final int STATE_OPEN_TAG_EQUAL_READ
```
    Internal State : Open Tag -> read.
    
    See Also:
    
    Constant Field Values
  - STATE_OPEN_TAG_READ_ATTR_VALUE_SIMPLE_QUOTE
```
public static final int STATE_OPEN_TAG_READ_ATTR_VALUE_SIMPLE_QUOTE
```
    Internal State : Open Tag -> Read attribute value with simple quote.
    
    See Also:
    
    Constant Field Values
  - STATE_OPEN_TAG_READ_ATTR_VALUE_DOUBLE_QUOTE
```
public static final int STATE_OPEN_TAG_READ_ATTR_VALUE_DOUBLE_QUOTE
```
    Internal State : Open Tag -> Read attribute value with double quote.
    
    See Also:
    
    Constant Field Values
  - STATE_OPEN_TAG_EMPTY_TAG
```
public static final int STATE_OPEN_TAG_EMPTY_TAG
```
    Internal State : Open Tag -> empty tag.
    
    See Also:
    
    Constant Field Values
  - STATE_CLOSE_TAG_READ_ELEM_NAME
```
public static final int STATE_CLOSE_TAG_READ_ELEM_NAME
```
    Internal State : Close Tag -> read element name.
    
    See Also:
    
    Constant Field Values
  - STATE_CLOSE_TAG_ELEM_NAME_READ
```
public static final int STATE_CLOSE_TAG_ELEM_NAME_READ
```
    Internal State : Close Tag -> the element name is readed.
    
    See Also:
    
    Constant Field Values
  - STATE_DTD
```
public static final int STATE_DTD
```
    Internal State : DTD.
    
    See Also:
    
    Constant Field Values
  - STATE_DTD_INTERNAL
```
public static final int STATE_DTD_INTERNAL
```
    Internal State : Internal DTD.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - XmlChannelReader
```
public XmlChannelReader()
```
  - XmlChannelReader
```
public XmlChannelReader(boolean clearCache)
```
- Method Detail
  - getQName
```
public QName getQName()
```
    Returns the qualidied name of the current event.
    
    Specified by:
    
    getQName in interface XmlReader
  - getText
```
public final CharArray getText()
```
    Returns the current value of the parse event as a string, this returns the string value of a CHARACTERS event.
    
    Specified by:
    
    getText in interface XmlReader
  - getPIData
```
public final ProcessingInstruction getPIData()
```
    Returns the current Processing Instruction of a PROCESSING_INSTRUCTION event.
    
    Specified by:
    
    getPIData in interface XmlReader
  - getNamespaces
```
public Namespaces getNamespaces()
```
    Specified by:
    
    getNamespaces in interface XmlReader
  - preserveSpace
```
public void preserveSpace()
```
    Specified by:
    
    preserveSpace in interface XmlReader
  - setContext
```
public <T extends XmlReaderContext> void setContext(T context)
```
    Specified by:
    
    setContext in interface XmlReader
  - getContext
```
public <T extends XmlReaderContext> T getContext()
```
    Specified by:
    
    getContext in interface XmlReader
  - next
```
public 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.
    
    Specified by:
    
    next in interface XmlReader
    
    Returns:
    
    the integer code corresponding to the current parse event
  - nextStartOrEndElement
```
public final void nextStartOrEndElement()
```
    Go to the next START_ELEMENT or END_ELEMENT.
    
    Specified by:
    
    nextStartOrEndElement in interface XmlReader
  - setBuffer
```
public final void setBuffer(MappedByteBuffer buf)
```
  - getEventType
```
public final int getEventType()
```
    Returns an integer code that indicates the type of the event the cursor is pointing to.
    
    Specified by:
    
    getEventType in interface XmlReader
  - getDepth
```
public final int getDepth()
```
    Returns an integer depth that indicates depth in the xml hierarchy.
    
    Specified by:
    
    getDepth in interface XmlReader
  - getProlog
```
public final ProcessingInstruction getProlog()
```
    Returns the current Processing Instruction of the prolog.
    
    Specified by:
    
    getProlog in interface XmlReader
  - reset
```
protected void reset()
```
  - forEach
```
public void forEach(Externalizable object,
                    AttributeConsumer consumer)
```
    Specified by:
    
    forEach in interface XmlReader
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class XmlChannelReader

Field Summary

Fields inherited from interface javax.xml.stream.XMLStreamConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATE_CHARACTERS

STATE_MARKUP

STATE_COMMENT

STATE_PI

STATE_CDATA

STATE_OPEN_TAG_READ_ELEM_NAME

STATE_OPEN_TAG_ELEM_NAME_READ

STATE_OPEN_TAG_READ_ATTR_NAME

STATE_OPEN_TAG_ATTR_NAME_READ

STATE_OPEN_TAG_EQUAL_READ

STATE_OPEN_TAG_READ_ATTR_VALUE_SIMPLE_QUOTE

STATE_OPEN_TAG_READ_ATTR_VALUE_DOUBLE_QUOTE

STATE_OPEN_TAG_EMPTY_TAG

STATE_CLOSE_TAG_READ_ELEM_NAME

STATE_CLOSE_TAG_ELEM_NAME_READ

STATE_DTD

STATE_DTD_INTERNAL

Constructor Detail

XmlChannelReader

XmlChannelReader

Method Detail

getQName

getText

getPIData

getNamespaces

preserveSpace

setContext

getContext

next

nextStartOrEndElement

setBuffer

getEventType

getDepth

getProlog

reset

forEach

toString