org.netbeans.modules.parsing.spi

Enum Parser.CancelReason

java.lang.Object

java.lang.Enum<Parser.CancelReason>

org.netbeans.modules.parsing.spi.Parser.CancelReason

All Implemented Interfaces:

Serializable, Comparable<Parser.CancelReason>, java.lang.constant.Constable

Enclosing class:

Parser

public static enum Parser.CancelReason
extends Enum<Parser.CancelReason>

The Parser.CancelReason is passed to Parser.cancel(org.netbeans.modules.parsing.spi.Parser.CancelReason, org.netbeans.modules.parsing.spi.SourceModificationEvent) as a hint. The parser may use this information to optimize the canceling.

Since:

1.36

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant and Description
PARSER_RESULT_TASK The cancel is called because a higher priority task was added.
SOURCE_MODIFICATION_EVENT The cancel is called due to source modification.
USER_TASK The cancel is called because ParserManager's parse method was called.

Method Summary

Modifier and Type	Method and Description
static Parser.CancelReason	valueOf(String name) Returns the enum constant of this type with the specified name.
static Parser.CancelReason[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SOURCE_MODIFICATION_EVENT

public static final Parser.CancelReason SOURCE_MODIFICATION_EVENT

The cancel is called due to source modification. Any information calculated by the parser is based on obsolete data, the parser should stop and throw all the cached data.

USER_TASK

public static final Parser.CancelReason USER_TASK

The cancel is called because ParserManager's parse method was called. The source used by the parser is still valid, the parser can use these data during the next request.

PARSER_RESULT_TASK

public static final Parser.CancelReason PARSER_RESULT_TASK

The cancel is called because a higher priority task was added. The source used by the parser is still valid, the parser can use these data during next request.

Method Detail

values

public static Parser.CancelReason[] values()

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Parser.CancelReason valueOf(String name)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null