View Javadoc

1   /*
2    * Copyright (C) The MetaClass Group. All rights reserved.
3    *
4    * This software is published under the terms of the Spice
5    * Software License version 1.1, a copy of which has been included
6    * with this distribution in the LICENSE.txt file.
7    */
8   package org.codehaus.metaclass.tools.compiler;
9   
10  import com.thoughtworks.qdox.model.JavaClass;
11  
12  /***
13   * Interface used for filtering out JavaClass objects
14   * prior to attempting to generate metadata from them.
15   *
16   * @author Peter Donald
17   * @version $Revision: 1.2 $ $Date: 2003/11/27 08:09:53 $
18   */
19  public interface JavaClassFilter
20  {
21      /***
22       * This method provides an access point for subclasses to use custom filters
23       * on the list of classes parsed.
24       * i.e. to return null if the class has been filtered.
25       *
26       * @param javaClass the JavaClass
27       * @return javaClass or null
28       */
29      JavaClass filterClass( JavaClass javaClass );
30  }