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
024 * to load classes from different sources and may be used in the
025 * Repository.setRepository method.
026 *
027 * @see org.apache.bcel.Repository
028 * @version $Id: Repository.java 1836913 2018-07-28 14:43:13Z ggregory $
029 */
030public interface Repository {
031
032    /**
033     * Stores the provided class under "clazz.getClassName()"
034     */
035    void storeClass( JavaClass clazz );
036
037
038    /**
039     * Removes class from repository
040     */
041    void removeClass( JavaClass clazz );
042
043
044    /**
045     * Finds the class with the name provided, if the class
046     * isn't there, return NULL.
047     */
048    JavaClass findClass( String className );
049
050
051    /**
052     * Finds the class with the name provided, if the class
053     * isn't there, make an attempt to load it.
054     */
055    JavaClass loadClass( String className ) throws java.lang.ClassNotFoundException;
056
057
058    /**
059     * Finds the JavaClass instance for the given run-time class object
060     */
061    JavaClass loadClass( Class<?> clazz ) throws java.lang.ClassNotFoundException;
062
063
064    /** 
065     * Clears all entries from cache.
066     */
067    void clear();
068
069
070    /** 
071     * Gets the ClassPath associated with this Repository
072     */
073    ClassPath getClassPath();
074}