Package org.apache.bcel

Class Repository

java.lang.Object

org.apache.bcel.Repository

public abstract class Repository
extends java.lang.Object

The repository maintains informations about class interdependencies, e.g., whether a class is a sub-class of another. Delegates actual class loading to SyntheticRepository with current class path by default.

See Also:

Repository, SyntheticRepository

Constructor Summary

Constructors

Constructor	Description
Repository()

Method Summary

Modifier and Type	Method	Description
static JavaClass	addClass(JavaClass clazz)	Adds clazz to repository if there isn't an equally named class already in there.
static void	clearCache()	Clears the repository.
static JavaClass[]	getInterfaces(java.lang.String class_name)
static JavaClass[]	getInterfaces(JavaClass clazz)
static Repository	getRepository()
static JavaClass[]	getSuperClasses(java.lang.String class_name)
static JavaClass[]	getSuperClasses(JavaClass clazz)
static boolean	implementationOf(java.lang.String clazz, java.lang.String inter)
static boolean	implementationOf(java.lang.String clazz, JavaClass inter)
static boolean	implementationOf(JavaClass clazz, java.lang.String inter)
static boolean	implementationOf(JavaClass clazz, JavaClass inter)
static boolean	instanceOf(java.lang.String clazz, java.lang.String super_class)
static boolean	instanceOf(java.lang.String clazz, JavaClass super_class)
static boolean	instanceOf(JavaClass clazz, java.lang.String super_class)
static boolean	instanceOf(JavaClass clazz, JavaClass super_class)	Equivalent to runtime "instanceof" operator.
static JavaClass	lookupClass(java.lang.Class<?> clazz)	Tries to find class source using the internal repository instance.
static JavaClass	lookupClass(java.lang.String class_name)	Lookups class somewhere found on your CLASSPATH, or whereever the repository instance looks for it.
static ClassPath.ClassFile	lookupClassFile(java.lang.String class_name)
static void	removeClass(java.lang.String clazz)	Removes class with given (fully qualified) name from repository.
static void	removeClass(JavaClass clazz)	Removes given class from repository.
static void	setRepository(Repository rep)	Sets repository instance to be used for class loading

Methods inherited from class java.lang.Object

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

Constructor Detail

Repository

public Repository()

Method Detail

getRepository

public static Repository getRepository()

Returns:

currently used repository instance

setRepository

public static void setRepository(Repository rep)

Sets repository instance to be used for class loading

lookupClass

public static JavaClass lookupClass(java.lang.String class_name)
                             throws java.lang.ClassNotFoundException

Lookups class somewhere found on your CLASSPATH, or whereever the repository instance looks for it.

Returns:

class object for given fully qualified class name

Throws:

java.lang.ClassNotFoundException - if the class could not be found or parsed correctly

lookupClass

public static JavaClass lookupClass(java.lang.Class<?> clazz)
                             throws java.lang.ClassNotFoundException

Tries to find class source using the internal repository instance.

Returns:

JavaClass object for given runtime class

Throws:

java.lang.ClassNotFoundException - if the class could not be found or parsed correctly

See Also:

Class

lookupClassFile

public static ClassPath.ClassFile lookupClassFile(java.lang.String class_name)

Returns:

class file object for given Java class by looking on the system class path; returns null if the class file can't be found

clearCache

public static void clearCache()

Clears the repository.

addClass

public static JavaClass addClass(JavaClass clazz)

Adds clazz to repository if there isn't an equally named class already in there.

Returns:

old entry in repository

removeClass

public static void removeClass(java.lang.String clazz)

Removes class with given (fully qualified) name from repository.

removeClass

public static void removeClass(JavaClass clazz)

Removes given class from repository.

getSuperClasses

public static JavaClass[] getSuperClasses(JavaClass clazz)
                                   throws java.lang.ClassNotFoundException

Returns:

list of super classes of clazz in ascending order, i.e., Object is always the last element

Throws:

java.lang.ClassNotFoundException - if any of the superclasses can't be found

getSuperClasses

public static JavaClass[] getSuperClasses(java.lang.String class_name)
                                   throws java.lang.ClassNotFoundException

Returns:

list of super classes of clazz in ascending order, i.e., Object is always the last element.

Throws:

java.lang.ClassNotFoundException - if the named class or any of its superclasses can't be found

getInterfaces

public static JavaClass[] getInterfaces(JavaClass clazz)
                                 throws java.lang.ClassNotFoundException

Returns:

all interfaces implemented by class and its super classes and the interfaces that those interfaces extend, and so on. (Some people call this a transitive hull).

Throws:

java.lang.ClassNotFoundException - if any of the class's superclasses or superinterfaces can't be found

getInterfaces

public static JavaClass[] getInterfaces(java.lang.String class_name)
                                 throws java.lang.ClassNotFoundException

Returns:

all interfaces implemented by class and its super classes and the interfaces that extend those interfaces, and so on

Throws:

java.lang.ClassNotFoundException - if the named class can't be found, or if any of its superclasses or superinterfaces can't be found

instanceOf

public static boolean instanceOf(JavaClass clazz,
                                 JavaClass super_class)
                          throws java.lang.ClassNotFoundException

Equivalent to runtime "instanceof" operator.

Returns:

true, if clazz is an instance of super_class

Throws:

java.lang.ClassNotFoundException - if any superclasses or superinterfaces of clazz can't be found

instanceOf

public static boolean instanceOf(java.lang.String clazz,
                                 java.lang.String super_class)
                          throws java.lang.ClassNotFoundException

Returns:

true, if clazz is an instance of super_class

Throws:

java.lang.ClassNotFoundException - if either clazz or super_class can't be found

instanceOf

public static boolean instanceOf(JavaClass clazz,
                                 java.lang.String super_class)
                          throws java.lang.ClassNotFoundException

Returns:

true, if clazz is an instance of super_class

Throws:

java.lang.ClassNotFoundException - if super_class can't be found

instanceOf

public static boolean instanceOf(java.lang.String clazz,
                                 JavaClass super_class)
                          throws java.lang.ClassNotFoundException

Returns:

true, if clazz is an instance of super_class

Throws:

java.lang.ClassNotFoundException - if clazz can't be found

implementationOf

public static boolean implementationOf(JavaClass clazz,
                                       JavaClass inter)
                                throws java.lang.ClassNotFoundException

Returns:

true, if clazz is an implementation of interface inter

Throws:

java.lang.ClassNotFoundException - if any superclasses or superinterfaces of clazz can't be found

implementationOf

public static boolean implementationOf(java.lang.String clazz,
                                       java.lang.String inter)
                                throws java.lang.ClassNotFoundException

Returns:

true, if clazz is an implementation of interface inter

Throws:

java.lang.ClassNotFoundException - if clazz, inter, or any superclasses or superinterfaces of clazz can't be found

implementationOf

public static boolean implementationOf(JavaClass clazz,
                                       java.lang.String inter)
                                throws java.lang.ClassNotFoundException

Returns:

true, if clazz is an implementation of interface inter

Throws:

java.lang.ClassNotFoundException - if inter or any superclasses or superinterfaces of clazz can't be found

implementationOf

public static boolean implementationOf(java.lang.String clazz,
                                       JavaClass inter)
                                throws java.lang.ClassNotFoundException

Returns:

true, if clazz is an implementation of interface inter

Throws:

java.lang.ClassNotFoundException - if clazz or any superclasses or superinterfaces of clazz can't be found