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