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.artifact.handler;
20  
21  /**
22   * An artifact handler contains information explaining how an artifact plugs into the Maven build:<ul>
23   * <li>Information needed to find the artifact file in a repository including extension and classifier</li>
24   * <li>Information on how to use the artifact as a dependency: whether to add it to the classpath, whether to load its
25   * dependencies transitively</li>
26   * </ul>
27   *
28   */
29  public interface ArtifactHandler {
30      @Deprecated
31      String ROLE = ArtifactHandler.class.getName();
32  
33      /**
34       * Returns the file name extension of the artifact;
35       * e.g. "jar", "pom", "xml", etc.
36       *
37       * @return the file extension
38       */
39      String getExtension();
40  
41      String getDirectory();
42  
43      /**
44       * Returns the default classifier used if a different one is not set in pom.xml.
45       *
46       * @return the classifier
47       */
48      String getClassifier();
49  
50      String getPackaging();
51  
52      boolean isIncludesDependencies();
53  
54      String getLanguage();
55  
56      boolean isAddedToClasspath();
57  }