org.netbeans.modules.parsing.api

Class ResultIterator

java.lang.Object

org.netbeans.modules.parsing.api.ResultIterator

public final class ResultIterator
extends Object

ResultIterator allows to iterate tree of embedded blocks of sources, and request parse results on different levels. You can force parsing of all blocks of embedded Sources, or you can find your favourite one and skip parsing of rest of them. In some situations you can even parse embedded language without parsing of surrounding block.

Method Summary

Modifier and Type	Method and Description
Iterable<Embedding>	getEmbeddings() Allows iterate all embedded sources.
Parser.Result	getParserResult() Returns parse Parser.Result for current source or null.
Parser.Result	getParserResult(int offset) Returns parse Parser.Result for deepest embedding on given offset or null.
ResultIterator	getResultIterator(Embedding embedding) Returns ResultIterator for one Embedding.
Snapshot	getSnapshot()

Methods inherited from class java.lang.Object

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

Method Detail

getSnapshot

public Snapshot getSnapshot()

getParserResult

public Parser.Result getParserResult()
                              throws ParseException

Returns parse Parser.Result for current source or null.

Returns:

parse Parser.Result for current source or null.

Throws:

ParseException

getParserResult

public Parser.Result getParserResult(int offset)
                              throws ParseException

Returns parse Parser.Result for deepest embedding on given offset or null.

Returns:

parse Parser.Result for current source or null.

Throws:

ParseException

getEmbeddings

public Iterable<Embedding> getEmbeddings()

Allows iterate all embedded sources.

Returns:

Iterator of all embeddings.

getResultIterator

public ResultIterator getResultIterator(Embedding embedding)

Returns ResultIterator for one Embedding.

Parameters:

embedding - A embedding.

Returns:

ResultIterator for one Embedding.