org.apache.xml.dtm.ref
public interface CoroutineParser
Deprecated: Since the ability to start a parse via the coroutine protocol was not being used and was complicating design. See {@link IncrementalSAXSource}.
CoroutineParser is an API for parser threads that operate as coroutines. See CoroutineSAXParser and CoroutineSAXParser_Xerces for examples.
<grumble> I'd like the interface to require a specific form for either the base constructor or a static factory method. Java doesn't allow us to specify either, so I'll just document them here:
Method Summary | |
---|---|
Object | doMore(boolean parsemore, int appCoroutine) doMore() is a simple API which tells the coroutine parser
that we need more nodes. |
Object | doParse(InputSource source, int appCoroutine) doParse() is a simple API which tells the coroutine parser
to begin reading from a file. |
void | doTerminate(int appCoroutine) doTerminate() is a simple API which tells the coroutine
parser to terminate itself. |
CoroutineManager | getCoroutineManager() |
int | getParserCoroutineID() |
void | init(CoroutineManager co, int appCoroutineID, XMLReader parser)
Initialize the coroutine parser. |
void | setContentHandler(ContentHandler handler) Register a SAX-style content handler for us to output to |
void | setLexHandler(LexicalHandler handler) Register a SAX-style lexical handler for us to output to
Not all parsers support this...
|
Parameters: parsemore If true, tells the incremental parser to generate another chunk of output. If false, tells the parser that we're satisfied and it can terminate parsing of this document. appCoroutine The coroutine ID number of the coroutine invoking this method, so it can be resumed after the parser has responded to the request.
Returns: Boolean.TRUE if the CoroutineParser believes more data may be available for further parsing. Boolean.FALSE if parsing ran to completion. Exception if the parser objected for some reason.
Parameters: source The InputSource to parse from. appCoroutine The coroutine ID number of the coroutine invoking this method, so it can be resumed after the parser has responded to the request.
Returns: Boolean.TRUE if the CoroutineParser believes more data may be available for further parsing. Boolean.FALSE if parsing ran to completion. Exception if the parser objected for some reason.
Parameters: appCoroutine The coroutine ID number of the coroutine invoking this method, so it can be resumed after the parser has responded to the request.
Returns: the CoroutineManager for this CoroutineParser object. If you're using the do...() methods, applications should only need to talk to the CoroutineManager once, to obtain the application's Coroutine ID.
Returns: the coroutine ID number for this CoroutineParser object. Note that this isn't useful unless you know which CoroutineManager you're talking to. Also note that the do...() methods encapsulate the common transactions with the CoroutineParser, so you shouldn't need this in most cases.