Module org.jboss.logging.annotations
Package org.jboss.logging.annotations

Annotation Type LogMessage

@Retention(CLASS) @Target(METHOD) @Documented public @interface LogMessage
A typed logger method. Indicates that this method will log the associated Message to the logger system, as opposed to being a simple message lookup.
Author:
David M. Lloyd, James R. Perkins

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    org.jboss.logging.Logger.Level
    level
    The log level at which this message should be logged.
    Class<?>
    loggingClass
    The logging class name to use for this message, if any.
    boolean
    useThreadContext
    Indicates before the message is logged the current threads context class loader is set to the the class loader from this type.

  • Element Details

    • level

      org.jboss.logging.Logger.Level level
      The log level at which this message should be logged. Defaults to INFO.
      Returns:
      the log level
      Default:
      INFO

    • loggingClass

      Class<?> loggingClass
      The logging class name to use for this message, if any.
      Returns:
      the logging class name
      Default:
      java.lang.Void.class

    • useThreadContext

      boolean useThreadContext
      Indicates before the message is logged the current threads context class loader is set to the the class loader from this type.

      Note that special permissions may be required if running under a security manager.

      It is suggested this not be used on methods which are invoked frequently as there is overhead to this.

      Returns:
      true if the current threads context loader should be used for the log call
      Since:
      2.3.0
      See Also:
      Default:
      false