Class OfflineInstrumenter

java.lang.Object

com.ibm.wala.shrike.shrikeBT.tools.OfflineInstrumenterBase

com.ibm.wala.shrike.shrikeBT.shrikeCT.OfflineInstrumenter

public final class OfflineInstrumenter
extends OfflineInstrumenterBase

This class provides a convenient way to iterate through a collection of Java classes and instrument their code. This is just a specialization of OfflineInstrumenterBase to use the shrikeCT functionality.

Nested Class Summary

Nested classes/interfaces inherited from class OfflineInstrumenterBase

OfflineInstrumenterBase.ManifestBuilder

Modifier and Type	Class	Description
static interface	OfflineInstrumenterBase.ManifestBuilder	Thiscallback is notified whenever an entry has been added to the output zip file.

Field Summary

Fields inherited from class OfflineInstrumenterBase

cha

Modifier and Type	Field	Description
protected ClassHierarchyProvider	cha

Constructor Summary

Constructors

Constructor	Description
OfflineInstrumenter()

Method Summary

Modifier and Type	Method	Description
protected String	getClassName(Object cl)
protected Object	makeClassFromStream(String inputName, BufferedInputStream s)
ClassInstrumenter	nextClass()	Get the next class to be instrumented.
void	outputModifiedClass(ClassInstrumenter out)	Update the original class with some method changes.
void	outputModifiedClass(ClassInstrumenter out, ClassWriter code)	Update the original class with some method changes.
protected void	writeClassTo(Object cl, Object mods, OutputStream s)

Methods inherited from class OfflineInstrumenterBase

addInputClass, addInputDirectory, addInputElement, addInputJar, addInputJarEntry, addOutputJarEntry, beginTraversal, close, copyStream, endOutputJarEntry, getLastClassResourceName, getNumInputClasses, getOutputFile, internalNextClass, internalOutputModifiedClass, parseStandardArgs, setClassHierarchyProvider, setIgnore, setJARComment, setManifestBuilder, setOutputJar, setPassUnmodifiedClasses, writeUnmodifiedClasses

Modifier and Type	Method	Description
final void	addInputClass(File baseDirectory, File f)	Add a class file containing a source class to instrument.
final void	addInputDirectory(File baseDirectory, File d)	Add a directory containing class files to instrument.
final boolean	addInputElement(File baseDirectory, String a)	Add something to instrument --- the name of a JAR file, a class file, a directory or an entry within a jar file (as filename#entryname).
final void	addInputJar(File f)	Add a JAR file containing source classes to instrument.
final void	addInputJarEntry(File f, String name)	Add a JAR entry containing a source class to instrument.
final OutputStream	addOutputJarEntry(ZipEntry ze)	Add a raw ZipEntry to the output JAR.
final void	beginTraversal()	Start traversing the source class list from the beginning.
final void	close()	Call this when you're done modifying classes.
static void	copyStream(InputStream in, OutputStream out)
final void	endOutputJarEntry()	Complete and flush the entry initiated by addOutputJarEntry.
final String	getLastClassResourceName()	Get the name of the resource containing the last class returned.
final int	getNumInputClasses()
final File	getOutputFile()	Returns the File we are storing classes into.
protected final Object	internalNextClass()
protected final boolean	internalOutputModifiedClass(Object cf, String name, Object mods)
final String[]	parseStandardArgs(String[] args)	Parse an argument list to find elements to instrument and the name of the output file.
void	setClassHierarchyProvider(ClassHierarchyProvider cha)
final void	setIgnore()	Skip the last class returned in every future traversal of the class list.
final void	setJARComment(String comment)	Set the JAR Comment for the output JAR.
void	setManifestBuilder(OfflineInstrumenterBase.ManifestBuilder mb)	This installs a ManifestBuilder callback that this class will notify whenever an entry has been added to the output zip file.
final void	setOutputJar(File f)	Set the file in which instrumented classes will be deposited.
final void	setPassUnmodifiedClasses(boolean pass)	Indicate whether classes which are not modified will be put into the output jar anyway.
final void	writeUnmodifiedClasses()	Call this to copy any unmodified classes to the output.

Methods inherited from class Object

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

Constructor Details

OfflineInstrumenter

public OfflineInstrumenter()

Method Details

makeClassFromStream

protected Object makeClassFromStream(String inputName,
 BufferedInputStream s)
                              throws IOException

Specified by:

makeClassFromStream in class OfflineInstrumenterBase

Throws:

IOException

getClassName

protected String getClassName(Object cl)

Specified by:

getClassName in class OfflineInstrumenterBase

writeClassTo

protected void writeClassTo(Object cl,
 Object mods,
 OutputStream s)
                     throws IOException

Specified by:

writeClassTo in class OfflineInstrumenterBase

Throws:

IOException

nextClass

public ClassInstrumenter nextClass()
                            throws IOException

Get the next class to be instrumented.

Throws:

IOException

outputModifiedClass

public void outputModifiedClass(ClassInstrumenter out,
 ClassWriter code)
                         throws IllegalStateException,
IOException

Update the original class with some method changes. 'code' should be the result of out.emitClass(). You can add new fields and methods to 'code' (or make other changes) before calling this method.

Throws:

IllegalStateException

IOException

outputModifiedClass

public void outputModifiedClass(ClassInstrumenter out)
                         throws IllegalArgumentException,
IOException

Update the original class with some method changes. This method calls out.emitClass() for you.

Throws:

IllegalArgumentException

IOException