javassist

Class CtConstructor

public final class CtConstructor extends CtBehavior

An instance of CtConstructor represents a constructor. It may represent a static constructor (class initializer). To distinguish a constructor and a class initializer, call isClassInitializer().

See the super class CtBehavior as well since a number of useful methods are in CtBehavior.

See Also: getDeclaredConstructors getClassInitializer CtNewConstructor

Constructor Summary
CtConstructor(CtClass[] parameters, CtClass declaring)
Creates a constructor with no constructor body.
CtConstructor(CtConstructor src, CtClass declaring, ClassMap map)
Creates a copy of a CtConstructor object.
Method Summary
booleancallsSuper()
Returns true if this constructor calls a constructor of the super class.
StringgetLongName()
Returns the constructor name followed by parameter types such as javassist.CtConstructor(CtClass[],CtClass).
StringgetName()
Obtains the name of this constructor.
voidinsertBeforeBody(String src)
Inserts bytecode just after another constructor in the super class or this class is called.
booleanisClassInitializer()
Returns true if this object represents a static initializer.
booleanisConstructor()
Returns true if this object represents a constructor.
booleanisEmpty()
Returns true if the constructor (or static initializer) is the default one.
voidsetBody(String src)
Sets a constructor body.
voidsetBody(CtConstructor src, ClassMap map)
Copies a constructor body from another constructor.
CtMethodtoMethod(String name, CtClass declaring)
Makes a copy of this constructor and converts it into a method.
CtMethodtoMethod(String name, CtClass declaring, ClassMap map)
Makes a copy of this constructor and converts it into a method.

Constructor Detail

CtConstructor

public CtConstructor(CtClass[] parameters, CtClass declaring)
Creates a constructor with no constructor body. The created constructor must be added to a class with CtClass.addConstructor().

The created constructor does not include a constructor body, must be specified with setBody().

Parameters: declaring the class to which the created method is added. parameters a list of the parameter types

See Also: addConstructor setBody setBody

CtConstructor

public CtConstructor(CtConstructor src, CtClass declaring, ClassMap map)
Creates a copy of a CtConstructor object. The created constructor must be added to a class with CtClass.addConstructor().

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

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

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 the source method. declaring the class to which the created method is added. map the hashtable associating original class names with substituted names. It can be null.

See Also: addConstructor fix

Method Detail

callsSuper

public boolean callsSuper()
Returns true if this constructor calls a constructor of the super class. This method returns false if it calls another constructor of this class by this().

getLongName

public String getLongName()
Returns the constructor name followed by parameter types such as javassist.CtConstructor(CtClass[],CtClass).

Since: 3.5

getName

public String getName()
Obtains the name of this constructor. It is the same as the simple name of the class declaring this constructor. If this object represents a class initializer, then this method returns "<clinit>".

insertBeforeBody

public void insertBeforeBody(String src)
Inserts bytecode just after another constructor in the super class or this class is called. It does not work if this object represents a class initializer.

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

isClassInitializer

public boolean isClassInitializer()
Returns true if this object represents a static initializer.

isConstructor

public boolean isConstructor()
Returns true if this object represents a constructor.

isEmpty

public boolean isEmpty()
Returns true if the constructor (or static initializer) is the default one. This method returns true if the constructor takes some arguments but it does not perform anything except calling super() (the no-argument constructor of the super class).

setBody

public void setBody(String src)
Sets a constructor body.

Parameters: src the source code representing the constructor body. It must be a single statement or block. If it is null, the substituted constructor body does nothing except calling super().

setBody

public void setBody(CtConstructor src, ClassMap map)
Copies a constructor body from another constructor.

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

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

toMethod

public CtMethod toMethod(String name, CtClass declaring)
Makes a copy of this constructor and converts it into a method. The signature of the mehtod is the same as the that of this constructor. The return type is void. The resulting method must be appended to the class specified by declaring. If this constructor is a static initializer, the resulting method takes no parameter.

An occurrence of another constructor call this() or a super constructor call super() is eliminated from the resulting method.

The immediate super class of the class declaring this constructor must be also a super class of the class declaring the resulting method. If the constructor accesses a field, the class declaring the resulting method must also declare a field with the same name and type.

Parameters: name the name of the resulting method. declaring the class declaring the resulting method.

toMethod

public CtMethod toMethod(String name, CtClass declaring, ClassMap map)
Makes a copy of this constructor and converts it into a method. The signature of the mehtod is the same as the that of this constructor. The return type is void. The resulting method must be appended to the class specified by declaring. If this constructor is a static initializer, the resulting method takes no parameter.

An occurrence of another constructor call this() or a super constructor call super() is eliminated from the resulting method.

The immediate super class of the class declaring this constructor must be also a super class of the class declaring the resulting method. If the constructor accesses a field, the class declaring the resulting method must also declare a field with the same name and type.

Parameters: name the name of the resulting method. declaring the class declaring the resulting method. map the hash table associating original class names with substituted names. The original class names will be replaced while making a copy. map can be null.

Javassist, a Java-bytecode translator toolkit.
Copyright (C) 1999-2006 Shigeru Chiba. All Rights Reserved.