Класс SnippetEvent

java.lang.Object

jdk.jshell.SnippetEvent

public class SnippetEvent extends Object

Описание изменения Snippet. Эти изменения генерируются при непосредственном изменении состояния с помощью JShell.eval(String) или JShell.drop(Snippet), либо косвенно теми же методами при изменении зависимостей или перезаписи Snippet. Для непосредственных изменений causeSnippet() — null.

SnippetEvent является неизменяемым: вызов любого из его методов всегда возвращает один и тот же результат, поэтому он является потокобезопасным.

С версии:: 9

Краткое описание методов

Модификатор и тип	Метод	Описание
`Snippet`	`causeSnippet()`	Либо сниппет, изменение которого вызвало это обновление, либо `null`.
`JShellException`	`exception()`	Экземпляр `UnresolvedReferenceException`, если обнаружена неразрешённая ссылка, или экземпляр `EvalException`, если во время выполнения было выброшено исключение; в противном случае — `null`.
`boolean`	`isSignatureChange()`	Указывает, изменилась ли сигнатура.
`Snippet.Status`	`previousStatus()`	Статус до перехода.
`Snippet`	`snippet()`	Изменившийся Snippet
`Snippet.Status`	`status()`	Статус после перехода.
`String`	`toString()`	Возвращает строковое представление события
`String`	`value()`	Результат успешного выполнения.

Методы, объявленные в классе Object

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

Подробное описание методов

snippet

public Snippet snippet()

Изменившийся Snippet

Возвращает:: возвращает Snippet, у которого изменился Status.

previousStatus

public Snippet.Status previousStatus()

Статус до перехода. Если это событие описывает создание Snippet, возвращает NONEXISTENT.

Возвращает:: предыдущий статус

status

public Snippet.Status status()

Статус после перехода. Примечание: он может совпадать с предыдущим статусом (не все изменения приводят к изменению Status).

Возвращает:: статус

isSignatureChange

public boolean isSignatureChange()

Указывает, изменилась ли сигнатура. Переход в состояние определения или выход из него всегда означает изменение сигнатуры. Перезаписанный Snippet (status == OVERWRITTEN) всегда false, поскольку ответственность за определение перешла к перезаписывающему определению.

Возвращает:: true, если сигнатура изменилась; в противном случае — false

causeSnippet

public Snippet causeSnippet()

Либо сниппет, изменение которого вызвало это обновление, либо null. Возвращает null, если это изменение связано с созданием нового Snippet с помощью eval или с явным удалением Snippet с помощью drop.

Возвращает:: Snippet, вызвавший это изменение, или null, если изменение вызвано непосредственно действием API.

exception

public JShellException exception()

Экземпляр UnresolvedReferenceException, если обнаружена неразрешённая ссылка, или экземпляр EvalException, если во время выполнения было выброшено исключение; в противном случае — null.

Возвращает:: исключение или null.

value

public String value()

Результат успешного выполнения. Значение равно null, если выполнение не производилось или было выброшено исключение.

Возвращает:: значение или null.

toString

public String toString()

Возвращает строковое представление события

Переопределяет:: toString в классе Object
Возвращает:: описательное представление SnippetEvent

© 1993, 2025, 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/25/docs/api/jdk.jshell/jdk/jshell/SnippetEvent.html