Класс Event

Следующий пример демонстрирует, как реализовать класс Event.

public class Example {

    @Label("Hello World")
    @Description("Helps programmer getting started")
    static class HelloWorld extends Event {
        @Label("Message")
        String message;
    }

    public static void main(String... args) {
        HelloWorld event = new HelloWorld();
        event.message = "hello, world!";
        event.commit();
    }
}

После выделения события и заполнения его членов-полей, его можно записать в систему Flight Recorder, используя метод commit().

По умолчанию, событие включено. Чтобы отключить событие, анотируйте класс Event с @Enabled(false).

Поддерживаемые типы полей — это базовые типы Java: boolean, char, byte, short, int, long, float, и double. Поддерживаемые типы ссылок: String, Thread и Class. Массивы, перечисления и другие типы ссылок игнорируются и не включаются. Поля поддерживаемых типов могут быть исключены с помощью модификатора transient. Статические поля, даже поддерживаемых типов, не включаются.

Инструменты могут визуализировать данные осмысленным образом, когда используются аннотации (например, Label, Description, и Timespan). Аннотации, примененные к классу Event или его полям, включаются, если они присутствуют (косвенно, непосредственно или ассоциированы), имеют аннотацию MetadataDefinition, и не содержат перечислений, массивов или классов.

Сбор данных для хранения в событии может быть дорогостоящим. Метод shouldCommit() можно использовать для проверки, будет ли экземпляр события фактически записан в систему, когда вызывается метод commit(). Если shouldCommit() возвращает false, то эти операции можно избежать.