Package org.apache.bcel.util

Class AbstractClassPathRepository

java.lang.Object

org.apache.bcel.util.AbstractClassPathRepository

All Implemented Interfaces:

Repository

Direct Known Subclasses:

ClassPathRepository, LruCacheClassPathRepository, MemorySensitiveClassPathRepository

abstract class AbstractClassPathRepository
extends Object
implements Repository

This abstract class provides a logic of a loading JavaClass objects class names via ClassPath.

Subclasses can choose caching strategy of the objects by implementing the abstract methods (e.g., storeClass(JavaClass) and findClass(String)).

Since:

6.4.0

Field Summary

Fields

Modifier and Type	Field	Description
private final ClassPath	classPath

Constructor Summary

Constructors

Constructor	Description
AbstractClassPathRepository(ClassPath classPath)

Method Summary

Modifier and Type	Method	Description
abstract void	clear()	Clears all entries from cache.
abstract JavaClass	findClass(String className)	Finds the class with the name provided, if the class isn't there, return NULL.
ClassPath	getClassPath()	Gets the ClassPath associated with this Repository
private JavaClass	loadClass(InputStream inputStream, String className)
JavaClass	loadClass(Class<?> clazz)	Finds the JavaClass object for a runtime Class object.
JavaClass	loadClass(String className)	Finds a JavaClass object by name.
abstract void	removeClass(JavaClass javaClass)	Removes class from repository
abstract void	storeClass(JavaClass javaClass)	Stores the provided class under "clazz.getClassName()"

Methods inherited from class java.lang.Object

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

Field Details

classPath

private final ClassPath classPath

Constructor Details

AbstractClassPathRepository

AbstractClassPathRepository(ClassPath classPath)

Method Details

clear

public abstract void clear()

Description copied from interface: Repository

Clears all entries from cache.

Specified by:

clear in interface Repository

findClass

public abstract JavaClass findClass(String className)

Description copied from interface: Repository

Finds the class with the name provided, if the class isn't there, return NULL.

Specified by:

findClass in interface Repository

getClassPath

public ClassPath getClassPath()

Description copied from interface: Repository

Gets the ClassPath associated with this Repository

Specified by:

getClassPath in interface Repository

loadClass

public JavaClass loadClass(Class<?> clazz)
                    throws ClassNotFoundException

Finds the JavaClass object for a runtime Class object. If a class with the same name is already in this Repository, the Repository version is returned. Otherwise, getResourceAsStream() is called on the Class object to find the class's representation. If the representation is found, it is added to the Repository.

Specified by:

loadClass in interface Repository

Parameters:

clazz - the runtime Class object

Returns:

JavaClass object for given runtime class

Throws:

ClassNotFoundException - if the class is not in the Repository, and its representation could not be found

See Also:

• Class

loadClass

private JavaClass loadClass(InputStream inputStream,
 String className)
                     throws ClassNotFoundException

Throws:

ClassNotFoundException

loadClass

public JavaClass loadClass(String className)
                    throws ClassNotFoundException

Finds a JavaClass object by name. If it is already in this Repository, the Repository version is returned. Otherwise, the Repository's classpath is searched for the class (and it is added to the Repository if found).

Specified by:

loadClass in interface Repository

Parameters:

className - the name of the class

Returns:

the JavaClass object

Throws:

ClassNotFoundException - if the class is not in the Repository, and could not be found on the classpath

removeClass

public abstract void removeClass(JavaClass javaClass)

Description copied from interface: Repository

Removes class from repository

Specified by:

removeClass in interface Repository

storeClass

public abstract void storeClass(JavaClass javaClass)

Description copied from interface: Repository

Stores the provided class under "clazz.getClassName()"

Specified by:

storeClass in interface Repository