Package org.hibernate.search.util.common.logging

Annotation Interface CategorizedLogger

@Target(TYPE) @Retention(CLASS) public @interface CategorizedLogger
Annotates a Logger interface that may produce log messages and has to be added to a report in the reference documentation. If annotated logger actually contain any log messages, the description() is mandatory.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    category
    Name of the logging category.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
    Description of a specific logging category.

  • Element Details

    • category

      String category
      Name of the logging category. All categories should start with org.hibernate.search. prefix. Also make sure that categories extend each other and, if needed, have a "module" suffix. E.g. having a common category defined in a pojo mapper as org.hibernate.search.something.mapper a corresponding category in the ORM mapper would be org.hibernate.search.something.mapper.orm. This way should allow enabling all "sub-categories" by enabling logging for a "parent" category.

    • description

      String description
      Description of a specific logging category. Goes into reference documentation report. Try to keep it vague enough to not update it each time a logger changes.
      Default:
      ""