View Javadoc
1   package org.apache.maven.artifact.handler;
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  /**
23   * An artifact handler defines for a dependency type, defined as Plexus role:<ul>
24   * <li>extension and classifier, to be able to download the file,</li>
25   * <li>information on how to use the artifact: whether to add it to the classpath, or to take into account its
26   * dependencies.</li>
27   * </ul>
28   * 
29   * @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
30   */
31  public interface ArtifactHandler
32  {
33      String ROLE = ArtifactHandler.class.getName();
34  
35      /**
36       * Get the file extension associated to the file represented by the dependency type.
37       *
38       * @return the file extension
39       */
40      String getExtension();
41  
42      String getDirectory();
43  
44      /**
45       * Get the classifier associated to the dependency type.
46       * 
47       * @return the classifier
48       */
49      String getClassifier();
50  
51      String getPackaging();
52  
53      boolean isIncludesDependencies();
54  
55      String getLanguage();
56  
57      boolean isAddedToClasspath();
58  }