Класс SnippetEvent

java.lang.Object

jdk.jshell.SnippetEvent

public class SnippetEvent extends Object

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

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

Since:: 9

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

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

Методы, объявленные в классе java.lang.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.

Возвращает:: previousStatus

status

public Snippet.Status status()

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

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

isSignatureChange

public boolean isSignatureChange()

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

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

causeSnippet

public Snippet causeSnippet()

Либо snippet, вызвавший это обновление, либо 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()

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

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

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