org.netbeans.modules.parsing.api

Class ParserManager

java.lang.Object

org.netbeans.modules.parsing.api.ParserManager

public final class ParserManager
extends Object

ParserManager allows to start priority parsing request for one or more sources.

Method Summary

Modifier and Type	Method and Description
static boolean	canBeParsed(String mimeType) Determines if the MIME type can be parsed.
static boolean	isParsing() Determines if the current execution is already called from the parsing system.
static void	parse(Collection<Source> sources, ResultProcessor processor) Priority request for parsing of list of Sources.
static void	parse(Collection<Source> sources, UserTask userTask) Priority request for parsing of list of Sources.
static void	parse(String mimeType, UserTask userTask) Runs given task in parser thread.
static Future<Void>	parseWhenScanFinished(Collection<Source> sources, ResultProcessor processor) Performs the given task when the scan finished.
static Future<Void>	parseWhenScanFinished(Collection<Source> sources, UserTask userTask) Performs the given task when the scan finished.
static Future<Void>	parseWhenScanFinished(String mimeType, UserTask userTask) Performs the given task when the scan finished.

Methods inherited from class java.lang.Object

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

Method Detail

parse

public static void parse(@NonNull
                         Collection<Source> sources,
                         @NonNull
                         UserTask userTask)
                  throws ParseException

Priority request for parsing of list of Sources. Implementer of this task have full control over the process of parsing of embedded languages. You can scan tree of embedded sources and start parsing for all of them, or for some of them only. This method is blocking. It means that only one parsing request per time is allowed. But you can call another parsing request from your Task. This secondary parsing request is called immediately in the same thread (current thread).

This method is typically called as a response on some user request - during code completion for example.

Parameters:

sources - A list of sources that should be parsed.

userTask - A task that will be started when parsing is done.

Throws:

ParseException - encapsulating the user exception

parse

public static void parse(@NonNull
                         Collection<Source> sources,
                         @NonNull
                         ResultProcessor processor)
                  throws ParseException

Priority request for parsing of list of Sources. Implementer of this task have full control over the process of parsing of embedded languages. You can scan tree of embedded sources and start parsing for all of them, or for some of them only. This method is blocking. It means that only one parsing request per time is allowed. But you can call another parsing request from your Task. This secondary parsing request is called immediately in the same thread (current thread).

This method is typically called as a response on some user request - during code completion for example.

Parameters:

sources - A list of sources that should be parsed.

processor - The parse result processor function to invoke when parsing is done.

Throws:

ParseException - encapsulating the user exception.

Since:

9.31

parseWhenScanFinished

@NonNull
public static Future<Void> parseWhenScanFinished(@NonNull
                                                          Collection<Source> sources,
                                                          @NonNull
                                                          UserTask userTask)
                                                   throws ParseException

Performs the given task when the scan finished. When the background scan is active the task is enqueued and the method returns, the task is performed when the background scan completes by the thread doing the background scan. When no background scan is running the method behaves exactly like the {#link ParserManager#parse}, it performs the given task synchronously (in caller thread). If there is an another UserTask running this method waits until it's completed.

Parameters:

sources - A list of sources that should be parsed.

userTask - A task started when parsing is done.

Returns:

Future which can be used to find out the state of the task Future.isDone() or Future.isCancelled(). The caller may cancel the task using Future.cancel(boolean) or wait until the task is performed Future.get().

Throws:

ParseException - encapsulating the user exception.

parseWhenScanFinished

@NonNull
public static Future<Void> parseWhenScanFinished(@NonNull
                                                          Collection<Source> sources,
                                                          @NonNull
                                                          ResultProcessor processor)
                                                   throws ParseException

Performs the given task when the scan finished. When the background scan is active the task is queued and the method returns, the task is performed when the background scan completes by the thread doing the background scan. When no background scan is running the method behaves exactly like the {#link ParserManager#parse}, it performs the given task synchronously (in caller thread). If there is an another UserTask running this method waits until it's completed.

Parameters:

sources - A list of sources that should be parsed.

processor - The parse result processor function to invoke when parsing is done.

Returns:

Future which can be used to find out the state of the task Future.isDone() or Future.isCancelled(). The caller may cancel the task using Future.cancel(boolean) or wait until the task is performed Future.get().

Throws:

ParseException - encapsulating the user exception.

Since:

9.31

parse

public static void parse(@NonNull
                         String mimeType,
                         @NonNull
                         UserTask userTask)
                  throws ParseException

Runs given task in parser thread.

Parameters:

mimeType - specifying the parser

userTask - a user task

Throws:

ParseException - encapsulating the user exception

parseWhenScanFinished

@NonNull
public static Future<Void> parseWhenScanFinished(@NonNull
                                                          String mimeType,
                                                          @NonNull
                                                          UserTask userTask)
                                                   throws ParseException

Performs the given task when the scan finished. When the background scan is active the task is enqueued and the method returns, the task is performed when the background scan completes by the thread doing the background scan. When no background scan is running the method behaves exactly like the {#link ParserManager#parse}, it performs the given task synchronously (in caller thread). If there is an another UserTask running this method waits until it's completed.

Parameters:

mimeType - A mimetype specifying the parser.

userTask - A task started when parsing is done.

Returns:

Future which can be used to find out the state of the task Future.isDone() or Future.isCancelled(). The caller may cancel the task using Future.cancel(boolean) or wait until the task is performed Future.get().

Throws:

ParseException - encapsulating the user exception.

isParsing

public static boolean isParsing()

Determines if the current execution is already called from the parsing system. If code is called by the parser, it should avoid blocking on a lock and must avoid blocking on other parsing results.

Returns:

true, if the current thread executes code called from within the parser

Since:

9.2

canBeParsed

public static boolean canBeParsed(String mimeType)

Determines if the MIME type can be parsed. Rejects unknown MIME types (must be amongst getAllMimeTypes. Then accepts only text/* MIME type and specific hardcoded application/ MIME types.

Parameters:

mimeType - the MIME type to check

Returns:

true, if the MIME type can be parsed.

Since:

9.2