ptolemy.backtrack.eclipse.ast.transform

Class PackageRule

java.lang.Object

ptolemy.backtrack.eclipse.ast.transform.TransformRule

ptolemy.backtrack.eclipse.ast.transform.PackageRule

public class PackageRule
extends TransformRule

Package renaming rule. This rule specifies the actions to be executed before and after TypeAnalyzer traverses an AST. Those actions rename the package that contains the given class.

Since:

Ptolemy II 5.1

Version:

$Id$

Author:

Thomas Feng

Pt.AcceptedRating:

Red (tfeng)

Pt.ProposedRating:

Red (tfeng)

Constructor Summary

Constructors

Constructor and Description
PackageRule()

Method Summary

Modifier and Type	Method and Description
void	afterTraverse(TypeAnalyzer analyzer, org.eclipse.jdt.core.dom.CompilationUnit root) Rename the occurance of package names after the AST is traversed.
void	beforeTraverse(TypeAnalyzer analyzer, org.eclipse.jdt.core.dom.CompilationUnit root) Execute actions before the AST is traversed.
java.lang.String	getPrefix() Get the prefix to be added to the old package name.
void	setPrefix(java.lang.String prefix) Set the prefix to be added to the old package name.

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageRule

public PackageRule()

Method Detail

afterTraverse

public void afterTraverse(TypeAnalyzer analyzer,
                          org.eclipse.jdt.core.dom.CompilationUnit root)

Rename the occurance of package names after the AST is traversed. The transformer implemented for this rule traverses the AST once again and looks up package names that need to be changed.

Due to the change of the package that the class belongs to, originally accessible classes in the same package may becomes inaccessable. This transformer explicitly imports those classes when necessary. Unfortunately, protected classes originally in the same package may not be imported, and protected members of other classes in that package are no longer accessible. It is the user's responsibility to ensure that those cases do not happen.

Specified by:

afterTraverse in class TransformRule

Parameters:

analyzer - The type analyzer.

root - The root of the AST.

See Also:

TransformRule.beforeTraverse(TypeAnalyzer, CompilationUnit)

beforeTraverse

public void beforeTraverse(TypeAnalyzer analyzer,
                           org.eclipse.jdt.core.dom.CompilationUnit root)

Execute actions before the AST is traversed. (Not necessary for this rule.)

Specified by:

beforeTraverse in class TransformRule

Parameters:

analyzer - The type analyzer.

root - The root of the AST.

See Also:

TransformRule.afterTraverse(TypeAnalyzer, CompilationUnit)

getPrefix

public java.lang.String getPrefix()

Get the prefix to be added to the old package name.

Returns:

The prefix.

See Also:

setPrefix(String)

setPrefix

public void setPrefix(java.lang.String prefix)

Set the prefix to be added to the old package name.

Parameters:

prefix - The prefix.

See Also:

getPrefix()