com.videobug.agent.weaver

Class WeaveLog

java.lang.Object

com.videobug.agent.weaver.WeaveLog

public class WeaveLog
extends Object

This object generates data IDs and records the weaving process for a single class file. If a bytecode weaving is terminated by an error, the generated data IDs are disabled by disposing this log object.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEPARATOR

Constructor Summary

Constructors

Constructor and Description
WeaveLog(int classId, int nextMethodId, int nextDataId) Create an instance having the given state.

Method Summary

Modifier and Type	Method and Description
ArrayList<com.insidious.common.weaver.DataInfo>	getDataEntries()
String	getFullClassName()
String	getLog()
ArrayList<com.insidious.common.weaver.MethodInfo>	getMethods()
int	getNextDataId()
int	getNextMethodId()
void	log(String message) Record an error message.
int	nextDataId(int line, int instructionIndex, com.insidious.common.weaver.EventType eventType, com.insidious.common.weaver.Descriptor valueDesc, String attributes) Create a new Data ID and record the information.
void	setFullClassName(String name) Record the current target class with a full class name obtained from a target class file.
void	startMethod(String className, String methodName, String methodDesc, int access, String sourceFileName, String methodHash) Record a woven method name.

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final String SEPARATOR

See Also:

Constant Field Values

Constructor Detail

WeaveLog

public WeaveLog(int classId,
                int nextMethodId,
                int nextDataId)

Create an instance having the given state.

Parameters:

classId - is the ID used by the target class (if succeeded)

nextMethodId - is the first ID of the methods of the target class

nextDataId - is the first ID of the data IDs of the target class

Method Detail

getFullClassName

public String getFullClassName()

Returns:

the full class name that is currently woven.

setFullClassName

public void setFullClassName(String name)

Record the current target class with a full class name obtained from a target class file. This is separated from the constructor because the class name is unavailable at the beginning of the weaving process.

Parameters:

name - fully qualified class name of the weaved target

getNextMethodId

public int getNextMethodId()

Returns:

the next method ID after this weaving.

getNextDataId

public int getNextDataId()

Returns:

the next data ID. This method is to transfer the current Data ID to the next weaving target class.

startMethod

public void startMethod(String className,
                        String methodName,
                        String methodDesc,
                        int access,
                        String sourceFileName,
                        String methodHash)

Record a woven method name.

Parameters:

className - is a class name.

methodName - is a method name.

methodDesc - is a descriptor representing the signature.

access - represents modifiers, e.g. static.

sourceFileName - specifies a source file name recorded in the class file.

methodHash - hash for the method being visited

nextDataId

public int nextDataId(int line,
                      int instructionIndex,
                      com.insidious.common.weaver.EventType eventType,
                      com.insidious.common.weaver.Descriptor valueDesc,
                      String attributes)

Create a new Data ID and record the information.

Parameters:

line - specifies the line number.

instructionIndex - specifies the location of the instruction in the ASM's InsnList object.

eventType - is an event type (decided by the instruction type).

valueDesc - specifies a data type of the value observed by the event.

attributes - specifies additional static information obtained from bytecode.

Returns:

the next available id which can be used for the dataInfo

log

public void log(String message)

Record an error message.

Parameters:

message - message to be logged

getLog

public String getLog()

Returns:

a string including the error messages recorded in this object.

getDataEntries

public ArrayList<com.insidious.common.weaver.DataInfo> getDataEntries()

Returns:

data ID objects created during the weaving.

getMethods

public ArrayList<com.insidious.common.weaver.MethodInfo> getMethods()

Returns:

methods processed by this weaving.