Класс 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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создаёт и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли какой-либо другой объект этому объекту.
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API подлежит удалению в будущей версии. Финализация объявлена устаревшей и подлежит удалению в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`final void`	`wait()`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно посредством уведомления или прерывания.
`final void`	`wait(long timeoutMillis)`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно посредством уведомления или прерывания, либо до истечения заданного промежутка времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно посредством уведомления или прерывания, либо до истечения заданного промежутка времени.

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

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.