Enum Class Snippet.Kind
- All Implemented Interfaces:
Serializable, Comparable<Snippet.Kind>, Constable
- Enclosing class:
Snippet
Kind is an immutable property of a Snippet.
It is accessed with Snippet.kind().
The Kind can be used to determine which
subclass of Snippet it is. For example,
eval("int three() { return 3; }") will
return a snippet creation event. The Kind of that Snippet
will be METHOD, from which you know that the subclass
of Snippet is MethodSnippet and it can be
cast as such.- Since:
- 9
-
Nested Class Summary
Nested classes/interfaces declared in class Enum
Enum.EnumDesc<E>Modifier and TypeClassDescriptionstatic final classEnum.EnumDesc<E extends Enum<E>>A nominal descriptor for anenumconstant. -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionA syntactically incorrect input for which the specific kind could not be determined.An expression, with or without side-effects.An import declaration:import...A method declaration.A statement.A type declaration.One variable declaration. -
Method Summary
Modifier and TypeMethodDescriptionbooleanIndicates whether thisKindof Snippet is persistent.static Snippet.KindReturns the enum constant of this class with the specified name.static Snippet.Kind[]values()Returns an array containing the constants of this enum class, in the order they are declared.Methods declared in class Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOfModifier and TypeMethodDescriptionprotected final Objectclone()Throws CloneNotSupportedException.final intCompares this enum with the specified object for order.final Optional<Enum.EnumDesc<Snippet.Kind>> Returns an enum descriptorEnumDescfor this instance, if one can be constructed, or an emptyOptionalif one cannot be.final booleanReturns true if the specified object is equal to this enum constant.protected final voidfinalize()Deprecated, for removal: This API element is subject to removal in a future version.Finalization has been deprecated for removal.final Class<Snippet.Kind> Returns the Class object corresponding to this enum constant's enum type.final inthashCode()Returns a hash code for this enum constant.final Stringname()Returns the name of this enum constant, exactly as declared in its enum declaration.final intordinal()Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).toString()Returns the name of this enum constant, as contained in the declaration.static <T extends Enum<T>>
TReturns the enum constant of the specified enum class with the specified name.Methods declared in class Object
getClass, notify, notifyAll, wait, wait, waitModifier and TypeMethodDescriptionfinal Class<?> getClass()Returns the runtime class of thisObject.final voidnotify()Wakes up a single thread that is waiting on this object's monitor.final voidWakes up all threads that are waiting on this object's monitor.final voidwait()Causes the current thread to wait until it is awakened, typically by being notified or interrupted.final voidwait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.final voidwait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
-
Enum Constant Details
-
IMPORT
An import declaration:import... The snippet is an instance ofImportSnippet.An import can be a single type import (
Snippet.SubKind.SINGLE_TYPE_IMPORT_SUBKIND), a static single import (Snippet.SubKind.SINGLE_STATIC_IMPORT_SUBKIND), an on-demand type import (Snippet.SubKind.TYPE_IMPORT_ON_DEMAND_SUBKIND), or a static on-demand type import (Snippet.SubKind.SINGLE_STATIC_IMPORT_SUBKIND) -- useSnippet.subKind()to distinguish.An import declaration is persistent.
- See Java Language Specification:
-
7.5 Import Declarations
-
TYPE_DECL
A type declaration. Which includes: NormalClassDeclaration, EnumDeclaration, NormalInterfaceDeclaration, and AnnotationTypeDeclaration. The snippet is an instance ofTypeDeclSnippet.A type declaration may be an interface
Snippet.SubKind.INTERFACE_SUBKIND, classesSnippet.SubKind.CLASS_SUBKIND, enums, and annotation interfaces -- seeSnippet.SubKindto differentiate.A type declaration is persistent.
- See Java Language Specification:
-
7.6 Top Level Class and Interface Declarations
-
METHOD
A method declaration. The snippet is an instance ofMethodSnippet.A method declaration is persistent.
- See Java Language Specification:
-
8.4 Method Declarations
-
VAR
One variable declaration. Corresponding to one VariableDeclarator. The snippet is an instance ofVarSnippet.The variable may be with or without initializer, or be a temporary variable representing an expression -- see
Snippet.SubKindto differentiate.A variable declaration is persistent.
- See Java Language Specification:
-
8.3 Field Declarations
-
EXPRESSION
An expression, with or without side-effects. The snippet is an instance ofExpressionSnippet.The expression is currently either a simple named reference to a variable (
Snippet.SubKind.VAR_VALUE_SUBKIND) or an assignment (both of which have natural referencing names) -- seeSnippet.SubKindto differentiate. All other expression forms (operators, method calls, ...) generate a scratch variable and so are instead of the VAR Kind.- See Java Language Specification:
-
15 Expressions
-
STATEMENT
A statement. The snippet is an instance ofStatementSnippet.- See Java Language Specification:
-
14.5 Statements
-
ERRONEOUS
A syntactically incorrect input for which the specific kind could not be determined. The snippet is an instance ofErroneousSnippet.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-
isPersistent
public boolean isPersistent()Indicates whether thisKindof Snippet is persistent. Only declarations are persistent because they influence future Snippets.Note that though the
Kindof a Snippet may be persistent, that does not mean that the Snippet will persist; For example it may be invalid or have been dropped. See:Snippet.Status.isDefined().- Returns:
trueif thisKindofSnippetis visible to subsequent evaluations; otherwisefalse
-