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:

• JShell.status(Snippet)

Nested Class Summary

Nested Classes

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 Object

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

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

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:

• Snippet.Kind

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