Module jdk.jshell

Package jdk.jshell

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. 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(jdk.jshell.Snippet)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Snippet.Kind	Describes the general kind of snippet.
static class	Snippet.Status	Describes the current state of a Snippet.
static class	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.
String	toString()	Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

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 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

toString

public String toString()

Description copied from class: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.