org.objectweb.jac.aspects.tracing
Interface TracingConf

All Known Implementing Classes:
TracingAC

public interface TracingConf

This sample aspect component traces the calls on all the objects of the program.

To be active this aspect component must be configured with the addTrace method.

See Also:
TracingAC, VerboseWrapper

Method Summary
 void addCounter(String name, String wrappeeExpr, String wrappeeClassExpr, String wrappeeMethodExpr)
          This configuration method makes all the matching methods invocations to be counted.
 void addNamedTrace(String wrappeeExpr, String wrappeeClassExpr, String wrappeeMethodExpr)
          This configuration method makes a method call to be traced.
 void addOptimizedCounter(String name, String wrappeeExpr, String wrappeeClassExpr, String wrappeeMethodExpr, String fieldName, String argNumber)
          This configuration method makes all the matching methods invocations to be counted in an optimized fashion.
 void addRecording(String wrappeeExpr, String wrappeeClassExpr, String wrappeeMethodExpr)
          This configuration method creates a new recording on a set of methods.
 void addStackTrace(String wrappeeExpr, String wrappeeClassExpr, String wrappeeMethodExpr)
          This configuration method makes a method call to be traced by a verbose wrapper.
 void addTrace(String wrappeeExpr, String wrappeeClassExpr, String wrappeeMethodExpr)
          This configuration method makes a method call to be traced by a verbose wrapper.
 void addWrappersTrace(String wrappeeExpr, String wrappeeClassExpr, String wrappeeMethodExpr)
          This configuration method makes a method call to be traced by a verbose wrapper.
 

Method Detail

addTrace

public void addTrace(String wrappeeExpr,
                     String wrappeeClassExpr,
                     String wrappeeMethodExpr)
This configuration method makes a method call to be traced by a verbose wrapper. By default no method is verbose.

Parameters:
wrappeeExpr - a regular expression that matches the wrappee(s) name(s) that contain the method(s) to be traced
wrappeeClassExpr - a regular expression that matches the wrappee(s) class(es) name(s) that contain the method(s) to be traced
wrappeeMethodExpr - a regular expression that matches the method(s) to be traced (within the classes or objects denoted by the previous parameters)
See Also:
VerboseWrapper

addNamedTrace

public void addNamedTrace(String wrappeeExpr,
                          String wrappeeClassExpr,
                          String wrappeeMethodExpr)
This configuration method makes a method call to be traced. The names of parameters are printed if configured by the Gui aspect.

Parameters:
wrappeeExpr - a regular expression that matches the wrappee(s) name(s) that contain the method(s) to be traced
wrappeeClassExpr - a regular expression that matches the wrappee(s) class(es) name(s) that contain the method(s) to be traced
wrappeeMethodExpr - a regular expression that matches the method(s) to be traced (within the classes or objects denoted by the previous parameters)
See Also:
VerboseWrapper

addStackTrace

public void addStackTrace(String wrappeeExpr,
                          String wrappeeClassExpr,
                          String wrappeeMethodExpr)
This configuration method makes a method call to be traced by a verbose wrapper. For each call, the stack is dumped. By default no method is verbose.

Parameters:
wrappeeExpr - a regular expression that matches the wrappee(s) name(s) that contain the method(s) to be traced
wrappeeClassExpr - a regular expression that matches the wrappee(s) class(es) name(s) that contain the method(s) to be traced
wrappeeMethodExpr - a regular expression that matches the method(s) to be traced (within the classes or objects denoted by the previous parameters)
See Also:
VerboseWrapper

addWrappersTrace

public void addWrappersTrace(String wrappeeExpr,
                             String wrappeeClassExpr,
                             String wrappeeMethodExpr)
This configuration method makes a method call to be traced by a verbose wrapper. For each call, the wrapping methods are printed. By default no method is verbose.

Parameters:
wrappeeExpr - a regular expression that matches the wrappee(s) name(s) that contain the method(s) to be traced
wrappeeClassExpr - a regular expression that matches the wrappee(s) class(es) name(s) that contain the method(s) to be traced
wrappeeMethodExpr - a regular expression that matches the method(s) to be traced (within the classes or objects denoted by the previous parameters)
See Also:
VerboseWrapper

addRecording

public void addRecording(String wrappeeExpr,
                         String wrappeeClassExpr,
                         String wrappeeMethodExpr)
This configuration method creates a new recording on a set of methods.

Parameters:
wrappeeExpr - a pointcut expression that matches the wrappee(s) name(s) that contain the method(s) to be traced
wrappeeClassExpr - a pointcut expression that matches the wrappee(s) class(es) name(s) that contain the method(s) to be traced
wrappeeMethodExpr - a pointcut expression that matches the method(s) to be traced (within the classes or objects denoted by the previous parameters)

addCounter

public void addCounter(String name,
                       String wrappeeExpr,
                       String wrappeeClassExpr,
                       String wrappeeMethodExpr)
This configuration method makes all the matching methods invocations to be counted.

Parameters:
name - the name of the counter that is used (can be shared)
wrappeeExpr - a regular expression that matches the wrappee(s) name(s) that contain the method(s) to be counted
wrappeeClassExpr - a regular expression that matches the wrappee(s) class(es) name(s) that contain the method(s) to be counted
wrappeeMethodExpr - a regular expression that matches the method(s) to be counted (within the classes or objects denoted by the previous parameters)
See Also:
SimpleCountingWrapper

addOptimizedCounter

public void addOptimizedCounter(String name,
                                String wrappeeExpr,
                                String wrappeeClassExpr,
                                String wrappeeMethodExpr,
                                String fieldName,
                                String argNumber)
This configuration method makes all the matching methods invocations to be counted in an optimized fashion.

Parameters:
name - the name of the counter that is used (can be shared)
wrappeeExpr - a regular expression that matches the wrappee(s) name(s) that contain the method(s) to be counted
wrappeeClassExpr - a regular expression that matches the wrappee(s) class(es) name(s) that contain the method(s) to be counted
wrappeeMethodExpr - a regular expression that matches the method(s) to be counted (within the classes or objects denoted by the previous parameters)
fieldName - the name of the field that is used to optimize the counting (the counter is incremented with its value), an empty string has no effect
argNumber - the argument's index that is used to optimize the counting (the counter is incremented with its value), an empty string has no effect
See Also:
OptimizedCountingWrapper