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