Spec-Zone.ru › OpenJDK 24

Интерфейс аннотаций имени

@Target({TYPE,FIELD,METHOD}) @Retention(RUNTIME) public @interface Name
Аннотация, устанавливающая имя по умолчанию для элемента.

Для классов событий имя должно быть корректным именем класса, как указано в языке Java (например, "com.example.Transaction"). Для полей событий или настроек событий имя должно быть допустимым идентификатором (например, "message"). Для получения дополнительной информации см. разделы 3.8 и 3.9 спецификации языка Java.

Если указанное имя некорректно, аннотация игнорируется.

Стабильное и удобное имя события имеет вид:

[org|com|net].[organization|product].EventName

События без аннотации @Name получают имя из полного квалифицированного имени класса, что хорошо подходит для экспериментов, но следует избегать в производственных приложениях.

  • Имя должно быть стабильным, чтобы избежать разрыва файлов настроек и кода, использующего или настраивающего событие.
  • Имя не должно содержать избыточной или нежелательной информации, такой как "jfr", "internal", "events" или "Event".
  • Имя должно быть коротким, но не настолько коротким, чтобы конфликтовать с другими организациями или продуктами.
  • Имя должно быть понятным и запоминающимся для пользователей, которые хотят настроить событие. Это особенно важно, если событие является частью фреймворка или библиотеки, предназначенной для использования другими. Обычно достаточно поместить все события для библиотеки или продукта в один и тот же префикс. Например, все события OpenJDK находятся в префиксе "jdk" без подпрефиксов для "hotspot", "gc" или "compiler". Это помогает избежать лишней нагрузки на когнитивные способности пользователей. Вместо этого события можно группировать по категориям, используя аннотацию @Category. Категории могут быть переименованы без нарушения зависимостей.
С момента:
9

Краткое описание обязательных элементов

Модификатор и тип Обязательный элемент Описание
String value
Возвращает имя.

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

value

String value
Возвращает имя.
Возвращает:
имя

© 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://download.java.net/java/early_access/jdk24/docs/api/jdk.jfr/jdk/jfr/Name.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API