xapi.bytecode

Class CtBehavior

java.lang.Object

xapi.bytecode.CtMember

xapi.bytecode.CtBehavior

Direct Known Subclasses:

CtConstructor, CtMethod

public abstract class CtBehavior
extends CtMember

Field Summary

Fields

Modifier and Type	Field and Description
protected MethodInfo	methodInfo

Fields inherited from class xapi.bytecode.CtMember

declaringClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addLocalVariable(String name, CtClass type) Declares a new local variable.
void	addParameter(CtClass type) Appends a new parameter, which becomes the last parameter.
protected void	extendToString(StringBuffer buffer) Invoked by CtMember.toString() to add to the buffer and provide the complete value.
Object	getAnnotation(Class<?> clz) Returns the annotation if the class has the specified annotation class.
Object[]	getAnnotations() Returns the annotations associated with this method or constructor.
byte[]	getAttribute(String name) Obtains an attribute with the given name.
Object[]	getAvailableAnnotations() Returns the annotations associated with this method or constructor.
Object[][]	getAvailableParameterAnnotations() Returns the parameter annotations associated with this method or constructor.
CtClass[]	getExceptionTypes() Obtains exceptions that this method/constructor may throw.
abstract String	getLongName() Returns the method or constructor name followed by parameter types such as javassist.CtBehavior.stBody(String).
MethodInfo	getMethodInfo() Returns the MethodInfo representing this method/constructor in the class file.
MethodInfo	getMethodInfo2() Returns the MethodInfo representing the method/constructor in the class file (read only).
int	getModifiers() Obtains the modifiers of the method/constructor.
Object[][]	getParameterAnnotations() Returns the parameter annotations associated with this method or constructor.
CtClass[]	getParameterTypes() Obtains parameter types of this method/constructor.
String	getSignature() Returns the method signature (the parameter types and the return type).
boolean	hasAnnotation(Class<?> clz) Returns true if the class has the specified annotation class.
void	insertParameter(CtClass type) Inserts a new parameter, which becomes the first parameter.
abstract boolean	isEmpty() Returns true if the body is empty.
void	setAttribute(String name, byte[] data) Adds an attribute.
void	setExceptionTypes(CtClass[] types) Sets exceptions that this method/constructor may throw.
void	setModifiers(int mod) Sets the encoded modifiers of the method/constructor.

Methods inherited from class xapi.bytecode.CtMember

getDeclaringClass, getName, toString, visibleFrom

Methods inherited from class java.lang.Object

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

Field Detail

methodInfo

protected MethodInfo methodInfo

Constructor Detail

CtBehavior

protected CtBehavior(CtClass clazz,
                     MethodInfo minfo)

Method Detail

extendToString

protected void extendToString(StringBuffer buffer)

Description copied from class: CtMember

Invoked by CtMember.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.

Specified by:

extendToString in class CtMember

getLongName

public abstract String getLongName()

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

Since:

3.5

getMethodInfo

public MethodInfo getMethodInfo()

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

getMethodInfo2

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

public int getModifiers()

Obtains the modifiers of the method/constructor.

Specified by:

getModifiers in class CtMember

Returns:

modifiers encoded with javassist.Modifier.

See Also:

Modifier

setModifiers

public void setModifiers(int mod)

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.

Specified by:

setModifiers in class CtMember

See Also:

Modifier

hasAnnotation

public boolean hasAnnotation(Class<?> clz)

Returns true if the class has the specified annotation class.

Specified by:

hasAnnotation in class CtMember

Parameters:

clz - the annotation class.

Returns:

true if the annotation is found, otherwise false.

Since:

3.11

getAnnotation

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

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.

Specified by:

getAnnotation in class CtMember

Parameters:

clz - the annotation class.

Returns:

the annotation if found, otherwise null.

Throws:

ClassNotFoundException

Since:

3.11

getAnnotations

public Object[] getAnnotations()
                        throws ClassNotFoundException

Returns the annotations associated with this method or constructor.

Specified by:

getAnnotations in class CtMember

Returns:

an array of annotation-type objects.

Throws:

ClassNotFoundException

Since:

3.1

See Also:

getAvailableAnnotations()

getAvailableAnnotations

public Object[] 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.

Specified by:

getAvailableAnnotations in class CtMember

Returns:

an array of annotation-type objects.

Since:

3.3

See Also:

getAnnotations()

getParameterAnnotations

public Object[][] getParameterAnnotations()
                                   throws ClassNotFoundException

Returns the parameter annotations associated with this method or constructor.

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.

Throws:

ClassNotFoundException

Since:

3.1

See Also:

getAvailableParameterAnnotations(), getAnnotations()

getAvailableParameterAnnotations

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:

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()

getParameterTypes

public CtClass[] getParameterTypes()
                            throws NotFoundException

Obtains parameter types of this method/constructor.

Throws:

NotFoundException

getSignature

public String 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. To obtain a type signature, call the following methods:

getMethodInfo().getAttribute(SignatureAttribute.tag)
 

Specified by:

getSignature in class CtMember

See Also:

javassist.bytecode.Descriptor, javassist.bytecode.SignatureAttribute

getExceptionTypes

public CtClass[] getExceptionTypes()
                            throws NotFoundException

Obtains exceptions that this method/constructor may throw.

Returns:

a zero-length array if there is no throws clause.

Throws:

NotFoundException

setExceptionTypes

public void setExceptionTypes(CtClass[] types)
                       throws NotFoundException

Sets exceptions that this method/constructor may throw.

Throws:

NotFoundException

isEmpty

public abstract boolean isEmpty()

Returns true if the body is empty.

getAttribute

public byte[] getAttribute(String name)

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.

Specified by:

getAttribute in class CtMember

Parameters:

name - attribute name

setAttribute

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

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.

Specified by:

setAttribute in class CtMember

Parameters:

name - attribute name

data - attribute value

addLocalVariable

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 - the name of the variable

type - the type of the variable

Throws:

CannotCompileException

See Also:

#insertBefore(String), #insertAfter(String)

insertParameter

public void insertParameter(CtClass type)
                     throws CannotCompileException

Inserts a new parameter, which becomes the first parameter.

Throws:

CannotCompileException

addParameter

public void addParameter(CtClass type)
                  throws CannotCompileException

Appends a new parameter, which becomes the last parameter.

Throws:

CannotCompileException