-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
PublishArtifact.java
82 lines (72 loc) · 2.44 KB
/
PublishArtifact.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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/*
* Copyright 2007 the original author or authors.
*
* Licensed 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.gradle.api.artifacts;
import org.gradle.api.Buildable;
import org.gradle.internal.HasInternalProtocol;
import javax.annotation.Nullable;
import java.io.File;
import java.util.Date;
/**
* <p>A {@code PublishArtifact} is an artifact produced by a project.</p>
*/
@HasInternalProtocol
public interface PublishArtifact extends Buildable {
/**
* Returns the name of the artifact.
*
* @return The name. Never null.
*/
String getName();
/**
* Returns the extension of this published artifact. Often the extension is the same as the type,
* but sometimes this is not the case. For example for an ivy XML module descriptor, the type is
* <em>ivy</em> and the extension is <em>xml</em>.
*
* @return The extension. Never null.
*/
String getExtension();
/**
* Returns the type of the published artifact. Often the type is the same as the extension,
* but sometimes this is not the case. For example for an ivy XML module descriptor, the type is
* <em>ivy</em> and the extension is <em>xml</em>.
*
* @return The type. Never null.
*/
String getType();
/**
* Returns the classifier of this published artifact, if any.
*
* @return The classifier. May be null.
*/
@Nullable
String getClassifier();
/**
* Returns the file of this artifact.
*
* @return The file. Never null.
*/
File getFile();
/**
* Returns the date that should be used when publishing this artifact. This is used
* in the module descriptor accompanying this artifact (the ivy.xml). If the date is
* not specified, the current date is used. If this artifact
* is published without an module descriptor, this property has no relevance.
*
* @return The date. May be null.
*/
@Nullable
Date getDate();
}