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(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:
  • 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