org.xbup.io.pull

Class XBPullReader

java.lang.Object

org.xbup.io.stream.XBInputStream

org.xbup.io.pull.XBPullReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, XBEventProvider, XBPullProvider, XBProducer, XBProvider

Direct Known Subclasses:

XBTPullReader

public class XBPullReader
extends XBInputStream
implements XBProducer, XBPullProvider

Level 0 Pull Reader.

Version:

0.1 wr21.0 2011/09/08

Author:

XBUP Project (http://xbup.org)

Nested Class Summary

Nested classes/interfaces inherited from class org.xbup.io.stream.XBInputStream

XBInputStream.XBPrefixInputStream

Constructor Summary

Constructors

Constructor and Description
XBPullReader()
XBPullReader(java.io.InputStream inputStream)
XBPullReader(java.io.InputStream inputStream, boolean skipHead)

Method Summary

Methods

Modifier and Type	Method and Description
void	attachXBConsumer(XBConsumer consumer) Attach data consumer
void	attachXBListener(XBListener eventListener) Attach listener to which will be data send.
void	close() Close source and release locks
protected int	getLevel() Return current level of how deep in tree we are.
XBParserState	getParseMode() Returns actual parsing mode
boolean	isFinished() Indicate parsing completeness
void	open(java.io.InputStream stream) Open input byte-stream
void	performXB() Process all events and send them to target
XBToken	pullXBToken() Main pull reader parser processing method.
void	reset() Reset Source
java.lang.String	toString()

Methods inherited from class org.xbup.io.stream.XBInputStream

attachXBEventListener, available, getPrefixInputStream, toXBEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XBPullReader

public XBPullReader()

XBPullReader

public XBPullReader(java.io.InputStream inputStream)
             throws java.io.IOException

Throws:

java.io.IOException

XBPullReader

public XBPullReader(java.io.InputStream inputStream,
            boolean skipHead)
             throws java.io.IOException

Throws:

java.io.IOException

Method Detail

open

public void open(java.io.InputStream stream)
          throws java.io.IOException

Open input byte-stream

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

reset

public void reset()
           throws java.io.IOException

Description copied from class: XBInputStream

Reset Source

Overrides:

reset in class XBInputStream

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Description copied from class: XBInputStream

Close source and release locks

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class XBInputStream

Throws:

java.io.IOException

getLevel

protected int getLevel()

Return current level of how deep in tree we are.

Returns:

tree level, 0 means root

isFinished

public boolean isFinished()

Indicate parsing completeness

Returns:

true if complete

pullXBToken

public XBToken pullXBToken()
                    throws XBProcessingException,
                           java.io.IOException

Main pull reader parser processing method.

Specified by:

pullXBToken in interface XBPullProvider

Returns:

next recognized event item in stream

Throws:

XBProcessingException

java.io.IOException

getParseMode

public XBParserState getParseMode()

Returns actual parsing mode

Returns:

parse mode

attachXBListener

public void attachXBListener(XBListener eventListener)

Description copied from interface: XBProvider

Attach listener to which will be data send.

Specified by:

attachXBListener in interface XBProvider

performXB

public void performXB()
               throws XBProcessingException

Process all events and send them to target

Throws:

XBProcessingException

attachXBConsumer

public void attachXBConsumer(XBConsumer consumer)

Description copied from interface: XBProducer

Attach data consumer

Specified by:

attachXBConsumer in interface XBProducer