com.octagroup.foregej.java.tools
Interface Tool

All Known Implementing Classes:

GenericTool

public interface Tool

This is an interface for a tool.

A tool will receive notifications about a compilation unit, classes, interfaces and methods that are related to a tool.

If the ToolRunneris driven by ant all the files in the fileset will be passed to this method.

Method Summary

boolean	process(AST_CLASS_DEF clazz) Signals that we have discovered a class.
void	process(AST_CTOR_DEF ctor) Signals that we have discovered a constructor.
boolean	process(AST_INTERFACE_DEF interfaze) Signals that we have discovered an interface.
void	process(AST_METHOD_DEF method) Signals that we have discovered a method.
void	process(AST_VARIABLE_DEF variable) Signals that we have discovered a variable.
boolean	process(CompilationUnit cu) The tool that implements this method must return true if the compilation unit should be processed any further.

Method Detail

process

public boolean process(CompilationUnit cu)

The tool that implements this method must return true if the compilation unit should be processed any further.

Parameters:

cu - the compilation unit to process.

Returns:

true if processing should continue.

process

public boolean process(AST_INTERFACE_DEF interfaze)

Signals that we have discovered an interface.

Parameters:

interfaze - the interface to process.

Returns:

true if processing should continue.

process

public boolean process(AST_CLASS_DEF clazz)

Signals that we have discovered a class.

Parameters:

clazz - the class to process.

Returns:

true if processing should continue.

process

public void process(AST_METHOD_DEF method)

Signals that we have discovered a method.

Parameters:

method - the method to process.

process

public void process(AST_VARIABLE_DEF variable)

Signals that we have discovered a variable.

Parameters:

variable - the method to process.

process

public void process(AST_CTOR_DEF ctor)

Signals that we have discovered a constructor.

Parameters:

ctor - the constructor to process.