View Javadoc
1   package org.codehaus.plexus.metadata.gleaner;
2   
3   /*
4    * Copyright (C) 2007 the original author or authors.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  import org.codehaus.plexus.component.repository.ComponentDescriptor;
20  
21  import com.thoughtworks.qdox.JavaProjectBuilder;
22  import com.thoughtworks.qdox.model.JavaClass;
23  
24  /**
25   * Interface for component gleaners which glean off of source code.
26   *
27   * @version $Id$
28   */
29  public interface SourceComponentGleaner
30  {
31      String ROLE = SourceComponentGleaner.class.getName();
32  
33      ComponentDescriptor<?> glean( JavaProjectBuilder classCache, JavaClass javaClass )
34          throws ComponentGleanerException;
35  }