lombok

Annotation Type CustomLog

@Retention(value=SOURCE)
 @Target(value=TYPE)
public @interface CustomLog

Causes lombok to generate a logger field based on a custom logger implementation.

Complete documentation is found at the project lombok features page for lombok log annotations.

Example:

 @CustomLog
 public class LogExample {
 }
 

With configuration:

 lombok.log.custom.declaration=my.cool.Logger my.cool.LoggerFactory.getLogger(NAME)
 

will generate:

 public class LogExample {
     private static final my.cool.Logger log = my.cool.LoggerFactory.getLogger(LogExample.class.getName());
 }
 

Configuration must be provided in lombok.config, otherwise any usage of this annotation will result in a compile-time error. This annotation is valid for classes and enumerations.

See Also:

@Log, @CommonsLog, @Log4j, @Log4j2, @Slf4j, @XSlf4j, @JBossLog, @Flogger

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
AccessLevel	access Sets the access level of the generated log field.
String	topic Sets a custom topic/category.

Element Detail

access

public abstract AccessLevel access

Sets the access level of the generated log field. Default: AccessLevel.PRIVATE.

Returns:

The constructed Logger method will be generated with this access modifier.

Default:

lombok.AccessLevel.PRIVATE

topic

public abstract String topic

Sets a custom topic/category. Note that this requires you to specify a parameter configuration for your custom logger that includes TOPIC.

Returns:

The topic/category of the constructed Logger. By default (or for the empty string as topic), the parameter configuration without TOPIC is invoked.

Default:

""