Groovy 2.2.1

groovy.util.logging
[Java] Annotation Type Commons

java.lang.Object
  groovy.util.logging.Commons

@Retention(RetentionPolicy.SOURCE)
@Target({ElementType.TYPE})
@GroovyASTTransformationClass("org.codehaus.groovy.transform.LogASTTransformation")
public @interface Commons

This local transform adds a logging ability to your program using Apache Commons logging. Every method call on a unbound variable named log will be mapped to a call to the logger. For this a log field will be inserted in the class. If the field already exists the usage of this transform will cause a compilation error. The method name will be used to determine what to call on the logger.

 log.name(exp)
 
is mapped to
 if (log.isNameEnabled() {
    log.name(exp)
 }
Here name is a place holder for info, debug, warning, error, etc. If the expression exp is a constant or only a variable access the method call will not be transformed. But this will still cause a call on the injected logger.
Authors:
Hamlet D'Arcy
Matthias Cullmann
Since:
1.8.0


Nested Class Summary
static class Commons.CommonsLoggingStrategy

   
Optional Element Summary
java.lang.String category

@default LogASTTransformation.DEFAULT_CATEGORY_NAME

java.lang.Class loggingStrategy

@default CommonsLoggingStrategy.class

java.lang.String value

@default "log"

 
Method Summary
 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Element Detail

category

public String category
@default LogASTTransformation.DEFAULT_CATEGORY_NAME


loggingStrategy

public Class loggingStrategy
@default CommonsLoggingStrategy.class


value

public String value
@default "log"


 

Copyright © 2003-2013 The Codehaus. All rights reserved.