Nested and Inner Type Summary

Modifier and Type	Class and Description
public abstract static class	LogASTTransformation.AbstractLoggingStrategy
public abstract static class	LogASTTransformation.AbstractLoggingStrategyV2
public static interface	LogASTTransformation.LoggingStrategy A LoggingStrategy defines how to wire a new logger instance into an existing class.
public static interface	LogASTTransformation.LoggingStrategyV2 A LoggingStrategy defines how to wire a new logger instance into an existing class.

Field Summary

Modifier and Type	Field and Description
private CompilationUnit	compilationUnit
public static final String	DEFAULT_ACCESS_MODIFIER
public static final String	DEFAULT_CATEGORY_NAME This is just a dummy value used because String annotations values can not be null.

Inherited from org.codehaus.groovy.transform.AbstractASTTransformation:: RETENTION_CLASSNODE sourceUnit

Constructor Summary

Access	Constructor and Description
public	LogASTTransformation()

Method Summary

Modifier and Type	Method and Description
private static LogASTTransformation.LoggingStrategy	createLoggingStrategy(final AnnotationNode logAnnotation, final ClassLoader classLoader, final ClassLoader xformLoader)
private static String	lookupCategoryName(final AnnotationNode logAnnotation)
private int	lookupLogFieldModifiers(final AnnotatedNode targetClass, final AnnotationNode logAnnotation)
private static String	lookupLogFieldName(final AnnotationNode logAnnotation)
public void	setCompilationUnit(final CompilationUnit compilationUnit) Implements groovy.transform.CompilationUnitAware.setCompilationUnit.
public void	visit(final ASTNode[] The ASTnodes when the call was triggered. Element 0 is the AnnotationNode that triggered this annotation to be activated. Element 1 is the AnnotatedNode decorated, such as a MethodNode or ClassNode. For global transformations it is usually safe to ignore this parameter. nodes, final SourceUnit The source unit being compiled. The source unit may contain several classes. For global transformations, information about the AST can be retrieved from this object. sourceUnit) Implements org.codehaus.groovy.transform.ASTTransformation.visit. The method is invoked when an AST Transformation is active.

Field Detail

compilationUnit	back to summary
private CompilationUnit compilationUnit

DEFAULT_ACCESS_MODIFIER	back to summary
public static final String DEFAULT_ACCESS_MODIFIER

DEFAULT_CATEGORY_NAME	back to summary
public static final String DEFAULT_CATEGORY_NAME This is just a dummy value used because String annotations values can not be null. It will be replaced by the fully qualified class name of the annotated class.

Constructor Detail

LogASTTransformation	back to summary
public LogASTTransformation()

Method Detail

createLoggingStrategy	back to summary
private static LogASTTransformation.LoggingStrategy createLoggingStrategy(final AnnotationNode logAnnotation, final ClassLoader classLoader, final ClassLoader xformLoader)

lookupCategoryName	back to summary
private static String lookupCategoryName(final AnnotationNode logAnnotation)

lookupLogFieldModifiers	back to summary
private int lookupLogFieldModifiers(final AnnotatedNode targetClass, final AnnotationNode logAnnotation)

lookupLogFieldName	back to summary
private static String lookupLogFieldName(final AnnotationNode logAnnotation)

setCompilationUnit	back to summary
public void setCompilationUnit(final CompilationUnit compilationUnit) Implements groovy.transform.CompilationUnitAware.setCompilationUnit. Annotations @Override

setCompilationUnit

back to summary

public void setCompilationUnit(final CompilationUnit compilationUnit)

Implements groovy.transform.CompilationUnitAware.setCompilationUnit.

Annotations

@Override

visit	back to summary
public void visit(final ASTNode[] nodes, final SourceUnit sourceUnit) Implements org.codehaus.groovy.transform.ASTTransformation.visit. Doc from org.codehaus.groovy.transform.ASTTransformation.visit. The method is invoked when an AST Transformation is active. For local transformations, it is invoked once each time the local annotation is encountered. For global transformations, it is invoked once for every source unit, which is typically a source file. Parameters nodes:ASTNode[] The ASTnodes when the call was triggered. Element 0 is the AnnotationNode that triggered this annotation to be activated. Element 1 is the AnnotatedNode decorated, such as a MethodNode or ClassNode. For global transformations it is usually safe to ignore this parameter. sourceUnit:SourceUnit The source unit being compiled. The source unit may contain several classes. For global transformations, information about the AST can be retrieved from this object. Annotations @Override

visit

back to summary

public void visit(final ASTNode[] nodes, final SourceUnit sourceUnit)

Implements org.codehaus.groovy.transform.ASTTransformation.visit.

Doc from org.codehaus.groovy.transform.ASTTransformation.visit.

The method is invoked when an AST Transformation is active. For local transformations, it is invoked once each time the local annotation is encountered. For global transformations, it is invoked once for every source unit, which is typically a source file.

Parameters

nodes:ASTNode[]: The ASTnodes when the call was triggered. Element 0 is the AnnotationNode that triggered this annotation to be activated. Element 1 is the AnnotatedNode decorated, such as a MethodNode or ClassNode. For global transformations it is usually safe to ignore this parameter.
sourceUnit:SourceUnit: The source unit being compiled. The source unit may contain several classes. For global transformations, information about the AST can be retrieved from this object.

Annotations

@Override

org.codehaus.groovy.transform back to summary

public abstract Class LogASTTransformation.AbstractLoggingStrategy

Class Inheritance

extends Object
implements LoggingStrategy

java.lang.Object
org.codehaus.groovy.transform.LogASTTransformation.AbstractLoggingStrategy

All Implemented Interfaces

org.codehaus.groovy.transform.LogASTTransformation.LoggingStrategy

Known Direct Subclasses

org.codehaus.groovy.transform.LogASTTransformation.AbstractLoggingStrategyV2

Field Summary

Modifier and Type	Field and Description
protected final GroovyClassLoader	loader

Constructor Summary

Access	Constructor and Description
protected	AbstractLoggingStrategy(final GroovyClassLoader loader)
protected	AbstractLoggingStrategy()

Method Summary

Modifier and Type	Method and Description
protected ClassNode	classNode(final String name)
public String	getCategoryName(final ClassNode classNode, final String categoryName) Implements org.codehaus.groovy.transform.LogASTTransformation.LoggingStrategy.getCategoryName.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

loader	back to summary
protected final GroovyClassLoader loader

Constructor Detail

AbstractLoggingStrategy	back to summary
protected AbstractLoggingStrategy(final GroovyClassLoader loader)

AbstractLoggingStrategy	back to summary
protected AbstractLoggingStrategy()

Method Detail

classNode	back to summary
protected ClassNode classNode(final String name)

getCategoryName	back to summary
public String getCategoryName(final ClassNode classNode, final String categoryName) Implements org.codehaus.groovy.transform.LogASTTransformation.LoggingStrategy.getCategoryName. Annotations @Override

getCategoryName

back to summary

public String getCategoryName(final ClassNode classNode, final String categoryName)

Implements org.codehaus.groovy.transform.LogASTTransformation.LoggingStrategy.getCategoryName.

Annotations

@Override

org.codehaus.groovy.transform back to summary

public abstract Class LogASTTransformation.AbstractLoggingStrategyV2

Class Inheritance

extends AbstractLoggingStrategy
implements LoggingStrategyV2

java.lang.Object
org.codehaus.groovy.transform.LogASTTransformation.AbstractLoggingStrategy
org.codehaus.groovy.transform.LogASTTransformation.AbstractLoggingStrategyV2

All Implemented Interfaces

org.codehaus.groovy.transform.LogASTTransformation.LoggingStrategyV2, org.codehaus.groovy.transform.LogASTTransformation.LoggingStrategy

Known Direct Subclasses

groovy.util.logging.Commons.CommonsLoggingStrategy, groovy.util.logging.Log.JavaUtilLoggingStrategy, groovy.util.logging.Log4j.Log4jLoggingStrategy, groovy.util.logging.Log4j2.Log4j2LoggingStrategy, groovy.util.logging.Slf4j.Slf4jLoggingStrategy

Field Summary

Inherited from org.codehaus.groovy.transform.LogASTTransformation.AbstractLoggingStrategy:: loader

Constructor Summary

Access	Constructor and Description
protected	AbstractLoggingStrategyV2(final GroovyClassLoader loader)
protected	AbstractLoggingStrategyV2()

Method Summary

Modifier and Type	Method and Description
public FieldNode	addLoggerFieldToClass(final ClassNode the class that was originally annotated with the Log transformation. classNode, final String the name of the logger field fieldName, final String the name of the logging category categoryName) Implements org.codehaus.groovy.transform.LogASTTransformation.LoggingStrategy.addLoggerFieldToClass. In this method, you are given a ClassNode, a field name and a category name, and you must add a new Field onto the class.

Modifier and Type

Method and Description

public FieldNode

addLoggerFieldToClass(final ClassNode

the class that was originally annotated with the Log transformation.

classNode, final String

the name of the logger field

fieldName, final String

the name of the logging category

categoryName)

Implements org.codehaus.groovy.transform.LogASTTransformation.LoggingStrategy.addLoggerFieldToClass.

In this method, you are given a ClassNode, a field name and a category name, and you must add a new Field onto the class.

Inherited from org.codehaus.groovy.transform.LogASTTransformation.AbstractLoggingStrategy:: classNode getCategoryName

Constructor Detail

AbstractLoggingStrategyV2	back to summary
protected AbstractLoggingStrategyV2(final GroovyClassLoader loader)

AbstractLoggingStrategyV2	back to summary
protected AbstractLoggingStrategyV2()

Method Detail

addLoggerFieldToClass	back to summary
public FieldNode addLoggerFieldToClass(final ClassNode classNode, final String fieldName, final String categoryName) Implements org.codehaus.groovy.transform.LogASTTransformation.LoggingStrategy.addLoggerFieldToClass. Doc from org.codehaus.groovy.transform.LogASTTransformation.LoggingStrategy.addLoggerFieldToClass. In this method, you are given a ClassNode, a field name and a category name, and you must add a new Field onto the class. Return the result of the ClassNode.addField operations. Parameters classNode:ClassNode the class that was originally annotated with the Log transformation. fieldName:String the name of the logger field categoryName:String the name of the logging category Returns:FieldNode the FieldNode instance that was created and added to the class Annotations @Override

addLoggerFieldToClass

back to summary

public FieldNode addLoggerFieldToClass(final ClassNode classNode, final String fieldName, final String categoryName)

Implements org.codehaus.groovy.transform.LogASTTransformation.LoggingStrategy.addLoggerFieldToClass.

Doc from org.codehaus.groovy.transform.LogASTTransformation.LoggingStrategy.addLoggerFieldToClass.

In this method, you are given a ClassNode, a field name and a category name, and you must add a new Field onto the class. Return the result of the ClassNode.addField operations.

Parameters

classNode:ClassNode: the class that was originally annotated with the Log transformation.
fieldName:String: the name of the logger field
categoryName:String: the name of the logging category

Returns:FieldNode

the FieldNode instance that was created and added to the class

Annotations

@Override

org.codehaus.groovy.transform back to summary

public Interface LogASTTransformation.LoggingStrategy

Known Direct Subinterfaces: org.codehaus.groovy.transform.LogASTTransformation.LoggingStrategyV2
Known Direct Implementers: org.codehaus.groovy.transform.LogASTTransformation.AbstractLoggingStrategy

A LoggingStrategy defines how to wire a new logger instance into an existing class. It is meant to be used with the @Log family of annotations to allow you to write your own Log annotation provider.

Method Summary

Modifier and Type	Method and Description
public FieldNode	Returns: the FieldNode instance that was created and added to the class addLoggerFieldToClass(ClassNode the class that was originally annotated with the Log transformation. classNode, String the name of the logger field fieldName, String the name of the logging category categoryName) In this method, you are given a ClassNode, a field name and a category name, and you must add a new Field onto the class.
public String	getCategoryName(ClassNode classNode, String categoryName)
public boolean	isLoggingMethod(String methodName)
public Expression	wrapLoggingMethodCall(Expression logVariable, String methodName, Expression originalExpression)

Method Detail

addLoggerFieldToClass	back to summary
public FieldNode addLoggerFieldToClass(ClassNode classNode, String fieldName, String categoryName) In this method, you are given a ClassNode, a field name and a category name, and you must add a new Field onto the class. Return the result of the ClassNode.addField operations. Parameters classNode:ClassNode the class that was originally annotated with the Log transformation. fieldName:String the name of the logger field categoryName:String the name of the logging category Returns:FieldNode the FieldNode instance that was created and added to the class

addLoggerFieldToClass

back to summary

public FieldNode addLoggerFieldToClass(ClassNode classNode, String fieldName, String categoryName)

In this method, you are given a ClassNode, a field name and a category name, and you must add a new Field onto the class. Return the result of the ClassNode.addField operations.

Parameters

classNode:ClassNode: the class that was originally annotated with the Log transformation.
fieldName:String: the name of the logger field
categoryName:String: the name of the logging category

Returns:FieldNode

the FieldNode instance that was created and added to the class

getCategoryName	back to summary
public String getCategoryName(ClassNode classNode, String categoryName)

isLoggingMethod	back to summary
public boolean isLoggingMethod(String methodName)

wrapLoggingMethodCall	back to summary
public Expression wrapLoggingMethodCall(Expression logVariable, String methodName, Expression originalExpression)

org.codehaus.groovy.transform back to summary

public Interface LogASTTransformation.LoggingStrategyV2

Known Direct Implementers: org.codehaus.groovy.transform.LogASTTransformation.AbstractLoggingStrategyV2

A LoggingStrategy defines how to wire a new logger instance into an existing class. It is meant to be used with the @Log family of annotations to allow you to write your own Log annotation provider.

Method Summary

Modifier and Type	Method and Description
public FieldNode	Returns: the FieldNode instance that was created and added to the class addLoggerFieldToClass(ClassNode the class that was originally annotated with the Log transformation. classNode, String the name of the logger field fieldName, String the name of the logging category categoryName, int the modifiers (private, final, et. al.) of the logger field fieldModifiers) In this method, you are given a ClassNode, a field name and a category name, and you must add a new Field onto the class.

Modifier and Type

Method and Description

public FieldNode

Returns:

the FieldNode instance that was created and added to the class

addLoggerFieldToClass(ClassNode

the class that was originally annotated with the Log transformation.

classNode, String

the name of the logger field

fieldName, String

the name of the logging category

categoryName, int

the modifiers (private, final, et. al.) of the logger field

fieldModifiers)

In this method, you are given a ClassNode, a field name and a category name, and you must add a new Field onto the class.

Inherited from org.codehaus.groovy.transform.LogASTTransformation.LoggingStrategy:: addLoggerFieldToClass getCategoryName isLoggingMethod wrapLoggingMethodCall

Method Detail

addLoggerFieldToClass	back to summary
public FieldNode addLoggerFieldToClass(ClassNode classNode, String fieldName, String categoryName, int fieldModifiers) In this method, you are given a ClassNode, a field name and a category name, and you must add a new Field onto the class. Return the result of the ClassNode.addField operations. Parameters classNode:ClassNode the class that was originally annotated with the Log transformation. fieldName:String the name of the logger field categoryName:String the name of the logging category fieldModifiers:int the modifiers (private, final, et. al.) of the logger field Returns:FieldNode the FieldNode instance that was created and added to the class

addLoggerFieldToClass

back to summary

public FieldNode addLoggerFieldToClass(ClassNode classNode, String fieldName, String categoryName, int fieldModifiers)

In this method, you are given a ClassNode, a field name and a category name, and you must add a new Field onto the class. Return the result of the ClassNode.addField operations.

Parameters

classNode:ClassNode: the class that was originally annotated with the Log transformation.
fieldName:String: the name of the logger field
categoryName:String: the name of the logging category
fieldModifiers:int: the modifiers (private, final, et. al.) of the logger field

Returns:FieldNode

the FieldNode instance that was created and added to the class

public Class LogASTTransformation

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public abstract Class LogASTTransformation.AbstractLoggingStrategy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public abstract Class LogASTTransformation.AbstractLoggingStrategyV2

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public Interface LogASTTransformation.LoggingStrategy

Method Summary

Method Detail

public Interface LogASTTransformation.LoggingStrategyV2

Method Summary

Method Detail