View Javadoc

1   /*
2    * Copyright 2002-2004 The Apache Software Foundation
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.apache.commons.clazz;
17  
18  /***
19   * A clazz loader factory creates and configures clazz loaders.
20   * 
21   * @author <a href="mailto:dmitri@apache.org">Dmitri Plotnikov</a>
22   * @version $Id: ClazzLoaderFactory.java,v 1.5 2004/02/19 23:58:37 scolebourne Exp $
23   */
24  public interface ClazzLoaderFactory {
25  
26      /***
27       * Returns the name of the clazz model implemented by this factory.
28       * By convention, it should be a proper identifier, no dots, capitalized.
29       */
30      String getClazzModel();
31      
32      /***
33       * Allocate, configure and cache a clazz loader that uses the supplied class
34       * loader for reflection.
35       */
36      ClazzLoader getClazzLoader(ClassLoader contextClassLoader);
37       
38      /***
39       * The supplied class should be an implementation of the ClazzLoader
40       * interface.  When ClazzLoaderFactory creates a new clazz loader, it will
41       * instantiate all registered implementations and group them together.
42       */
43      void addClazzLoaderClass(Class clazzLoaderClass);
44  }