OpenJDK 1.23 · com.sun.org.apache.xml.internal.dtm.ref.CoroutineParser

Method Summary

Modifier and Type	Method and Description
public Object	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. doMore(boolean 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. parsemore, int The coroutine ID number of the coroutine invoking this method, so it can be resumed after the parser has responded to the request. appCoroutine) doMore() is a simple API which tells the coroutine parser that we need more nodes.
public Object	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. doParse(InputSource The InputSource to parse from. source, int The coroutine ID number of the coroutine invoking this method, so it can be resumed after the parser has responded to the request. appCoroutine) doParse() is a simple API which tells the coroutine parser to begin reading from a file.
public void	doTerminate(int The coroutine ID number of the coroutine invoking this method, so it can be resumed after the parser has responded to the request. appCoroutine) doTerminate() is a simple API which tells the coroutine parser to terminate itself.
public CoroutineManager	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. getCoroutineManager()
public int	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. getParserCoroutineID()
public void	init(CoroutineManager co, int appCoroutineID, XMLReader parser) Initialize the coroutine parser.
public void	setContentHandler(ContentHandler handler) Register a SAX-style content handler for us to output to
public void	setLexHandler(LexicalHandler handler) Register a SAX-style lexical handler for us to output to Not all parsers support this...

Method Detail

doMore	back to summary
public Object doMore(boolean parsemore, int appCoroutine) doMore() is a simple API which tells the coroutine parser that we need more nodes. This is intended to be called from one of our partner coroutines, and serves both to encapsulate the communication protocol and to avoid having to explicitly use the CoroutineParser's coroutine ID number. Parameters parsemore:boolean 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:int The coroutine ID number of the coroutine invoking this method, so it can be resumed after the parser has responded to the request. Returns:Object 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.

doMore

back to summary

public Object doMore(boolean parsemore, int appCoroutine)

doMore() is a simple API which tells the coroutine parser that we need more nodes. This is intended to be called from one of our partner coroutines, and serves both to encapsulate the communication protocol and to avoid having to explicitly use the CoroutineParser's coroutine ID number.

Parameters

parsemore:boolean: 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:int: The coroutine ID number of the coroutine invoking this method, so it can be resumed after the parser has responded to the request.

Returns:Object

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.

doParse	back to summary
public Object doParse(InputSource source, int appCoroutine) doParse() is a simple API which tells the coroutine parser to begin reading from a file. This is intended to be called from one of our partner coroutines, and serves both to encapsulate the communication protocol and to avoid having to explicitly use the CoroutineParser's coroutine ID number. %REVIEW% Can/should this unify with doMore? (if URI hasn't changed, parse more from same file, else end and restart parsing...? Parameters source:InputSource The InputSource to parse from. appCoroutine:int The coroutine ID number of the coroutine invoking this method, so it can be resumed after the parser has responded to the request. Returns:Object 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.

doParse

back to summary

public Object doParse(InputSource source, int appCoroutine)

doParse() is a simple API which tells the coroutine parser to begin reading from a file. This is intended to be called from one of our partner coroutines, and serves both to encapsulate the communication protocol and to avoid having to explicitly use the CoroutineParser's coroutine ID number. %REVIEW% Can/should this unify with doMore? (if URI hasn't changed, parse more from same file, else end and restart parsing...?

Parameters

source:InputSource: The InputSource to parse from.
appCoroutine:int: The coroutine ID number of the coroutine invoking this method, so it can be resumed after the parser has responded to the request.

Returns:Object

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.

doTerminate	back to summary
public void doTerminate(int appCoroutine) doTerminate() is a simple API which tells the coroutine parser to terminate itself. This is intended to be called from one of our partner coroutines, and serves both to encapsulate the communication protocol and to avoid having to explicitly use the CoroutineParser's coroutine ID number. Returns only after the CoroutineParser has acknowledged the request. Parameters appCoroutine:int The coroutine ID number of the coroutine invoking this method, so it can be resumed after the parser has responded to the request.

doTerminate

back to summary

public void doTerminate(int appCoroutine)

doTerminate() is a simple API which tells the coroutine parser to terminate itself. This is intended to be called from one of our partner coroutines, and serves both to encapsulate the communication protocol and to avoid having to explicitly use the CoroutineParser's coroutine ID number. Returns only after the CoroutineParser has acknowledged the request.

Parameters

appCoroutine:int: The coroutine ID number of the coroutine invoking this method, so it can be resumed after the parser has responded to the request.

getCoroutineManager	back to summary
public CoroutineManager getCoroutineManager() Returns:CoroutineManager 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.

getParserCoroutineID	back to summary
public int getParserCoroutineID() Returns:int 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.

init	back to summary
public void init(CoroutineManager co, int appCoroutineID, XMLReader parser) Initialize the coroutine parser. Same parameters could be passed in a non-default constructor, or by using using context ClassLoader and newInstance and then calling init()

setContentHandler	back to summary
public void setContentHandler(ContentHandler handler) Register a SAX-style content handler for us to output to

setLexHandler	back to summary
public void setLexHandler(LexicalHandler handler) Register a SAX-style lexical handler for us to output to Not all parsers support this... %REVIEW% Not called setLexicalHandler because Xalan uses that name internally, which causes subclassing nuisances.

public Interface CoroutineParser

Method Summary

Method Detail