- java.lang.Object
-
- java.lang.Enum<Snippet.Status>
-
- jdk.jshell.Snippet.Status
-
- All Implemented Interfaces:
Serializable,Comparable<Snippet.Status>
- Enclosing class:
- Snippet
public static enum Snippet.Status extends Enum<Snippet.Status>
Describes the current state of a Snippet. This is a dynamic property of a Snippet within the JShell state -- thus is retrieved with a query on {@code JShell}.The
Statuschanges as the state changes. For example, creation of another snippet withevalmay resolve dependencies of this Snippet (or invalidate those dependencies), or overwrite this Snippet changing itsStatus.Important properties associated with
Statusare:isDefined(), if it is visible to other existing and new snippets; andisActive(), if, as the JShell state changes, the snippet will update, possibly changingStatus. An executable Snippet can only be executed if it is in the theVALIDStatus.- See Also:
JShell.status(jdk.jshell.Snippet)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description DROPPEDThe snippet is inactive because of an explicit call to theJShell.drop(Snippet).NONEXISTENTThe snippet is inactive because it does not yet exist.OVERWRITTENThe snippet is inactive because it has been replaced by a new snippet.RECOVERABLE_DEFINEDThe snippet is a declaration snippet with potentially recoverable unresolved references or other issues in its body (in the context of currentJShellstate).RECOVERABLE_NOT_DEFINEDThe snippet is a declaration snippet with potentially recoverable unresolved references or other issues (in the context of currentJShellstate).REJECTEDThe snippet is inactive because it failed compilation on initial evaluation and it is not capable of becoming valid with further changes to the JShell state.VALIDThe snippet is a valid snippet (in the context of currentJShellstate).
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanisActive()Indicates whether the Snippet is active, that is, will a persistent snippet be re-evaluated when a newJShell.eval(String)orJShell.drop(Snippet)that could change its status is invoked.booleanisDefined()Indicates whether the snippet is currently part of the defined state of the JShell.static Snippet.StatusvalueOf(String name)Returns the enum constant of this type with the specified name.static Snippet.Status[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
VALID
public static final Snippet.Status VALID
The snippet is a valid snippet (in the context of currentJShellstate). Only snippets withVALIDStatuscan be executed (though not allVALIDsnippets have executable code).The snippet is defined (
isDefined() == true). If the snippet is a declaration or import (Snippet.Kind.isPersistent()), it is visible to other snippetsThe snippet will update as dependents change (
isActive() == true), its status could becomeRECOVERABLE_DEFINED,RECOVERABLE_NOT_DEFINED,DROPPED, orOVERWRITTEN.
-
RECOVERABLE_DEFINED
public static final Snippet.Status RECOVERABLE_DEFINED
The snippet is a declaration snippet with potentially recoverable unresolved references or other issues in its body (in the context of currentJShellstate). Only aDeclarationSnippetcan have thisStatus.The snippet has a valid signature and it is visible to other snippets (
isDefined() == true) and thus can be referenced in existing or new snippets but the snippet cannot be executed. AnUnresolvedReferenceExceptionwill be thrown on an attempt to execute it.The snippet will update as dependents change (
isActive() == true), its status could becomeVALID,RECOVERABLE_NOT_DEFINED,DROPPED, orOVERWRITTEN.Note: both
RECOVERABLE_DEFINEDandRECOVERABLE_NOT_DEFINEDindicate potentially recoverable errors, they differ in that, forRECOVERABLE_DEFINED, the snippet is defined.
-
RECOVERABLE_NOT_DEFINED
public static final Snippet.Status RECOVERABLE_NOT_DEFINED
The snippet is a declaration snippet with potentially recoverable unresolved references or other issues (in the context of currentJShellstate). Only aDeclarationSnippetcan have thisStatus.The snippet has an invalid signature or the implementation is otherwise unable to define it. The snippet it is not visible to other snippets (
isDefined() == false) and thus cannot be referenced or executed.The snippet will update as dependents change (
isActive() == true), its status could becomeVALID,RECOVERABLE_DEFINED,DROPPED, orOVERWRITTEN.Note: both
RECOVERABLE_DEFINEDandRECOVERABLE_NOT_DEFINEDindicate potentially recoverable errors, they differ in that, forRECOVERABLE_DEFINED, the snippet is defined.
-
DROPPED
public static final Snippet.Status DROPPED
The snippet is inactive because of an explicit call to theJShell.drop(Snippet).The snippet is not visible to other snippets (
isDefined() == false) and thus cannot be referenced or executed.The snippet will not update as dependents change (
isActive() == false), itsStatuswill never change again.
-
OVERWRITTEN
public static final Snippet.Status OVERWRITTEN
The snippet is inactive because it has been replaced by a new snippet. This occurs when the new snippet added withevalmatches a previous snippet. ATypeDeclSnippetwill match anotherTypeDeclSnippetif the names match. For exampleclass X { }will overwriteclass X { int ii; }orinterface X { }. AMethodSnippetwill match anotherMethodSnippetif the names and parameter types match. For examplevoid m(int a) { }will overwriteint m(int a) { return a+a; }. AVarSnippetwill match anotherVarSnippetif the names match. For exampledouble z;will overwritelong z = 2L;. Only aPersistentSnippetcan have thisStatus.The snippet is not visible to other snippets (
isDefined() == false) and thus cannot be referenced or executed.The snippet will not update as dependents change (
isActive() == false), itsStatuswill never change again.
-
REJECTED
public static final Snippet.Status REJECTED
The snippet is inactive because it failed compilation on initial evaluation and it is not capable of becoming valid with further changes to the JShell state.The snippet is not visible to other snippets (
isDefined() == false) and thus cannot be referenced or executed.The snippet will not update as dependents change (
isActive() == false), itsStatuswill never change again.
-
NONEXISTENT
public static final Snippet.Status NONEXISTENT
The snippet is inactive because it does not yet exist. Used only inSnippetEvent.previousStatusfor new snippets.JShell.status(Snippet)will never return thisStatus.Vacuously,
isDefined()andisActive()are both definedfalse.
-
-
Method Detail
-
values
public static Snippet.Status[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (Snippet.Status c : Snippet.Status.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Snippet.Status valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException- if the argument is null
-
isActive
public boolean isActive()
Indicates whether the Snippet is active, that is, will a persistent snippet be re-evaluated when a newJShell.eval(String)orJShell.drop(Snippet)that could change its status is invoked. This is more broad thanisDefined()since a Snippet which isRECOVERABLE_NOT_DEFINEDwill be updated.- Returns:
trueif the Snippet is active; otherwisefalse
-
isDefined
public boolean isDefined()
Indicates whether the snippet is currently part of the defined state of the JShell. Is it visible to compilation of other snippets?- Returns:
trueif the Snippet is defined; otherwisefalse
-
-