Class StubGenerator

java.lang.Object

javassist.tools.rmi.StubGenerator

All Implemented Interfaces:

Translator

public class StubGenerator
extends Object
implements Translator

A stub-code generator. It is used for producing a proxy class.

The proxy class for class A is as follows:

public class A implements Proxy, Serializable {
  private ObjectImporter importer;
  private int objectId;
  public int _getObjectId() { return objectId; }
  public A(ObjectImporter oi, int id) {
    importer = oi; objectId = id;
  }

  ... the same methods that the original class A declares ...
}

Instances of the proxy class is created by an ObjectImporter object.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	accessorObjectId
private ClassPool	classPool
private CtClass[]	exceptionForProxy
private static final String	fieldImporter
private static final String	fieldObjectId
private CtMethod	forwardMethod
private CtMethod	forwardStaticMethod
private CtClass[]	interfacesForProxy
private Map<String,CtClass>	proxyClasses
private CtClass[]	proxyConstructorParamTypes
private static final String	sampleClass

Constructor Summary

Constructors

Constructor	Description
StubGenerator()	Constructs a stub-code generator.

Method Summary

Modifier and Type	Method	Description
private void	addMethods(CtClass proxy, Method[] ms)
boolean	isProxyClass(String name)	Returns true if the specified class is a proxy class recorded by makeProxyClass().
boolean	makeProxyClass(Class<?> clazz)	Makes a proxy class.
private void	modifySuperclass(CtClass orgclass)	Adds a default constructor to the super classes.
void	onLoad(ClassPool pool, String classname)	Does nothing.
private CtClass	produceProxyClass(CtClass orgclass, Class<?> orgRtClass)
void	start(ClassPool pool)	Initializes the object.
private CtClass	toCtClass(Class<?> rtclass)
private CtClass[]	toCtClass(Class<?>[] rtclasses)

Methods inherited from class Object

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

Field Details

fieldImporter

private static final String fieldImporter

See Also:

• Constant Field Values

fieldObjectId

private static final String fieldObjectId

See Also:

• Constant Field Values

accessorObjectId

private static final String accessorObjectId

See Also:

• Constant Field Values

sampleClass

private static final String sampleClass

See Also:

• Constant Field Values

classPool

private ClassPool classPool

proxyClasses

private Map<String,CtClass> proxyClasses

forwardMethod

private CtMethod forwardMethod

forwardStaticMethod

private CtMethod forwardStaticMethod

proxyConstructorParamTypes

private CtClass[] proxyConstructorParamTypes

interfacesForProxy

private CtClass[] interfacesForProxy

exceptionForProxy

private CtClass[] exceptionForProxy

Constructor Details

StubGenerator

public StubGenerator()

Constructs a stub-code generator.

Method Details

start

public void start(ClassPool pool)
           throws NotFoundException

Initializes the object. This is a method declared in javassist.Translator.

Specified by:

start in interface Translator

Parameters:

pool - the ClassPool that this translator should use.

Throws:

NotFoundException - if a CtClass cannot be found.

See Also:

• Translator.start(ClassPool)

onLoad

public void onLoad(ClassPool pool,
 String classname)

Does nothing. This is a method declared in javassist.Translator.

Specified by:

onLoad in interface Translator

Parameters:

pool - the ClassPool that this translator should use.

classname - the name of the class being loaded.

See Also:

• Translator.onLoad(ClassPool,String)

isProxyClass

public boolean isProxyClass(String name)

Returns true if the specified class is a proxy class recorded by makeProxyClass().

Parameters:

name - a fully-qualified class name

makeProxyClass

public boolean makeProxyClass(Class<?> clazz)
                       throws CannotCompileException,
NotFoundException

Makes a proxy class. The produced class is substituted for the original class.

Parameters:

clazz - the class referenced through the proxy class.

Returns:

false if the proxy class has been already produced.

Throws:

CannotCompileException

NotFoundException

produceProxyClass

private CtClass produceProxyClass(CtClass orgclass,
 Class<?> orgRtClass)
                           throws CannotCompileException,
NotFoundException

Throws:

CannotCompileException

NotFoundException

toCtClass

private CtClass toCtClass(Class<?> rtclass)
                   throws NotFoundException

Throws:

NotFoundException

toCtClass

private CtClass[] toCtClass(Class<?>[] rtclasses)
                     throws NotFoundException

Throws:

NotFoundException

addMethods

private void addMethods(CtClass proxy,
 Method[] ms)
                 throws CannotCompileException,
NotFoundException

Throws:

CannotCompileException

NotFoundException

modifySuperclass

private void modifySuperclass(CtClass orgclass)
                       throws CannotCompileException,
NotFoundException

Adds a default constructor to the super classes.

Throws:

CannotCompileException

NotFoundException