org.eth.cyril.bugfixer.rewriting

Class MissedAssignmentRewrite

java.lang.Object

org.eth.cyril.bugfixer.rewriting.ASTRewriteRule

org.eth.cyril.bugfixer.rewriting.MissedAssignmentRewrite

public class MissedAssignmentRewrite
extends ASTRewriteRule

Rewrite rules which adds missing assignments as might often be e.g. found in linked lists. These added assignments are of the form "var1.field = var2". Here, "var1" and "var2" must be of the same type, the "field" field must therefore refer to a field of the same type as the class it is declared in. Linked-list example: head.next = newHead;

Nested Class Summary

Nested classes/interfaces inherited from class org.eth.cyril.bugfixer.rewriting.ASTRewriteRule

ASTRewriteRule.RewriteArguments, ASTRewriteRule.RewritePossibilities

Constructor Summary

Constructors

Constructor and Description
MissedAssignmentRewrite()

Method Summary

Modifier and Type	Method and Description
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.
java.lang.String	describeRule() Returns a human-readable description of what this rule does.
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.
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 org.eth.cyril.bugfixer.rewriting.ASTRewriteRule

createRewritePossibilities

Methods inherited from class java.lang.Object

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

Constructor Detail

MissedAssignmentRewrite

public MissedAssignmentRewrite()

Method Detail

preProcess

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

Description copied from class: ASTRewriteRule

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.

Overrides:

preProcess in class ASTRewriteRule

Parameters:

root - The node to pre-process.

describeRule

public java.lang.String describeRule()

Description copied from class: ASTRewriteRule

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

Specified by:

describeRule in class ASTRewriteRule

Returns:

A human-readable description of what this rule does.

getRewritePossibilities

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

Description copied from class: ASTRewriteRule

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

Specified by:

getRewritePossibilities in class ASTRewriteRule

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 void rewrite(org.eclipse.jdt.core.dom.ASTNode node,
                    org.eclipse.jdt.core.dom.rewrite.ASTRewrite rewrite,
                    ASTRewriteRule.RewriteArguments args)

Description copied from class: ASTRewriteRule

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.

Specified by:

rewrite in class ASTRewriteRule

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.

createRewritePossibilities

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

Description copied from class: ASTRewriteRule

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.

Overrides:

createRewritePossibilities in class ASTRewriteRule

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.