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

По умолчанию событие включено. Для отключения события, добавьте аннотацию @Enabled(false) к классу Event.

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

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

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