W3cubDocs

/OpenJDK 21

Class Snippet

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 to JShell.eval(java.lang.String). It is associated only with the JShell instance 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, query JShell passing the Snippet.

Because it is immutable, Snippet (and subclasses) is thread-safe.

Since:
9
See Also:

Nested Class Summary

Modifier and Type Class Description
static enum  Snippet.Kind
Describes the general kind of snippet.
static enum  Snippet.Status
Describes the current state of a Snippet.
static enum  Snippet.SubKind
The detailed variety of a snippet.

Method Summary

Modifier and Type Method Description
String id()
The unique identifier for the snippet.
Snippet.Kind kind()
The Snippet.Kind for the snippet.
String source()
Return the source code of the snippet.
Snippet.SubKind subKind()
Return the Snippet.SubKind of snippet.

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

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 in JShell.Builder.idGenerator(BiFunction).
Returns:
the snippet id string.

kind

public Snippet.Kind kind()
The Snippet.Kind for the snippet. Indicates the subclass of Snippet.
Returns:
the Kind of the snippet
See Also:

subKind

public Snippet.SubKind subKind()
Return the Snippet.SubKind of 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

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/jdk.jshell/jdk/jshell/Snippet.html