Package soot.jbco.jimpleTransformations

Class ClassRenamer

java.lang.Object

soot.Transformer

soot.SceneTransformer

soot.jbco.jimpleTransformations.ClassRenamer

All Implemented Interfaces:

IJbcoTransform

public class ClassRenamer
extends SceneTransformer
implements IJbcoTransform

SceneTransformer that renames class names as well as packages.

Since:

26-Jan-2006

Author:

Michael Batchelder, Pavel Nesterovich

Field Summary

Fields

Modifier and Type	Field	Description
static String	name

Fields inherited from interface soot.jbco.IJbcoTransform

debug, out, output

Constructor Summary

Constructors

Constructor	Description
ClassRenamer(Singletons.Global global)	Singleton constructor.

Method Summary

Modifier and Type	Method	Description
void	addClassNameMapping(String classNameSource, String classNameTarget)	Adds mapping for class name.
static String	getClassName(String fullyQualifiedClassName)	Extracts class name from fully qualified name.
Map<String,String>	getClassNameMapping(BiPredicate<String,String> predicate)	Gets mapping by predicate.
String[]	getDependencies()	Gets array of jbco transformer code names on which current transformer depends on.
String	getName()	Gets the code name of jbco transformer implementation.
String	getOrAddNewName(String packageName, String className)	Generates new unique name that have not existed before and mapping for it or gets already generated name if one was generated before.
static String	getPackageName(String fullyQualifiedClassName)	Extracts package name from class name.
protected void	internalTransform(String phaseName, Map<String,String> options)	Performs the transformation on the Scene, under the given phaseName and with the given Options.
boolean	isRemovePackages()	Checks if transformer must remove package from fully qualified class name.
boolean	isRenamePackages()	Checks if transformer must rename package in fully qualified class name.
void	outputSummary()	Prints summary of the produced changes.
void	setRemovePackages(boolean removePackages)	Sets flag indicating that transformer must remove package from fully qualified class name.
void	setRenamePackages(boolean renamePackages)	Sets flag indicating that transformer must rename package in fully qualified class name.
static ClassRenamer	v()	Singleton getter.

Methods inherited from class soot.SceneTransformer

transform, transform, transform

Methods inherited from class java.lang.Object

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

Methods inherited from interface soot.jbco.IJbcoTransform

isDebugEnabled, isVerbose

Field Detail

name

public static final String name

See Also:

Constant Field Values

Constructor Detail

ClassRenamer

public ClassRenamer(Singletons.Global global)

Singleton constructor.

Parameters:

global - the singletons container. Must not be null

Throws:

NullPointerException - when global argument is null

Method Detail

v

public static ClassRenamer v()

Singleton getter.

Returns:

returns instance of ClassRenamer

getName

public String getName()

Description copied from interface: IJbcoTransform

Gets the code name of jbco transformer implementation.

Specified by:

getName in interface IJbcoTransform

Returns:

the code name of jbco transformer

getDependencies

public String[] getDependencies()

Description copied from interface: IJbcoTransform

Gets array of jbco transformer code names on which current transformer depends on.

Specified by:

getDependencies in interface IJbcoTransform

Returns:

array of code names

outputSummary

public void outputSummary()

Description copied from interface: IJbcoTransform

Prints summary of the produced changes.

Specified by:

outputSummary in interface IJbcoTransform

isRemovePackages

public boolean isRemovePackages()

Checks if transformer must remove package from fully qualified class name.

Returns:

true if ClassRenamer removes packages from fully qualified class name; false otherwise

setRemovePackages

public void setRemovePackages(boolean removePackages)

Sets flag indicating that transformer must remove package from fully qualified class name.

Parameters:

removePackages - the flag value

isRenamePackages

public boolean isRenamePackages()

Checks if transformer must rename package in fully qualified class name.

Returns:

true if ClassRenamer renames packages in fully qualified class name; false otherwise

setRenamePackages

public void setRenamePackages(boolean renamePackages)

Sets flag indicating that transformer must rename package in fully qualified class name.

Parameters:

renamePackages - the flag value

addClassNameMapping

public void addClassNameMapping(String classNameSource,
                                String classNameTarget)

Adds mapping for class name.

Parameters:

classNameSource - the class name to rename

classNameTarget - the new class name

getClassNameMapping

public Map<String,String> getClassNameMapping(BiPredicate<String,String> predicate)

Gets mapping by predicate.

Parameters:

predicate - the predicate to decide if mapping should be filtered. Can be null

internalTransform

protected void internalTransform(String phaseName,
                                 Map<String,String> options)

Description copied from class: SceneTransformer

Performs the transformation on the Scene, under the given phaseName and with the given Options.

Specified by:

internalTransform in class SceneTransformer

getOrAddNewName

public String getOrAddNewName(String packageName,
                              String className)

Generates new unique name that have not existed before and mapping for it or gets already generated name if one was generated before.

Parameters:

packageName - the package where class is located. Can be null

className - the class name (without package) to create mapping for. Can be null

Returns:

the new unique name

getPackageName

public static String getPackageName(String fullyQualifiedClassName)

Extracts package name from class name.

Parameters:

fullyQualifiedClassName - the fully qualified class name. Can be null

Returns:

package name or null when class name is null, no '.' in the name, or package name is '.'

getClassName

public static String getClassName(String fullyQualifiedClassName)

Extracts class name from fully qualified name.

Parameters:

fullyQualifiedClassName - the fully qualified class name. Can be null

Returns:

class name or null when class name is null, no '.' in the name