    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *      http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 *  Unless required by applicable law or agreed to in writing, software
    012 *  distributed under the License is distributed on an "AS IS" BASIS,
    013 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 *  See the License for the specific language governing permissions and
    015 *  limitations under the License.
    016 *
    017 */
    018package org.apache.bcel.util;
    019
    020import org.apache.bcel.classfile.JavaClass;
    021
    022/**
    023 * Abstract definition of a class repository. Instances may be used to load classes from different sources and may be
    024 * used in the Repository.setRepository method.
    025 *
    026 * @see org.apache.bcel.Repository
    027 */
    028public interface Repository {
    029
    030    /**
    031     * Clears all entries from cache.
    032     */
    033    void clear();
    034
    035    /**
    036     * Finds the class with the name provided, if the class isn't there, return NULL.
    037     */
    038    JavaClass findClass(String className);
    039
    040    /**
    041     * Gets the ClassPath associated with this Repository
    042     */
    043    ClassPath getClassPath();
    044
    045    /**
    046     * Finds the JavaClass instance for the given run-time class object
    047     */
    048    JavaClass loadClass(Class<?> clazz) throws ClassNotFoundException;
    049
    050    /**
    051     * Finds the class with the name provided, if the class isn't there, make an attempt to load it.
    052     */
    053    JavaClass loadClass(String className) throws ClassNotFoundException;
    054
    055    /**
    056     * Removes class from repository
    057     */
    058    void removeClass(JavaClass clazz);
    059
    060    /**
    061     * Stores the provided class under "clazz.getClassName()"
    062     */
    063    void storeClass(JavaClass clazz);
    064}