- java.lang.Object
- jdk.jshell.Snippet
- Direct Known Subclasses:
ErroneousSnippet,ExpressionSnippet,PersistentSnippet,StatementSnippet
public abstract class Snippet extends Object
A Snippet represents a snippet of Java source code as passed toJShell.eval(java.lang.String). It is associated only with theJShellinstance that created it. An instance of Snippet (including its subclasses) is immutable: an access to any of its methods will always return the same result. For information about the current state of the snippet within the JShell state engine, queryJShellpassing the Snippet.Because it is immutable,
Snippet(and subclasses) is thread-safe.- Since:
- 9
- See Also:
JShell.status(jdk.jshell.Snippet)
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSnippet.KindDescribes the general kind of snippet.static classSnippet.StatusDescribes the current state of a Snippet.static classSnippet.SubKindThe detailed variety of a snippet.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringid()The unique identifier for the snippet.Snippet.Kindkind()TheSnippet.Kindfor the snippet.Stringsource()Return the source code of the snippet.Snippet.SubKindsubKind()Return theSnippet.SubKindof snippet.
Method Detail
id
public String id()
The unique identifier for the snippet. No two active snippets will have the same id(). Value of id has no prescribed meaning. The details of how the id is generated and the mechanism to change it is documented inJShell.Builder.idGenerator(BiFunction).- Returns:
- the snippet id string.
kind
public Snippet.Kind kind()
TheSnippet.Kindfor the snippet. Indicates the subclass of Snippet.- Returns:
- the Kind of the snippet
- See Also:
Snippet.Kind
subKind
public Snippet.SubKind subKind()
Return theSnippet.SubKindof snippet. The SubKind is useful for feedback to users.- Returns:
- the SubKind corresponding to this snippet
source
public String source()
Return the source code of the snippet.- Returns:
- the source code corresponding to this snippet