- java.lang.Object
-
- jdk.jshell.SnippetEvent
-
public class SnippetEvent extends Object
A description of a change to a Snippet. These are generated by direct changes to state withJShell.eval(String)orJShell.drop(Snippet), or indirectly by these same methods as dependencies change or Snippets are overwritten. For direct changes, thecauseSnippet()isnull.SnippetEventis immutable: an access to any of its methods will always return the same result. and thus is thread-safe.- Since:
- 9
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SnippetcauseSnippet()Either the snippet whose change caused this update ornull.JShellExceptionexception()An instance ofUnresolvedReferenceException, if an unresolved reference was encountered, or an instance ofEvalExceptionif an exception was thrown during execution, otherwisenull.booleanisSignatureChange()Indicates whether the signature has changed.Snippet.StatuspreviousStatus()The status before the transition.Snippetsnippet()The Snippet which has changedSnippet.Statusstatus()The after status.StringtoString()Return a string representation of the eventStringvalue()The result value of successful run.
-
-
-
Method Detail
-
snippet
public Snippet snippet()
The Snippet which has changed- Returns:
- the return the Snippet whose
Statushas changed.
-
previousStatus
public Snippet.Status previousStatus()
The status before the transition. If this event describes a Snippet creation returnNONEXISTENT.- Returns:
- the previousStatus
-
status
public Snippet.Status status()
The after status. Note: this may be the same as the previous status (not all changes cause aStatuschange.- Returns:
- the status
-
isSignatureChange
public boolean isSignatureChange()
Indicates whether the signature has changed. Coming in or out of definition is always a signature change. An overwritten Snippet(status == OVERWRITTEN)is alwaysfalseas responsibility for the definition has passed to the overwriting definition.- Returns:
trueif the signature changed; otherwisefalse
-
causeSnippet
public Snippet causeSnippet()
Either the snippet whose change caused this update ornull. This returnsnullif this change is the creation of a new Snippet viaevalor it is the explicit drop of a Snippet withdrop.- Returns:
- the Snippet which caused this change or
nullif directly caused by an API action.
-
exception
public JShellException exception()
An instance ofUnresolvedReferenceException, if an unresolved reference was encountered, or an instance ofEvalExceptionif an exception was thrown during execution, otherwisenull.- Returns:
- the exception or
null.
-
value
public String value()
The result value of successful run. The value is null if not executed or an exception was thrown.- Returns:
- the value or
null.
-
-