org.eth.cyril.bugfixer.rewriting

Class Util

java.lang.Object

org.eth.cyril.bugfixer.rewriting.Util

class Util
extends java.lang.Object

Various utility methods for rewriting which make certain operations a bit simpler.

Constructor Summary

Constructors

Constructor and Description
Util()

Method Summary

Modifier and Type	Method and Description
static org.eclipse.jdt.core.dom.Block	ensureBlock(org.eclipse.jdt.core.dom.ASTNode node, org.eclipse.jdt.core.dom.rewrite.ASTRewrite rewrite, org.eclipse.jdt.core.dom.StructuralPropertyDescriptor property) Tries to get a block from the given node with the given property.
static <T> T	getChild(org.eclipse.jdt.core.dom.ASTNode node, org.eclipse.jdt.core.dom.rewrite.ASTRewrite rewrite, org.eclipse.jdt.core.dom.StructuralPropertyDescriptor property) Gets a child from the given ASTNode, with the given rewrite being applied.
static <T> java.util.List<T>	getChildList(org.eclipse.jdt.core.dom.ASTNode node, org.eclipse.jdt.core.dom.rewrite.ASTRewrite rewrite, org.eclipse.jdt.core.dom.ChildListPropertyDescriptor property) Gets a child list from the given ASTNode, with the given rewrite being applied.
static org.eclipse.jdt.core.dom.Statement	printlnSystemOut(org.eclipse.jdt.core.dom.AST ast, org.eclipse.jdt.core.dom.Expression output) Returns a new statement which prints the result of the given expression on System.out.
static org.eclipse.jdt.core.dom.Statement	printlnSystemOut(org.eclipse.jdt.core.dom.AST ast, java.lang.String output) Returns a new statement which prints the given string output on System.out.

Methods inherited from class java.lang.Object

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

Constructor Detail

Util

Util()

Method Detail

getChild

public static <T> T getChild(org.eclipse.jdt.core.dom.ASTNode node,
                             org.eclipse.jdt.core.dom.rewrite.ASTRewrite rewrite,
                             org.eclipse.jdt.core.dom.StructuralPropertyDescriptor property)

Gets a child from the given ASTNode, with the given rewrite being applied. This method is equal to ASTRewrite.get(ASTNode, StructuralPropertyDescriptor), however casts the result to the desired type directly. For lists, use the Util#getChildList(ASTNode, ASTRewrite, StructuralPropertyDescriptor method instead.

Type Parameters:

T - The type of the child to get. Note that the cast is not checked, therefore the client must be sure that the type is correct.

Parameters:

node - The node to get a child from.

rewrite - The ASTRewrite instance which keeps track of rewritten AST elements.

property - The property to get.

Returns:

The child of the node with the specified type.

getChildList

public static <T> java.util.List<T> getChildList(org.eclipse.jdt.core.dom.ASTNode node,
                                                 org.eclipse.jdt.core.dom.rewrite.ASTRewrite rewrite,
                                                 org.eclipse.jdt.core.dom.ChildListPropertyDescriptor property)

Gets a child list from the given ASTNode, with the given rewrite being applied. The list's element type is cast to the desired type. For non-list children, use the getChild(ASTNode, ASTRewrite, StructuralPropertyDescriptor) method instead.

Type Parameters:

T - The type of the list elements to get. Note that the cast is not checked, therefore the client must be sure that the type is correct.

Parameters:

node - The node to get a child from.

rewrite - The ASTRewrite instance which keeps track of rewritten AST elements.

property - The property to get.

Returns:

The child list of the node with the specified element type.

printlnSystemOut

public static org.eclipse.jdt.core.dom.Statement printlnSystemOut(org.eclipse.jdt.core.dom.AST ast,
                                                                  java.lang.String output)

Returns a new statement which prints the given string output on System.out. Creates the statement which performs the call System.out.println(output);. See printlnSystemOut(AST, Expression) to print anything which is not a String literal.

Parameters:

ast - The AST instance to use when creating new ASTNode instances with the factory AST.newCHILD methods.

output - The output to print with System.out.

Returns:

A new statement for the given print expression.

printlnSystemOut

public static org.eclipse.jdt.core.dom.Statement printlnSystemOut(org.eclipse.jdt.core.dom.AST ast,
                                                                  org.eclipse.jdt.core.dom.Expression output)

Returns a new statement which prints the result of the given expression on System.out. Creates the statement which performs the call System.out.println(output);. See printlnSystemOut(AST, String) to directly print a string literal.

Parameters:

ast - The AST instance to use when creating new ASTNode instances with the factory AST.newCHILD methods.

output - The output to print with System.out.

Returns:

A new statement for the given print expression.

ensureBlock

public static org.eclipse.jdt.core.dom.Block ensureBlock(org.eclipse.jdt.core.dom.ASTNode node,
                                                         org.eclipse.jdt.core.dom.rewrite.ASTRewrite rewrite,
                                                         org.eclipse.jdt.core.dom.StructuralPropertyDescriptor property)

Tries to get a block from the given node with the given property. If the block is simply a statement, a new block with that statement is generated, and the statement added to it. This method is a utility method to ensure that For-Statements, If-Statements, etc. have blocks as their body instead of single statements. As a code example:

 if (x) {
  y;
  ...
 } -> left as is
 

 if (x)
   y; -> converted to the above representation
 

A non-existing statement (e.g. a missing else-block) is converted to an empty block without any statements.

Parameters:

node - The node which contains the given property, which can be a block or a single statement.

rewrite - The rewrite to use. If a block is created, the rewrite is used to set the new block.

property - The property containing the block/statement.

Returns:

Either the original block, or a block containing a single statement.