Spec-Zone.ru › OpenJDK 21

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

@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, 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.jfr/jdk/jfr/Name.html

Spec-Zone.ru

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