View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  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,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.shared.dependency.analyzer;
20  
21  import org.apache.maven.project.MavenProject;
22  
23  /**
24   * Analyze a project's declared dependencies and effective classes used to find which artifacts are:
25   * <ul>
26   * <li>used and declared,</li>
27   * <li>used but not declared,</li>
28   * <li>not used but declared.</li>
29   * <li>used but declared in too broad a scope</li>
30   * </ul>
31   *
32   * @author <a href="mailto:markhobson@gmail.com">Mark Hobson</a>
33   */
34  public interface ProjectDependencyAnalyzer {
35      /**
36       * <p>analyze.</p>
37       *
38       * @param project a {@link org.apache.maven.project.MavenProject} object
39       * @return a {@link org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalysis} object
40       * @throws org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalyzerException if any
41       */
42      ProjectDependencyAnalysis analyze(MavenProject project) throws ProjectDependencyAnalyzerException;
43  }