Modifier and Type	Class and Description
public static class	CtMethod.ConstParameter Instances of this class represent a constant parameter.
pack-priv static class	CtMethod.IntConstParameter
pack-priv static class	CtMethod.LongConstParameter
pack-priv static class	CtMethod.StringConstParameter

Modifier and Type	Field and Description
protected String	cachedStringRep

Access	Constructor and Description
pack-priv	CtMethod(MethodInfo minfo, CtClass declaring)
public	CtMethod(CtClass the type of the returned value returnType, String the method name mname, CtClass[] a list of the parameter types parameters, CtClass the class to which the created method is added. declaring) Creates a public abstract method.
public	CtMethod(CtMethod the source method. src, CtClass the class to which the created method is added. declaring, ClassMap the hashtable associating original class names with substituted names. It can be `null`. map) Creates a copy of a `CtMethod` object.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether `obj` has the same name and the same signature as this method.
public String	getLongName() Implements abstract javassist.CtBehavior.getLongName. Returns the method name followed by parameter types such as `javassist.CtMethod.setBody(String)`.
public String	getName() Implements abstract javassist.CtMember.getName. Obtains the name of this method.
public CtClass	getReturnType() Obtains the type of the returned value.
pack-priv final String	getStringRep()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the method.
public boolean	isEmpty() Implements abstract javassist.CtBehavior.isEmpty. Returns true if the method body is empty, that is, `{}`.
public static CtMethod	make(String the source text. src, CtClass the class to which the created method is added. declaring) Compiles the given source code and creates a method.
public static CtMethod	make(MethodInfo minfo, CtClass the class declaring the method. declaring) Creates a method from a `MethodInfo` object.
pack-priv void	nameReplaced() Overrides javassist.CtMember.nameReplaced. This method is invoked when setName() or replaceClassName() in CtClass is called.
public void	setBody(CtMethod the method that the body is copied from. src, ClassMap the hashtable associating original class names with substituted names. It can be `null`. map) Copies a method body from another method.
public void	setName(String newname) Changes the name of this method.
public void	setWrappedBody(CtMethod the wrapped method mbody, CtMethod.ConstParameter the constant parameter given to the wrapped method (maybe `null`). constParam) Replace a method body with a new method body wrapping the given method.

Field Detail

cachedStringRep	back to summary
protected String cachedStringRep

Constructor Detail

CtMethod	back to summary
pack-priv CtMethod(MethodInfo minfo, CtClass declaring) See Also `make(MethodInfo minfo, CtClass declaring)`

CtMethod back to summary

CtMethod	back to summary
public CtMethod(CtClass returnType, String mname, CtClass[] parameters, CtClass declaring) Creates a public abstract method. The created method must be added to a class with `CtClass.addMethod()`. Parameters returnType:CtClass the type of the returned value mname:String the method name parameters:CtClass[] a list of the parameter types declaring:CtClass the class to which the created method is added. See Also `CtClass#addMethod(CtMethod)`

public CtMethod(CtClass returnType, String mname, CtClass[] parameters, CtClass declaring)

Creates a public abstract method. The created method must be added to a class with CtClass.addMethod().

Parameters

returnType:CtClass: the type of the returned value
mname:String: the method name
parameters:CtClass[]: a list of the parameter types
declaring:CtClass: the class to which the created method is added.

See Also

CtClass#addMethod(CtMethod)

CtMethod back to summary

CtMethod	back to summary
public CtMethod(CtMethod src, CtClass declaring, ClassMap map) throws CannotCompileException Creates a copy of a `CtMethod` object. The created method must be added to a class with `CtClass.addMethod()`. All occurrences of class names in the created method are replaced with names specified by `map` if `map` is not `null`. For example, suppose that a method `at()` is as follows: public X at(int i) { return (X)super.elementAt(i); } (`X` is a class name.) If `map` substitutes `String` for `X`, then the created method is: public String at(int i) { return (String)super.elementAt(i); } By default, all the occurrences of the names of the class declaring `at()` and the superclass are replaced with the name of the class and the superclass that the created method is added to. This is done whichever `map` is null or not. To prevent this replacement, call `ClassMap.fix()` or `put()` to explicitly specify replacement. Note if the `.class` notation (for example, `String.class`) is included in an expression, the Javac compiler may produce a helper method. Since this constructor never copies this helper method, the programmers have the responsiblity of copying it. Otherwise, use `Class.forName()` in the expression. Parameters src:CtMethod the source method. declaring:CtClass the class to which the created method is added. map:ClassMap the hashtable associating original class names with substituted names. It can be `null`. See Also `CtClass#addMethod(CtMethod)`, `ClassMap#fix(String)`

public CtMethod(CtMethod src, CtClass declaring, ClassMap map) throws CannotCompileException

Creates a copy of a CtMethod object. The created method must be added to a class with CtClass.addMethod().

All occurrences of class names in the created method are replaced with names specified by map if map is not null.

For example, suppose that a method at() is as follows:

public X at(int i) {
    return (X)super.elementAt(i);
}

(X is a class name.) If map substitutes String for X, then the created method is:

public String at(int i) {
    return (String)super.elementAt(i);
}

By default, all the occurrences of the names of the class declaring at() and the superclass are replaced with the name of the class and the superclass that the created method is added to. This is done whichever map is null or not. To prevent this replacement, call ClassMap.fix() or put() to explicitly specify replacement.

Note

if the .class notation (for example, String.class) is included in an expression, the Javac compiler may produce a helper method. Since this constructor never copies this helper method, the programmers have the responsiblity of copying it. Otherwise, use Class.forName() in the expression.

Parameters

src:CtMethod: the source method.
declaring:CtClass: the class to which the created method is added.
map:ClassMap: the hashtable associating original class names with substituted names. It can be null.

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Indicates whether `obj` has the same name and the same signature as this method. Parameters obj:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Indicates whether obj has the same name and the same signature as this method.

Parameters

obj:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getLongName back to summary

getLongName	back to summary
public String getLongName() Implements abstract javassist.CtBehavior.getLongName. Returns the method name followed by parameter types such as `javassist.CtMethod.setBody(String)`. Annotations @Override Since 3.5

public String getLongName()

Implements abstract javassist.CtBehavior.getLongName.

Returns the method name followed by parameter types such as javassist.CtMethod.setBody(String).

Annotations

@Override

Since

3.5

getName	back to summary
public String getName() Implements abstract javassist.CtMember.getName. Obtains the name of this method. Annotations @Override

getName

back to summary

public String getName()

Implements abstract javassist.CtMember.getName.

Obtains the name of this method.

Annotations

@Override

getReturnType	back to summary
public CtClass getReturnType() throws NotFoundException Obtains the type of the returned value.

getStringRep	back to summary
pack-priv final String getStringRep()

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the method. If two methods have the same name and signature, then the hash codes for the two methods are equal. Returns:int Doc from java.lang.Object.hashCode. a hash code value for this object Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the method. If two methods have the same name and signature, then the hash codes for the two methods are equal.

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object

Annotations

@Override

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Implements abstract javassist.CtBehavior.isEmpty. Returns true if the method body is empty, that is, `{}`. It also returns true if the method is an abstract method. Annotations @Override

public boolean isEmpty()

Implements abstract javassist.CtBehavior.isEmpty.

Returns true if the method body is empty, that is, {}. It also returns true if the method is an abstract method.

Annotations

@Override

make back to summary

make	back to summary
public static CtMethod make(String src, CtClass declaring) throws CannotCompileException Compiles the given source code and creates a method. This method simply delegates to `make()` in `CtNewMethod`. See it for more details. `CtNewMethod` has a number of useful factory methods. Parameters src:String the source text. declaring:CtClass the class to which the created method is added. See Also `CtNewMethod#make(String, CtClass)`

public static CtMethod make(String src, CtClass declaring) throws CannotCompileException

Compiles the given source code and creates a method. This method simply delegates to make() in CtNewMethod. See it for more details. CtNewMethod has a number of useful factory methods.

Parameters

src:String: the source text.
declaring:CtClass: the class to which the created method is added.

See Also

CtNewMethod#make(String, CtClass)

make back to summary

make	back to summary
public static CtMethod make(MethodInfo minfo, CtClass declaring) throws CannotCompileException Creates a method from a `MethodInfo` object. Parameters declaring:CtClass the class declaring the method. Exceptions CannotCompileException: if the the `MethodInfo` object and the declaring class have different `ConstPool` objects Since 3.6

public static CtMethod make(MethodInfo minfo, CtClass declaring) throws CannotCompileException

Creates a method from a MethodInfo object.

Parameters

declaring:CtClass: the class declaring the method.

Exceptions

CannotCompileException:: if the the MethodInfo object and the declaring class have different ConstPool objects

Since

3.6

nameReplaced	back to summary
pack-priv void nameReplaced() Overrides javassist.CtMember.nameReplaced. This method is invoked when setName() or replaceClassName() in CtClass is called. Annotations @Override

nameReplaced

back to summary

pack-priv void nameReplaced()

Overrides javassist.CtMember.nameReplaced.

This method is invoked when setName() or replaceClassName() in CtClass is called.

Annotations

@Override

setBody back to summary

setBody	back to summary
public void setBody(CtMethod src, ClassMap map) throws CannotCompileException Copies a method body from another method. If this method is abstract, the abstract modifier is removed after the method body is copied. All occurrences of the class names in the copied method body are replaced with the names specified by `map` if `map` is not `null`. Parameters src:CtMethod the method that the body is copied from. map:ClassMap the hashtable associating original class names with substituted names. It can be `null`.

public void setBody(CtMethod src, ClassMap map) throws CannotCompileException

Copies a method body from another method. If this method is abstract, the abstract modifier is removed after the method body is copied.

All occurrences of the class names in the copied method body are replaced with the names specified by map if map is not null.

Parameters

src:CtMethod: the method that the body is copied from.
map:ClassMap: the hashtable associating original class names with substituted names. It can be null.

setName	back to summary
public void setName(String newname) Changes the name of this method.

setWrappedBody back to summary

setWrappedBody	back to summary
public void setWrappedBody(CtMethod mbody, CtMethod.ConstParameter constParam) throws CannotCompileException Replace a method body with a new method body wrapping the given method. Parameters mbody:CtMethod the wrapped method constParam:CtMethod.ConstParameter the constant parameter given to the wrapped method (maybe `null`). See Also `CtNewMethod#wrapped(CtClass, String, CtClass[], CtClass[], CtMethod, CtMethod.ConstParameter, CtClass)`

public void setWrappedBody(CtMethod mbody, CtMethod.ConstParameter constParam) throws CannotCompileException

Replace a method body with a new method body wrapping the given method.

Parameters

mbody:CtMethod: the wrapped method
constParam:CtMethod.ConstParameter: the constant parameter given to the wrapped method (maybe null).

javassist back to summary

public Class CtMethod.ConstParameter

Class Inheritance

extends Object

java.lang.Object
javassist.CtMethod.ConstParameter

Known Direct Subclasses

javassist.CtMethod.IntConstParameter, javassist.CtMethod.LongConstParameter, javassist.CtMethod.StringConstParameter

Instances of this class represent a constant parameter. They are used to specify the parameter given to the methods created by CtNewMethod.wrapped().

See Also: CtMethod#setWrappedBody(CtMethod, CtMethod.ConstParameter), CtNewMethod#wrapped(CtClass, String, CtClass[], CtClass[], CtMethod, CtMethod.ConstParameter, CtClass), CtNewConstructor#make(CtClass[], CtClass[], int, CtMethod, CtMethod.ConstParameter, CtClass)

Constructor Summary

Access	Constructor and Description
pack-priv	ConstParameter()

Method Summary

Modifier and Type	Method and Description
pack-priv int	Returns: the size of the stack consumption. compile(Bytecode code)
pack-priv String	constDescriptor() Returns the descriptor for constructors.
pack-priv static String	defaultConstDescriptor() Returns the default descriptor for constructors.
pack-priv static String	defaultDescriptor()
pack-priv String	descriptor()
public static CtMethod.ConstParameter	integer(int the constant value. i) Makes an integer constant.
public static CtMethod.ConstParameter	integer(long the constant value. i) Makes a long integer constant.
public static CtMethod.ConstParameter	string(String the constant value. s) Makes an `String` constant.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

ConstParameter	back to summary
pack-priv ConstParameter()

Method Detail

compile	back to summary
pack-priv int compile(Bytecode code) throws CannotCompileException Returns:int the size of the stack consumption.

constDescriptor back to summary

constDescriptor	back to summary
pack-priv String constDescriptor() Returns the descriptor for constructors. See Also `CtNewWrappedConstructor`

pack-priv String constDescriptor()

Returns the descriptor for constructors.

See Also: CtNewWrappedConstructor

defaultConstDescriptor	back to summary
pack-priv static String defaultConstDescriptor() Returns the default descriptor for constructors.

defaultDescriptor	back to summary
pack-priv static String defaultDescriptor() See Also `CtNewWrappedMethod`

descriptor	back to summary
pack-priv String descriptor()

integer	back to summary
public static CtMethod.ConstParameter integer(int i) Makes an integer constant. Parameters i:int the constant value.

integer

back to summary

public static CtMethod.ConstParameter integer(int i)

Makes an integer constant.

Parameters

i:int: the constant value.

integer	back to summary
public static CtMethod.ConstParameter integer(long i) Makes a long integer constant. Parameters i:long the constant value.

integer

back to summary

public static CtMethod.ConstParameter integer(long i)

Makes a long integer constant.

Parameters

i:long: the constant value.

string back to summary

string	back to summary
public static CtMethod.ConstParameter string(String s) Makes an `String` constant. Parameters s:String the constant value.

public static CtMethod.ConstParameter string(String s)

Makes an String constant.

Parameters

s:String: the constant value.

javassist back to summary

pack-priv Class CtMethod.IntConstParameter

Class Inheritance

extends ConstParameter

java.lang.Object
javassist.CtMethod.ConstParameter
javassist.CtMethod.IntConstParameter

Field Summary

Modifier and Type	Field and Description
pack-priv int	param

Constructor Summary

Access	Constructor and Description
pack-priv	IntConstParameter(int i)

Method Summary

Modifier and Type	Method and Description
pack-priv int	compile(Bytecode code) Overrides javassist.CtMethod.ConstParameter.compile.
pack-priv String	constDescriptor() Overrides javassist.CtMethod.ConstParameter.constDescriptor. Returns the descriptor for constructors.
pack-priv String	descriptor() Overrides javassist.CtMethod.ConstParameter.descriptor.

Inherited from javassist.CtMethod.ConstParameter:: defaultConstDescriptor defaultDescriptor integer integer string

Field Detail

param	back to summary
pack-priv int param

Constructor Detail

IntConstParameter	back to summary
pack-priv IntConstParameter(int i)

Method Detail

compile	back to summary
pack-priv int compile(Bytecode code) throws CannotCompileException Overrides javassist.CtMethod.ConstParameter.compile. Returns:int Doc from javassist.CtMethod.ConstParameter.compile. the size of the stack consumption. Annotations @Override

compile

back to summary

pack-priv int compile(Bytecode code) throws CannotCompileException

Overrides javassist.CtMethod.ConstParameter.compile.

Returns:int

Doc from javassist.CtMethod.ConstParameter.compile.

the size of the stack consumption.

Annotations

@Override

constDescriptor	back to summary
pack-priv String constDescriptor() Overrides javassist.CtMethod.ConstParameter.constDescriptor. Doc from javassist.CtMethod.ConstParameter.constDescriptor. Returns the descriptor for constructors. Annotations @Override

constDescriptor

back to summary

pack-priv String constDescriptor()

Overrides javassist.CtMethod.ConstParameter.constDescriptor.

Doc from javassist.CtMethod.ConstParameter.constDescriptor.

Returns the descriptor for constructors.

Annotations

@Override

descriptor	back to summary
pack-priv String descriptor() Overrides javassist.CtMethod.ConstParameter.descriptor. Annotations @Override

descriptor

back to summary

pack-priv String descriptor()

Overrides javassist.CtMethod.ConstParameter.descriptor.

Annotations

@Override

javassist back to summary

pack-priv Class CtMethod.LongConstParameter

Class Inheritance

extends ConstParameter

java.lang.Object
javassist.CtMethod.ConstParameter
javassist.CtMethod.LongConstParameter

Field Summary

Modifier and Type	Field and Description
pack-priv long	param

Constructor Summary

Access	Constructor and Description
pack-priv	LongConstParameter(long l)

Method Summary

Modifier and Type	Method and Description
pack-priv int	compile(Bytecode code) Overrides javassist.CtMethod.ConstParameter.compile.
pack-priv String	constDescriptor() Overrides javassist.CtMethod.ConstParameter.constDescriptor. Returns the descriptor for constructors.
pack-priv String	descriptor() Overrides javassist.CtMethod.ConstParameter.descriptor.

Inherited from javassist.CtMethod.ConstParameter:: defaultConstDescriptor defaultDescriptor integer integer string

Field Detail

param	back to summary
pack-priv long param

Constructor Detail

LongConstParameter	back to summary
pack-priv LongConstParameter(long l)

Method Detail

compile	back to summary
pack-priv int compile(Bytecode code) throws CannotCompileException Overrides javassist.CtMethod.ConstParameter.compile. Returns:int Doc from javassist.CtMethod.ConstParameter.compile. the size of the stack consumption. Annotations @Override

compile

back to summary

pack-priv int compile(Bytecode code) throws CannotCompileException

Overrides javassist.CtMethod.ConstParameter.compile.

Returns:int

Doc from javassist.CtMethod.ConstParameter.compile.

the size of the stack consumption.

Annotations

@Override

constDescriptor	back to summary
pack-priv String constDescriptor() Overrides javassist.CtMethod.ConstParameter.constDescriptor. Doc from javassist.CtMethod.ConstParameter.constDescriptor. Returns the descriptor for constructors. Annotations @Override

constDescriptor

back to summary

pack-priv String constDescriptor()

Overrides javassist.CtMethod.ConstParameter.constDescriptor.

Doc from javassist.CtMethod.ConstParameter.constDescriptor.

Returns the descriptor for constructors.

Annotations

@Override

descriptor	back to summary
pack-priv String descriptor() Overrides javassist.CtMethod.ConstParameter.descriptor. Annotations @Override

descriptor

back to summary

pack-priv String descriptor()

Overrides javassist.CtMethod.ConstParameter.descriptor.

Annotations

@Override

javassist back to summary

pack-priv Class CtMethod.StringConstParameter

Class Inheritance

extends ConstParameter

java.lang.Object
javassist.CtMethod.ConstParameter
javassist.CtMethod.StringConstParameter

Field Summary

Modifier and Type	Field and Description
pack-priv String	param

Constructor Summary

Access	Constructor and Description
pack-priv	StringConstParameter(String s)

Method Summary

Modifier and Type	Method and Description
pack-priv int	compile(Bytecode code) Overrides javassist.CtMethod.ConstParameter.compile.
pack-priv String	constDescriptor() Overrides javassist.CtMethod.ConstParameter.constDescriptor. Returns the descriptor for constructors.
pack-priv String	descriptor() Overrides javassist.CtMethod.ConstParameter.descriptor.

Inherited from javassist.CtMethod.ConstParameter:: defaultConstDescriptor defaultDescriptor integer integer string

Field Detail

param	back to summary
pack-priv String param

Constructor Detail

StringConstParameter	back to summary
pack-priv StringConstParameter(String s)

Method Detail

compile

back to summary

pack-priv int compile(Bytecode code) throws CannotCompileException

Overrides javassist.CtMethod.ConstParameter.compile.

Returns:int

Doc from javassist.CtMethod.ConstParameter.compile.

the size of the stack consumption.

Annotations

@Override

constDescriptor

back to summary

pack-priv String constDescriptor()

Overrides javassist.CtMethod.ConstParameter.constDescriptor.

Doc from javassist.CtMethod.ConstParameter.constDescriptor.

Returns the descriptor for constructors.

Annotations

@Override

descriptor

back to summary

pack-priv String descriptor()

Overrides javassist.CtMethod.ConstParameter.descriptor.

Annotations

@Override

public final Class CtMethod

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class CtMethod.ConstParameter

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv Class CtMethod.IntConstParameter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class CtMethod.LongConstParameter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class CtMethod.StringConstParameter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail