org.eth.cyril.bugfixer.rewriting

Class ASTRewriteRule.RewriteArguments

java.lang.Object

org.eth.cyril.bugfixer.rewriting.ASTRewriteRule.RewriteArguments

Enclosing class:

ASTRewriteRule

public static class ASTRewriteRule.RewriteArguments
extends java.lang.Object

The rewrite arguments as passed to ASTRewriteRule.rewrite(ASTNode, ASTRewrite, RewriteArguments). This class is closely related to the ASTRewriteRule.RewritePossibilities.

Constructor Summary

Constructors

Constructor and Description
RewriteArguments(int version, ASTRewriteRule.RewritePossibilities possibilities) Create a new rewrite argument.

Method Summary

Modifier and Type	Method and Description
ASTRewriteRule.RewritePossibilities	getRewritePossibilities() The rewrite possibilities instance upon which this argument is based.
int	getVersion() The version of the rewrite to produce by these arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

RewriteArguments

public RewriteArguments(int version,
                        ASTRewriteRule.RewritePossibilities possibilities)

Create a new rewrite argument. The given version number must be in [0, ASTRewriteRule.RewritePossibilities.getNumberOfVersions()) for the given RewritePossibilites argument.

Parameters:

version - The version, in [0, numVersions].

possibilities - The rewrite possibilities instance upon which this argument depends.

Throws:

java.lang.IllegalArgumentException - If the version is negative, or greater equal to the number of versions

java.lang.NullPointerException - If the possibilities parameter is null.

Method Detail

getVersion

public int getVersion()

The version of the rewrite to produce by these arguments. Generally, version == 0 signifies the default version. In some cases, that means that no rewrite occurs for version 0. Other rules may always produce rewrites, however with version == 0 producing the basic rewrite. This value is guaranteed to be in the interval [0, ASTRewriteRule.RewritePossibilities.getNumberOfVersions()) for the value of getRewritePossibilities().

Returns:

The rewrite version.

getRewritePossibilities

public ASTRewriteRule.RewritePossibilities getRewritePossibilities()

The rewrite possibilities instance upon which this argument is based. This will never return null.