com.octagroup.foregej.java.tools
Class GenericTool

java.lang.Object
  |
  +--com.octagroup.foregej.java.tools.GenericTool

All Implemented Interfaces:

Tool

Direct Known Subclasses:

AttrTool, CopyrightTool, ImportCleanerTool, JDocCleanerTool

public class GenericTool

extends java.lang.Object

implements Tool

This is a generic tool that can be extended.

All the processmethods returns true so that processing is forwarded to the next level.

Constructor Summary

GenericTool()

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 method) 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GenericTool

public GenericTool()

Method Detail

process

public boolean process(CompilationUnit cu)

Description copied from interface: Tool

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

Specified by:

process in interface Tool

Parameters:

cu -

Returns:

See Also:

Tool.process(com.octagroup.foregej.java.lang.ast.CompilationUnit)

process

public boolean process(AST_INTERFACE_DEF interfaze)

Description copied from interface: Tool

Signals that we have discovered an interface.

Specified by:

process in interface Tool

Parameters:

interfaze -

Returns:

See Also:

Tool.process(com.octagroup.foregej.java.lang.ast.AST_INTERFACE_DEF)

process

public boolean process(AST_CLASS_DEF clazz)

Description copied from interface: Tool

Signals that we have discovered a class.

Specified by:

process in interface Tool

Parameters:

clazz -

Returns:

See Also:

Tool.process(com.octagroup.foregej.java.lang.ast.AST_CLASS_DEF)

process

public void process(AST_METHOD_DEF method)

Description copied from interface: Tool

Signals that we have discovered a method.

Specified by:

process in interface Tool

Parameters:

method -

See Also:

Tool.process(com.octagroup.foregej.java.lang.ast.AST_METHOD_DEF)

process

public void process(AST_VARIABLE_DEF method)

Description copied from interface: Tool

Signals that we have discovered a variable.

Specified by:

process in interface Tool

Parameters:

method -

See Also:

Tool.process(com.octagroup.foregej.java.lang.ast.AST_VARIABLE_DEF)

process

public void process(AST_CTOR_DEF ctor)

Description copied from interface: Tool

Signals that we have discovered a constructor.

Specified by:

process in interface Tool

Parameters:

ctor -

See Also:

Tool.process(com.octagroup.foregej.java.lang.ast.AST_CTOR_DEF)