|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.saxonica.stream.Conduit
public class Conduit
A Conduit is a communication channel from a Producer to a Consumer: the channel is used to pass a sequence of items (and possibly an exception) from the producer to the consumer. This provides a bridge beween a push pipeline and a pull pipeline, which operates by executing the push pipeline and the pull pipeline in different threads.
Constructor Summary | |
---|---|
Conduit()
|
Method Summary | |
---|---|
void |
close()
Interface allowing the consumer to indicate that no more items are required. |
void |
finish()
Interface allowing the producer to indicate that there are no more items to come. |
boolean |
isClosed()
Ask whether the conduit has been closed |
Item |
read()
Interface allowing the consumer to read an Item. |
void |
signalProducerError(XPathException exception)
Interface allowing the producer to indicate that a dynamic error has occurred. |
void |
write(Item value)
Interface allowing the producer to write an item. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Conduit()
Method Detail |
---|
public Item read() throws XPathException
XPathException
- if the producer signalled an exceptionpublic void close()
public boolean isClosed()
public void write(Item value)
value
- The item to be writtenpublic void finish()
public void signalProducerError(XPathException exception)
exception
- the error to be signalled
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |