/
ArtifactHandler.java
68 lines (60 loc) · 2.29 KB
/
ArtifactHandler.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.maven.artifact.handler;
/**
* An artifact handler contains information explaining how an artifact plugs into the Maven build:<ul>
* <li>Information needed to find the artifact file in a repository including extension and classifier</li>
* <li>Information on how to use the artifact as a dependency: whether to add it to the classpath, whether to load its
* dependencies transitively</li>
* </ul>
*
*/
public interface ArtifactHandler {
@Deprecated
String ROLE = ArtifactHandler.class.getName();
/**
* Returns the file name extension of the artifact;
* e.g. "jar", "pom", "xml", etc.
*
* @return the file extension
*/
String getExtension();
String getDirectory();
/**
* Returns the default classifier used if a different one is not set in pom.xml.
*
* @return the classifier
*/
String getClassifier();
String getPackaging();
boolean isIncludesDependencies();
String getLanguage();
/**
* Specifies if the artifact contains java classes and can be added to the classpath.
* Whether the artifact <em>should</em> be added to the classpath depends on other
* dependency properties.
*
* @return if the artifact <em>can</em> be added to the class path
*
* @deprecated A value of {@code true} does not mean that the dependency <em>should</em>
* be placed on the classpath. See {@code JavaPathType} instead for better analysis.
*/
@Deprecated
boolean isAddedToClasspath();
}