org.eth.cyril.bugfixer.rewriting

Class ASTRewriteRule

java.lang.Object

org.eth.cyril.bugfixer.rewriting.ASTRewriteRule

Direct Known Subclasses:

IfConditionRewrite, LoopAndMethodCounterRewrite, LoopConditionRewrite, LoopStartRewrite, MissedAssignmentRewrite, PathOutputRewrite, SwitchFieldAccessRewrite

public abstract class ASTRewriteRule
extends java.lang.Object

An ASTRewriteRule handles rewriting specific code for the Bugfixer prototype. Each rewrite rule handles a different aspect of possible bug-fixes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ASTRewriteRule.RewriteArguments The rewrite arguments as passed to rewrite(ASTNode, ASTRewrite, RewriteArguments).
static class	ASTRewriteRule.RewritePossibilities Denotes a set of possible rewrites, where different versions can produce different results.

Constructor Summary

Constructors

Constructor and Description
ASTRewriteRule()

Method Summary

Modifier and Type	Method and Description
protected ASTRewriteRule.RewritePossibilities	createRewritePossibilities(int numberOfVersions, org.eclipse.jdt.core.dom.ASTNode node) Utility method to produce a rewrite possibility for the given number of versions and node.
protected ASTRewriteRule.RewritePossibilities	createRewritePossibilities(int numberOfVersions, int order, org.eclipse.jdt.core.dom.ASTNode node) Utility method to produce a rewrite possibility for the given number of versions and node.
abstract java.lang.String	describeRule() Returns a human-readable description of what this rule does.
abstract java.util.Collection<ASTRewriteRule.RewritePossibilities>	getRewritePossibilities(org.eclipse.jdt.core.dom.ASTNode node) Return the collection of rewrite possibilities for the given node.
void	preProcess(org.eclipse.jdt.core.dom.ASTNode root) Pre-processes the given AST node.
abstract void	rewrite(org.eclipse.jdt.core.dom.ASTNode node, org.eclipse.jdt.core.dom.rewrite.ASTRewrite rewrite, ASTRewriteRule.RewriteArguments args) Produce a rewrite according to the given ASTRewriteRule.RewriteArguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

ASTRewriteRule

public ASTRewriteRule()

Method Detail

preProcess

public void preProcess(org.eclipse.jdt.core.dom.ASTNode root)

Pre-processes the given AST node. In pre-processing, any kind of local computation may be performed by the rule, however the ASTNode will not be modified.

Parameters:

root - The node to pre-process.

getRewritePossibilities

public abstract java.util.Collection<ASTRewriteRule.RewritePossibilities> getRewritePossibilities(org.eclipse.jdt.core.dom.ASTNode node)

Return the collection of rewrite possibilities for the given node. The collection may be empty, but the result will never be null.

Parameters:

node - The node for which to get the collection of rewrite possibilities.

Returns:

A collection of rewrite possibilities. Can be empty but not null.

rewrite

public abstract void rewrite(org.eclipse.jdt.core.dom.ASTNode node,
                             org.eclipse.jdt.core.dom.rewrite.ASTRewrite rewrite,
                             ASTRewriteRule.RewriteArguments args)

Produce a rewrite according to the given ASTRewriteRule.RewriteArguments. This rule must be the same as ASTRewriteRule.RewritePossibilities.getSource() for the given arguments' rewrite possibilites instance. Otherwise, the behavior is not determined. This method may not produce any rewrite, if the ASTRewriteRule.RewriteArguments.getVersion() is 0. In other cases, it will produce some rewrite.

Parameters:

node - The node for which to produce the rewrite.

rewrite - The ASTRewrite instance to use for rewriting the node.

args - The rewrite arguments. This rule must match the source of the arguments.

describeRule

public abstract java.lang.String describeRule()

Returns a human-readable description of what this rule does. This description should optimally be translatable with a Language instance.

Returns:

A human-readable description of what this rule does.

createRewritePossibilities

protected final ASTRewriteRule.RewritePossibilities createRewritePossibilities(int numberOfVersions,
                                                                               org.eclipse.jdt.core.dom.ASTNode node)

Utility method to produce a rewrite possibility for the given number of versions and node. Sets the value of ASTRewriteRule.RewritePossibilities.getSource() to be this rule, and ASTRewriteRule.RewritePossibilities.getOrder() to be 0.

Parameters:

numberOfVersions - The possible number of rewrites produced. Must be greater than zero.

node - The node for which this rewrite possibility should be created.

Returns:

Creates a new rewrite possibilites instance which contains this rule as source and has order zero.

Throws:

java.lang.IllegalArgumentException - If the numberOfVersions is not greater than zero.

createRewritePossibilities

protected ASTRewriteRule.RewritePossibilities createRewritePossibilities(int numberOfVersions,
                                                                         int order,
                                                                         org.eclipse.jdt.core.dom.ASTNode node)

Utility method to produce a rewrite possibility for the given number of versions and node. Sets the value of ASTRewriteRule.RewritePossibilities.getSource() to be this rule. Clients may override this method to produce their own implementation of rewrite possibilities.

Parameters:

numberOfVersions - The possible number of rewrites produced. Must be greater than zero.

order - The order to give to the given rewrite possibilities instance.

node - The node for which this rewrite possibility should be created.

Returns:

Creates a new rewrite possibilites instance which contains this rule as source and has order zero.

Throws:

java.lang.IllegalArgumentException - If the numberOfVersions is not greater than zero.