Annotation Type TraceOptions


  • @Retention(RUNTIME)
    @Target({TYPE,PACKAGE})
    public @interface TraceOptions
    The TraceOptions annotation can be used to declare which trace group a class (or classes in a package) should be asociated with. The annotation can also be used to declare whether or not debug traces should be cut when exceptions are explicitly thrown or caught.

    For example:

     @TraceOptions(traceGroup = "MyTraceGroup", traceExceptionThrow = true)
     public class Foo
     {}
     
    will associate the class Foo with the MyTraceGroup trace group and will cause debug traces to be added whenever an exception is explicitly thrown.
    or:
     @TraceOptions(traceGroups = { "BarGroup", "FooGroup" }, messageBundle = "com.ibm.bar")
     public class Bar
     {}
     
    will associate the class Bar with the trace groups BarGroup and FooGroup if the underlying trace runtime supports multiple groups. If not, only the first trace group listed will be used. The message bundle "com.ibm.bar" will be used for messages.
    • Element Detail

      • traceGroup

        java.lang.String traceGroup
        Default:
        ""
      • traceGroups

        java.lang.String[] traceGroups
        Default:
        {}
      • messageBundle

        java.lang.String messageBundle
        Default:
        ""
      • traceExceptionThrow

        boolean traceExceptionThrow
        Default:
        false
      • traceExceptionHandling

        boolean traceExceptionHandling
        Default:
        false