Module jdk.jfr
Package jdk.jfr

Annotation Type SettingDefinition


  • @Retention(RUNTIME)
    @Target(METHOD)
    public @interface SettingDefinition
    Annotation that signifies that a method in an event class should be used to filter out events.

    For the method to be valid it must return a boolean and only have one parameter, which should be a non-abstract subclass of SettingControl

    The return value of the method should signify if the event should be committed or not.

    Example.

     
     class HelloWorld extend Event {
    
       @Label("Message");
       String message;
    
       @SettingDefinition;
       @Label("Message Filter");
       public boolean filter(RegExpControl regExp) {
         return regExp.matches(message);
       }
     }
     
     
    For an example of how setting controls can be defined see SettingControl.
    Since:
    9
    See Also:
    SettingControl