Javassist 3.30.2-GA · javassist.CtBehavior · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
protected MethodInfo	methodInfo

Access	Constructor and Description
protected	CtBehavior(CtClass clazz, MethodInfo minfo)

Method Summary

Modifier and Type	Method and Description
public void	addCatch(String the source code representing the catch clause. It must be a single statement or block. src, CtClass the type of the exception handled by the catch clause. exceptionType) Adds a catch clause that handles an exception thrown in the body.
public void	addCatch(String the source code representing the catch clause. It must be a single statement or block. src, CtClass the type of the exception handled by the catch clause. exceptionType, String the name of the variable containing the caught exception, for example, `$e`. exceptionName) Adds a catch clause that handles an exception thrown in the body.
public void	addLocalVariable(String the name of the variable name, CtClass the type of the variable type) Declares a new local variable.
public void	addParameter(CtClass type) Appends a new parameter, which becomes the last parameter.
private void	addParameter2(int where, CtClass type, String desc)
pack-priv void	copy(CtBehavior src, boolean true if this is a constructor. isCons, ClassMap map)
protected void	extendToString(StringBuilder buffer) Implements abstract javassist.CtMember.extendToString. Invoked by `toString()` to add to the buffer and provide the complete value.
public Object	Returns: the annotation if found, otherwise `null`. getAnnotation(Class<?> the annotation class. clz) Implements abstract javassist.CtMember.getAnnotation. Returns the annotation if the class has the specified annotation class.
public Object[]	Returns: an array of annotation-type objects. getAnnotations() Implements abstract javassist.CtMember.getAnnotations. Returns the annotations associated with this method or constructor.
private Object[]	getAnnotations(boolean ignoreNotFound)
public byte[]	getAttribute(String attribute name name) Implements abstract javassist.CtMember.getAttribute. Obtains an attribute with the given name.
public Object[]	Returns: an array of annotation-type objects. getAvailableAnnotations() Implements abstract javassist.CtMember.getAvailableAnnotations. Returns the annotations associated with this method or constructor.
public Object[][]	Returns: an array of annotation-type objects. The length of the returned array is equal to the number of the formal parameters. If each parameter has no annotation, the elements of the returned array are empty arrays. getAvailableParameterAnnotations() Returns the parameter annotations associated with this method or constructor.
public CtClass[]	Returns: a zero-length array if there is no throws clause. getExceptionTypes() Obtains exceptions that this method/constructor may throw.
public String	getGenericSignature() Implements abstract javassist.CtMember.getGenericSignature. Returns the generic signature of the method.
public abstract String	getLongName() Returns the method or constructor name followed by parameter types such as `javassist.CtBehavior.stBody(String)`.
public MethodInfo	getMethodInfo() Returns the `MethodInfo` representing this method/constructor in the class file.
public MethodInfo	getMethodInfo2() Returns the `MethodInfo` representing the method/constructor in the class file (read only).
public int	Returns: modifiers encoded with `javassist.Modifier`. getModifiers() Implements abstract javassist.CtMember.getModifiers. Obtains the modifiers of the method/constructor.
public Object[][]	Returns: an array of annotation-type objects. The length of the returned array is equal to the number of the formal parameters. If each parameter has no annotation, the elements of the returned array are empty arrays. getParameterAnnotations() Returns the parameter annotations associated with this method or constructor.
pack-priv Object[][]	getParameterAnnotations(boolean ignoreNotFound)
public CtClass[]	getParameterTypes() Obtains parameter types of this method/constructor.
pack-priv CtClass	getReturnType0() Obtains the type of the returned value.
public String	getSignature() Implements abstract javassist.CtMember.getSignature. Returns the method signature (the parameter types and the return type).
pack-priv int	getStartPosOfBody(CodeAttribute ca)
public boolean	Returns: `true` if the annotation is found, otherwise `false`. hasAnnotation(String the name of annotation type. typeName) Implements abstract javassist.CtMember.hasAnnotation. Returns true if the class has the specified annotation type.
public void	insertAfter(String the source code representing the inserted bytecode. It must be a single statement or block. src) Inserts bytecode at the end of the body.
public void	insertAfter(String the source code representing the inserted bytecode. It must be a single statement or block. src, boolean true if the inserted bytecode is executed not only when the control normally returns but also when an exception is thrown. If this parameter is true, the inserted code cannot access local variables. asFinally) Inserts bytecode at the end of the body.
public void	insertAfter(String the source code representing the inserted bytecode. It must be a single statement or block. src, boolean true if the inserted bytecode is executed not only when the control normally returns but also when an exception is thrown. If this parameter is true, the inserted code cannot access local variables. asFinally, boolean if true, redundant bytecode will be generated. the redundancy is necessary when some compilers (Kotlin?) generate the original bytecode. The other `insertAfter` methods calls this method with `false` for this parameter. A tip is to pass `this.getDeclaringClass().isKotlin()` to this parameter. redundant) Inserts bytecode at the end of the body.
private int	insertAfterAdvice(Bytecode code, Javac jv, String src, ConstPool cp, CtClass rtype, int varNo)
private int	insertAfterHandler(boolean asFinally, Bytecode b, CtClass rtype, int returnVarNo, Javac javac, String src)
public int	Returns: the line number at which the bytecode has been inserted. insertAt(int the line number. The bytecode is inserted at the beginning of the code at the line specified by this line number. lineNum, String the source code representing the inserted bytecode. It must be a single statement or block. src) Inserts bytecode at the specified line in the body.
public int	Returns: the line number at which the bytecode has been inserted. insertAt(int the line number. The bytecode is inserted at the beginning of the code at the line specified by this line number. lineNum, boolean if false, this method does not insert the bytecode. It instead only returns the line number at which the bytecode would be inserted. modify, String the source code representing the inserted bytecode. It must be a single statement or block. If modify is false, the value of src can be null. src) Inserts bytecode at the specified line in the body.
public void	insertBefore(String the source code representing the inserted bytecode. It must be a single statement or block. src) Inserts bytecode at the beginning of the body.
private void	insertBefore(String src, boolean rebuild)
private void	insertGoto(CodeIterator iterator, int subr, int pos)
public void	insertParameter(CtClass type) Inserts a new parameter, which becomes the first parameter.
public void	instrument(CodeConverter specifies how to modify. converter) Modifies the method/constructor body.
public void	instrument(ExprEditor specifies how to modify. editor) Modifies the method/constructor body.
public abstract boolean	isEmpty() Returns true if the body is empty.
public void	setAttribute(String attribute name name, byte[] attribute value data) Implements abstract javassist.CtMember.setAttribute. Adds an attribute.
public void	setBody(String the source code representing the body. It must be a single statement or block. If it is `null`, the substituted body does nothing except returning zero or null. src) Sets a method/constructor body.
public void	setBody(String the source code representing the body. It must be a single statement or block. If it is `null`, the substituted body does nothing except returning zero or null. src, String the source text specifying the object that is called on by `$proceed()`. delegateObj, String the name of the method that is called by `$proceed()`. delegateMethod) Sets a method/constructor body.
pack-priv static void	setBody0(CtClass srcClass, MethodInfo srcInfo, CtClass destClass, MethodInfo destInfo, ClassMap map)
public void	setExceptionTypes(CtClass[] types) Sets exceptions that this method/constructor may throw.
public void	setGenericSignature(String a new generic signature. sig) Implements abstract javassist.CtMember.setGenericSignature. Set the generic signature of the method.
public void	setModifiers(int mod) Implements abstract javassist.CtMember.setModifiers. Sets the encoded modifiers of the method/constructor.
public void	useCflow(String `$cflow` name. It can include alphabets, numbers, `_`, `$`, and `.` (dot). name) Declares to use `$cflow` for this method/constructor.

Inherited from javassist.CtMember:: getDeclaringClass getName hasAnnotation nameReplaced next toString visibleFrom

methodInfo	back to summary
protected MethodInfo methodInfo

CtBehavior	back to summary
protected CtBehavior(CtClass clazz, MethodInfo minfo)

Method Detail

addCatch	back to summary
public void addCatch(String src, CtClass exceptionType) throws CannotCompileException Adds a catch clause that handles an exception thrown in the body. The catch clause must end with a return or throw statement. Parameters src:String the source code representing the catch clause. It must be a single statement or block. exceptionType:CtClass the type of the exception handled by the catch clause.

addCatch

back to summary

public void addCatch(String src, CtClass exceptionType) throws CannotCompileException

Adds a catch clause that handles an exception thrown in the body. The catch clause must end with a return or throw statement.

Parameters

src:String: the source code representing the catch clause. It must be a single statement or block.
exceptionType:CtClass: the type of the exception handled by the catch clause.

addCatch back to summary

addCatch	back to summary
public void addCatch(String src, CtClass exceptionType, String exceptionName) throws CannotCompileException Adds a catch clause that handles an exception thrown in the body. The catch clause must end with a return or throw statement. Parameters src:String the source code representing the catch clause. It must be a single statement or block. exceptionType:CtClass the type of the exception handled by the catch clause. exceptionName:String the name of the variable containing the caught exception, for example, `$e`.

public void addCatch(String src, CtClass exceptionType, String exceptionName) throws CannotCompileException

Adds a catch clause that handles an exception thrown in the body. The catch clause must end with a return or throw statement.

Parameters

src:String: the source code representing the catch clause. It must be a single statement or block.
exceptionType:CtClass: the type of the exception handled by the catch clause.
exceptionName:String: the name of the variable containing the caught exception, for example, $e.

addLocalVariable back to summary

addLocalVariable	back to summary
public void addLocalVariable(String name, CtClass type) throws CannotCompileException Declares a new local variable. The scope of this variable is the whole method body. The initial value of that variable is not set. The declared variable can be accessed in the code snippet inserted by `insertBefore()`, `insertAfter()`, etc. If the second parameter `asFinally` to `insertAfter()` is true, the declared local variable is not visible from the code inserted by `insertAfter()`. Parameters name:String the name of the variable type:CtClass the type of the variable See Also `insertBefore(String)`, `insertAfter(String)`

public void addLocalVariable(String name, CtClass type) throws CannotCompileException

Declares a new local variable. The scope of this variable is the whole method body. The initial value of that variable is not set. The declared variable can be accessed in the code snippet inserted by insertBefore(), insertAfter(), etc.

If the second parameter asFinally to insertAfter() is true, the declared local variable is not visible from the code inserted by insertAfter().

Parameters

name:String: the name of the variable
type:CtClass: the type of the variable

addParameter	back to summary
public void addParameter(CtClass type) throws CannotCompileException Appends a new parameter, which becomes the last parameter.

addParameter2	back to summary
private void addParameter2(int where, CtClass type, String desc) throws BadBytecode

copy	back to summary
pack-priv void copy(CtBehavior src, boolean isCons, ClassMap map) throws CannotCompileException Parameters isCons:boolean true if this is a constructor.

extendToString back to summary

extendToString	back to summary
protected void extendToString(StringBuilder buffer) Implements abstract javassist.CtMember.extendToString. Doc from javassist.CtMember.extendToString. Invoked by `toString()` to add to the buffer and provide the complete value. Subclasses should invoke this method, adding a space before each token. The modifiers for the member are provided first; subclasses should provide additional data such as return type, field or method name, etc. Annotations @Override

protected void extendToString(StringBuilder buffer)

Implements abstract javassist.CtMember.extendToString.

Doc from javassist.CtMember.extendToString.

Invoked by toString() to add to the buffer and provide the complete value. Subclasses should invoke this method, adding a space before each token. The modifiers for the member are provided first; subclasses should provide additional data such as return type, field or method name, etc.

Annotations

@Override

getAnnotation back to summary

getAnnotation	back to summary
public Object getAnnotation(Class<?> clz) throws ClassNotFoundException Implements abstract javassist.CtMember.getAnnotation. Returns the annotation if the class has the specified annotation class. For example, if an annotation `@Author` is associated with this method/constructor, an `Author` object is returned. The member values can be obtained by calling methods on the `Author` object. Parameters clz:Class<?> the annotation class. Returns:Object the annotation if found, otherwise `null`. Annotations @Override Since 3.11

public Object getAnnotation(Class<?> clz) throws ClassNotFoundException

Implements abstract javassist.CtMember.getAnnotation.

Returns the annotation if the class has the specified annotation class. For example, if an annotation @Author is associated with this method/constructor, an Author object is returned. The member values can be obtained by calling methods on the Author object.

Parameters

clz:Class<?>: the annotation class.

Returns:Object

the annotation if found, otherwise null.

Annotations

@Override

Since

3.11

getAnnotations back to summary

getAnnotations	back to summary
public Object[] getAnnotations() throws ClassNotFoundException Implements abstract javassist.CtMember.getAnnotations. Returns the annotations associated with this method or constructor. Returns:Object[] an array of annotation-type objects. Annotations @Override Since 3.1 See Also `getAvailableAnnotations()`

public Object[] getAnnotations() throws ClassNotFoundException

Implements abstract javassist.CtMember.getAnnotations.

Returns the annotations associated with this method or constructor.

Returns:Object[]

an array of annotation-type objects.

Annotations

@Override

Since

3.1

See Also

getAvailableAnnotations()

getAnnotations	back to summary
private Object[] getAnnotations(boolean ignoreNotFound) throws ClassNotFoundException

getAttribute back to summary

getAttribute	back to summary
public byte[] getAttribute(String name) Implements abstract javassist.CtMember.getAttribute. Obtains an attribute with the given name. If that attribute is not found in the class file, this method returns null. Note that an attribute is a data block specified by the class file format. It is not an annotation. See `javassist.bytecode.AttributeInfo`. Parameters name:String attribute name Annotations @Override

public byte[] getAttribute(String name)

Implements abstract javassist.CtMember.getAttribute.

Obtains an attribute with the given name. If that attribute is not found in the class file, this method returns null.

Note that an attribute is a data block specified by the class file format. It is not an annotation. See javassist.bytecode.AttributeInfo.

Parameters

name:String: attribute name

Annotations

@Override

getAvailableAnnotations back to summary

getAvailableAnnotations	back to summary
public Object[] getAvailableAnnotations() Implements abstract javassist.CtMember.getAvailableAnnotations. Returns the annotations associated with this method or constructor. If any annotations are not on the classpath, they are not included in the returned array. Returns:Object[] an array of annotation-type objects. Annotations @Override Since 3.3 See Also `getAnnotations()`

public Object[] getAvailableAnnotations()

Implements abstract javassist.CtMember.getAvailableAnnotations.

Returns the annotations associated with this method or constructor. If any annotations are not on the classpath, they are not included in the returned array.

Returns:Object[]

an array of annotation-type objects.

Annotations

@Override

Since

3.3

See Also

getAnnotations()

getAvailableParameterAnnotations back to summary

getAvailableParameterAnnotations	back to summary
public Object[][] getAvailableParameterAnnotations() Returns the parameter annotations associated with this method or constructor. If any annotations are not on the classpath, they are not included in the returned array. Returns:Object[][] an array of annotation-type objects. The length of the returned array is equal to the number of the formal parameters. If each parameter has no annotation, the elements of the returned array are empty arrays. Since 3.3 See Also `getParameterAnnotations()`, `getAvailableAnnotations()`

public Object[][] getAvailableParameterAnnotations()

Returns the parameter annotations associated with this method or constructor. If any annotations are not on the classpath, they are not included in the returned array.

Returns:Object[][]: an array of annotation-type objects. The length of the returned array is equal to the number of the formal parameters. If each parameter has no annotation, the elements of the returned array are empty arrays.
Since: 3.3
See Also: getParameterAnnotations(), getAvailableAnnotations()

getExceptionTypes	back to summary
public CtClass[] getExceptionTypes() throws NotFoundException Obtains exceptions that this method/constructor may throw. Returns:CtClass[] a zero-length array if there is no throws clause.

getExceptionTypes

back to summary

public CtClass[] getExceptionTypes() throws NotFoundException

Obtains exceptions that this method/constructor may throw.

Returns:CtClass[]: a zero-length array if there is no throws clause.

getGenericSignature back to summary

getGenericSignature	back to summary
public String getGenericSignature() Implements abstract javassist.CtMember.getGenericSignature. Returns the generic signature of the method. It represents parameter types including type variables. Annotations @Override Since 3.17 See Also `SignatureAttribute#toMethodSignature(String)`

public String getGenericSignature()

Implements abstract javassist.CtMember.getGenericSignature.

Returns the generic signature of the method. It represents parameter types including type variables.

Annotations

@Override

Since

3.17

getLongName back to summary

getLongName	back to summary
public abstract String getLongName() Returns the method or constructor name followed by parameter types such as `javassist.CtBehavior.stBody(String)`. Since 3.5

public abstract String getLongName()

Returns the method or constructor name followed by parameter types such as javassist.CtBehavior.stBody(String).

Since: 3.5

getMethodInfo back to summary

getMethodInfo	back to summary
public MethodInfo getMethodInfo() Returns the `MethodInfo` representing this method/constructor in the class file. If you modify the bytecode through the returned `MethodInfo` object, you might have to explicitly rebuild a stack map table. Javassist does not automatically rebuild it for avoiding unnecessary rebuilding. See Also `javassist.bytecode.MethodInfo#rebuildStackMap(ClassPool)`

public MethodInfo getMethodInfo()

Returns the MethodInfo representing this method/constructor in the class file.

If you modify the bytecode through the returned MethodInfo object, you might have to explicitly rebuild a stack map table. Javassist does not automatically rebuild it for avoiding unnecessary rebuilding.

See Also: javassist.bytecode.MethodInfo#rebuildStackMap(ClassPool)

getMethodInfo2 back to summary

getMethodInfo2	back to summary
public MethodInfo getMethodInfo2() Returns the `MethodInfo` representing the method/constructor in the class file (read only). Normal applications do not need calling this method. Use `getMethodInfo()`. The `MethodInfo` object obtained by this method is read only. Changes to this object might not be reflected on a class file generated by `toBytecode()`, `toClass()`, etc in `CtClass`. This method is available even if the `CtClass` containing this method is frozen. However, if the class is frozen, the `MethodInfo` might be also pruned. See Also `getMethodInfo()`, `CtClass#isFrozen()`, `CtClass#prune()`

public MethodInfo getMethodInfo2()

Returns the MethodInfo representing the method/constructor in the class file (read only). Normal applications do not need calling this method. Use getMethodInfo().

The MethodInfo object obtained by this method is read only. Changes to this object might not be reflected on a class file generated by toBytecode(), toClass(), etc in CtClass.

This method is available even if the CtClass containing this method is frozen. However, if the class is frozen, the MethodInfo might be also pruned.

See Also: getMethodInfo(), CtClass#isFrozen(), CtClass#prune()

getModifiers back to summary

getModifiers	back to summary
public int getModifiers() Implements abstract javassist.CtMember.getModifiers. Obtains the modifiers of the method/constructor. Returns:int modifiers encoded with `javassist.Modifier`. Annotations @Override See Also `Modifier`

public int getModifiers()

Implements abstract javassist.CtMember.getModifiers.

Obtains the modifiers of the method/constructor.

Returns:int

modifiers encoded with javassist.Modifier.

Annotations

@Override

See Also

Modifier

getParameterAnnotations back to summary

getParameterAnnotations	back to summary
public Object[][] getParameterAnnotations() throws ClassNotFoundException Returns the parameter annotations associated with this method or constructor. Returns:Object[][] an array of annotation-type objects. The length of the returned array is equal to the number of the formal parameters. If each parameter has no annotation, the elements of the returned array are empty arrays. Since 3.1 See Also `getAvailableParameterAnnotations()`, `getAnnotations()`

public Object[][] getParameterAnnotations() throws ClassNotFoundException

Returns the parameter annotations associated with this method or constructor.

Returns:Object[][]: an array of annotation-type objects. The length of the returned array is equal to the number of the formal parameters. If each parameter has no annotation, the elements of the returned array are empty arrays.
Since: 3.1
See Also: getAvailableParameterAnnotations(), getAnnotations()

getParameterAnnotations	back to summary
pack-priv Object[][] getParameterAnnotations(boolean ignoreNotFound) throws ClassNotFoundException

getParameterTypes	back to summary
public CtClass[] getParameterTypes() throws NotFoundException Obtains parameter types of this method/constructor.

getReturnType0	back to summary
pack-priv CtClass getReturnType0() throws NotFoundException Obtains the type of the returned value.

getSignature back to summary

getSignature	back to summary
public String getSignature() Implements abstract javassist.CtMember.getSignature. Returns the method signature (the parameter types and the return type). The method signature is represented by a character string called method descriptor, which is defined in the JVM specification. If two methods/constructors have the same parameter types and the return type, `getSignature()` returns the same string (the return type of constructors is `void`). Note that the returned string is not the type signature contained in the `SignatureAttirbute`. It is a descriptor. Annotations @Override See Also `javassist.bytecode.Descriptor`, `getGenericSignature()`

public String getSignature()

Implements abstract javassist.CtMember.getSignature.

Returns the method signature (the parameter types and the return type). The method signature is represented by a character string called method descriptor, which is defined in the JVM specification. If two methods/constructors have the same parameter types and the return type, getSignature() returns the same string (the return type of constructors is void).

Note that the returned string is not the type signature contained in the SignatureAttirbute. It is a descriptor.

Annotations

@Override

getStartPosOfBody	back to summary
pack-priv int getStartPosOfBody(CodeAttribute ca) throws CannotCompileException

hasAnnotation back to summary

hasAnnotation	back to summary
public boolean hasAnnotation(String typeName) Implements abstract javassist.CtMember.hasAnnotation. Returns true if the class has the specified annotation type. Parameters typeName:String the name of annotation type. Returns:boolean `true` if the annotation is found, otherwise `false`. Annotations @Override Since 3.21

public boolean hasAnnotation(String typeName)

Implements abstract javassist.CtMember.hasAnnotation.

Returns true if the class has the specified annotation type.

Parameters

typeName:String: the name of annotation type.

Returns:boolean

true if the annotation is found, otherwise false.

Annotations

@Override

Since

3.21

insertAfter	back to summary
public void insertAfter(String src) throws CannotCompileException Inserts bytecode at the end of the body. The bytecode is inserted just before every return instruction. It is not executed when an exception is thrown. Parameters src:String the source code representing the inserted bytecode. It must be a single statement or block.

insertAfter

back to summary

public void insertAfter(String src) throws CannotCompileException

Inserts bytecode at the end of the body. The bytecode is inserted just before every return instruction. It is not executed when an exception is thrown.

Parameters

src:String: the source code representing the inserted bytecode. It must be a single statement or block.

insertAfter	back to summary
public void insertAfter(String src, boolean asFinally) throws CannotCompileException Inserts bytecode at the end of the body. The bytecode is inserted just before every return instruction. Parameters src:String the source code representing the inserted bytecode. It must be a single statement or block. asFinally:boolean true if the inserted bytecode is executed not only when the control normally returns but also when an exception is thrown. If this parameter is true, the inserted code cannot access local variables.

insertAfter

back to summary

public void insertAfter(String src, boolean asFinally) throws CannotCompileException

Inserts bytecode at the end of the body. The bytecode is inserted just before every return instruction.

Parameters

src:String: the source code representing the inserted bytecode. It must be a single statement or block.
asFinally:boolean: true if the inserted bytecode is executed not only when the control normally returns but also when an exception is thrown. If this parameter is true, the inserted code cannot access local variables.

insertAfter back to summary

insertAfter	back to summary
public void insertAfter(String src, boolean asFinally, boolean redundant) throws CannotCompileException Inserts bytecode at the end of the body. The bytecode is inserted just before every return instruction. Parameters src:String the source code representing the inserted bytecode. It must be a single statement or block. asFinally:boolean true if the inserted bytecode is executed not only when the control normally returns but also when an exception is thrown. If this parameter is true, the inserted code cannot access local variables. redundant:boolean if true, redundant bytecode will be generated. the redundancy is necessary when some compilers (Kotlin?) generate the original bytecode. The other `insertAfter` methods calls this method with `false` for this parameter. A tip is to pass `this.getDeclaringClass().isKotlin()` to this parameter. Since 3.26 See Also `CtClass#isKotlin()`, `getDeclaringClass()`

public void insertAfter(String src, boolean asFinally, boolean redundant) throws CannotCompileException

Inserts bytecode at the end of the body. The bytecode is inserted just before every return instruction.

Parameters

src:String: the source code representing the inserted bytecode. It must be a single statement or block.
asFinally:boolean: true if the inserted bytecode is executed not only when the control normally returns but also when an exception is thrown. If this parameter is true, the inserted code cannot access local variables.
redundant:boolean: if true, redundant bytecode will be generated. the redundancy is necessary when some compilers (Kotlin?) generate the original bytecode. The other insertAfter methods calls this method with false for this parameter. A tip is to pass this.getDeclaringClass().isKotlin() to this parameter.

Since

3.26

insertAfterAdvice	back to summary
private int insertAfterAdvice(Bytecode code, Javac jv, String src, ConstPool cp, CtClass rtype, int varNo) throws CompileError

insertAfterHandler	back to summary
private int insertAfterHandler(boolean asFinally, Bytecode b, CtClass rtype, int returnVarNo, Javac javac, String src) throws CompileError

insertAt back to summary

insertAt	back to summary
public int insertAt(int lineNum, String src) throws CannotCompileException Inserts bytecode at the specified line in the body. It is equivalent to: `insertAt(lineNum, true, src)` See this method as well. Parameters lineNum:int the line number. The bytecode is inserted at the beginning of the code at the line specified by this line number. src:String the source code representing the inserted bytecode. It must be a single statement or block. Returns:int the line number at which the bytecode has been inserted. See Also `CtBehavior#insertAt(int, boolean, String)`

public int insertAt(int lineNum, String src) throws CannotCompileException

Inserts bytecode at the specified line in the body. It is equivalent to:
insertAt(lineNum, true, src)
See this method as well.

Parameters

lineNum:int: the line number. The bytecode is inserted at the beginning of the code at the line specified by this line number.
src:String: the source code representing the inserted bytecode. It must be a single statement or block.

Returns:int

the line number at which the bytecode has been inserted.

insertAt back to summary

insertAt	back to summary
public int insertAt(int lineNum, boolean modify, String src) throws CannotCompileException Inserts bytecode at the specified line in the body. If there is not a statement at the specified line, the bytecode might be inserted at the line including the first statement after that line specified. For example, if there is only a closing brace at that line, the bytecode would be inserted at another line below. To know exactly where the bytecode will be inserted, call with `modify` set to `false`. Parameters lineNum:int the line number. The bytecode is inserted at the beginning of the code at the line specified by this line number. modify:boolean if false, this method does not insert the bytecode. It instead only returns the line number at which the bytecode would be inserted. src:String the source code representing the inserted bytecode. It must be a single statement or block. If modify is false, the value of src can be null. Returns:int the line number at which the bytecode has been inserted.

public int insertAt(int lineNum, boolean modify, String src) throws CannotCompileException

Inserts bytecode at the specified line in the body.

If there is not a statement at the specified line, the bytecode might be inserted at the line including the first statement after that line specified. For example, if there is only a closing brace at that line, the bytecode would be inserted at another line below. To know exactly where the bytecode will be inserted, call with modify set to false.

Parameters

lineNum:int: the line number. The bytecode is inserted at the beginning of the code at the line specified by this line number.
modify:boolean: if false, this method does not insert the bytecode. It instead only returns the line number at which the bytecode would be inserted.
src:String: the source code representing the inserted bytecode. It must be a single statement or block. If modify is false, the value of src can be null.

Returns:int

the line number at which the bytecode has been inserted.

insertBefore back to summary

insertBefore	back to summary
public void insertBefore(String src) throws CannotCompileException Inserts bytecode at the beginning of the body. If this object represents a constructor, the bytecode is inserted before a constructor in the super class or this class is called. Therefore, the inserted bytecode is subject to constraints described in Section 4.8.2 of The Java Virtual Machine Specification (2nd ed). For example, it cannot access instance fields or methods although it may assign a value to an instance field directly declared in this class. Accessing static fields and methods is allowed. Use `insertBeforeBody()` in `CtConstructor`. Parameters src:String the source code representing the inserted bytecode. It must be a single statement or block. See Also `CtConstructor#insertBeforeBody(String)`

public void insertBefore(String src) throws CannotCompileException

Inserts bytecode at the beginning of the body.

If this object represents a constructor, the bytecode is inserted before a constructor in the super class or this class is called. Therefore, the inserted bytecode is subject to constraints described in Section 4.8.2 of The Java Virtual Machine Specification (2nd ed). For example, it cannot access instance fields or methods although it may assign a value to an instance field directly declared in this class. Accessing static fields and methods is allowed. Use insertBeforeBody() in CtConstructor.

Parameters

src:String: the source code representing the inserted bytecode. It must be a single statement or block.

insertBefore	back to summary
private void insertBefore(String src, boolean rebuild) throws CannotCompileException

insertGoto	back to summary
private void insertGoto(CodeIterator iterator, int subr, int pos) throws BadBytecode

insertParameter	back to summary
public void insertParameter(CtClass type) throws CannotCompileException Inserts a new parameter, which becomes the first parameter.

instrument	back to summary
public void instrument(CodeConverter converter) throws CannotCompileException Modifies the method/constructor body. Parameters converter:CodeConverter specifies how to modify.

instrument

back to summary

public void instrument(CodeConverter converter) throws CannotCompileException

Modifies the method/constructor body.

Parameters

converter:CodeConverter: specifies how to modify.

instrument back to summary

instrument	back to summary
public void instrument(ExprEditor editor) throws CannotCompileException Modifies the method/constructor body. While executing this method, only `replace()` in `Expr` is available for bytecode modification. Other methods such as `insertBefore()` may collapse the bytecode because the `ExprEditor` loses its current position. Parameters editor:ExprEditor specifies how to modify. See Also `javassist.expr.Expr#replace(String)`, `insertBefore(String)`

public void instrument(ExprEditor editor) throws CannotCompileException

Modifies the method/constructor body.

While executing this method, only replace() in Expr is available for bytecode modification. Other methods such as insertBefore() may collapse the bytecode because the ExprEditor loses its current position.

Parameters

editor:ExprEditor: specifies how to modify.

isEmpty	back to summary
public abstract boolean isEmpty() Returns true if the body is empty.

setAttribute back to summary

setAttribute	back to summary
public void setAttribute(String name, byte[] data) Implements abstract javassist.CtMember.setAttribute. Adds an attribute. The attribute is saved in the class file. Note that an attribute is a data block specified by the class file format. It is not an annotation. See `javassist.bytecode.AttributeInfo`. Parameters name:String attribute name data:byte[] attribute value Annotations @Override

public void setAttribute(String name, byte[] data)

Implements abstract javassist.CtMember.setAttribute.

Adds an attribute. The attribute is saved in the class file.

Note that an attribute is a data block specified by the class file format. It is not an annotation. See javassist.bytecode.AttributeInfo.

Parameters

name:String: attribute name
data:byte[]: attribute value

Annotations

@Override

setBody back to summary

setBody	back to summary
public void setBody(String src) throws CannotCompileException Sets a method/constructor body. Parameters src:String the source code representing the body. It must be a single statement or block. If it is `null`, the substituted body does nothing except returning zero or null.

public void setBody(String src) throws CannotCompileException

Sets a method/constructor body.

Parameters

src:String: the source code representing the body. It must be a single statement or block. If it is null, the substituted body does nothing except returning zero or null.

setBody back to summary

setBody	back to summary
public void setBody(String src, String delegateObj, String delegateMethod) throws CannotCompileException Sets a method/constructor body. Parameters src:String the source code representing the body. It must be a single statement or block. If it is `null`, the substituted body does nothing except returning zero or null. delegateObj:String the source text specifying the object that is called on by `$proceed()`. delegateMethod:String the name of the method that is called by `$proceed()`.

public void setBody(String src, String delegateObj, String delegateMethod) throws CannotCompileException

Sets a method/constructor body.

Parameters

src:String: the source code representing the body. It must be a single statement or block. If it is null, the substituted body does nothing except returning zero or null.
delegateObj:String: the source text specifying the object that is called on by $proceed().
delegateMethod:String: the name of the method that is called by $proceed().

setBody0	back to summary
pack-priv static void setBody0(CtClass srcClass, MethodInfo srcInfo, CtClass destClass, MethodInfo destInfo, ClassMap map) throws CannotCompileException

setExceptionTypes	back to summary
public void setExceptionTypes(CtClass[] types) throws NotFoundException Sets exceptions that this method/constructor may throw.

setGenericSignature back to summary

public void setGenericSignature(String sig)

Implements abstract javassist.CtMember.setGenericSignature.

Set the generic signature of the method. It represents parameter types including type variables. See javassist.CtClass#setGenericSignature(String) for a code sample.

Parameters

sig:String: a new generic signature.

Annotations

@Override

Since

3.17

setModifiers back to summary

public void setModifiers(int mod)

Implements abstract javassist.CtMember.setModifiers.

Sets the encoded modifiers of the method/constructor.

Changing the modifiers may cause a problem. For example, if a non-static method is changed to static, the method will be rejected by the bytecode verifier.

Annotations

@Override

See Also

Modifier

useCflow back to summary

public void useCflow(String name) throws CannotCompileException

Declares to use $cflow for this method/constructor. If $cflow is used, the class files modified with Javassist requires a support class javassist.runtime.Cflow at runtime (other Javassist classes are not required at runtime).

Every $cflow variable is given a unique name. For example, if the given name is "Point.paint", then the variable is indicated by $cflow(Point.paint).

Parameters

name:String: $cflow name. It can include alphabets, numbers, _, $, and . (dot).

See Also

javassist.runtime.Cflow

public abstract Class CtBehavior

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail