blob: f1118f43958ac59a3b6c801663954007870e4a6f (
plain)
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
/*
* Copyright (C) 2013 The Android Open Source Project
*
* 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 com.android.builder.model;
import com.android.annotations.NonNull;
import java.io.File;
import java.util.Collection;
/**
* Entry point for the model of the Android Projects. This models a single module, whether
* the module is an app project or a library project.
*/
public interface AndroidProject {
String BUILD_MODEL_ONLY_SYSTEM_PROPERTY = "android.build.model.only";
public static final String ARTIFACT_MAIN = "_main_";
public static final String ARTIFACT_INSTRUMENT_TEST = "_instrument_test_";
/**
* Returns the model version. This is a string in the format X.Y.Z
*
* @return a string containing the model version.
*/
@NonNull
String getModelVersion();
/**
* Returns the name of the module.
*
* @return the name of the module.
*/
@NonNull
String getName();
/**
* Returns whether this is a library.
* @return true for a library module.
*/
boolean isLibrary();
/**
* Returns the {@link ProductFlavorContainer} for the 'main' default config.
*
* @return the product flavor.
*/
@NonNull
ProductFlavorContainer getDefaultConfig();
/**
* Returns a list of all the {@link BuildType} in their container.
*
* @return a list of build type containers.
*/
@NonNull
Collection<BuildTypeContainer> getBuildTypes();
/**
* Returns a list of all the {@link ProductFlavor} in their container.
*
* @return a list of product flavor containers.
*/
@NonNull
Collection<ProductFlavorContainer> getProductFlavors();
/**
* Returns a list of all the variants.
*
* This does not include test variant. Test variants are additional artifacts in their
* respective variant info.
*
* @return a list of the variants.
*/
@NonNull
Collection<Variant> getVariants();
/**
* Returns a list of extra artifacts meta data. This does not include the main artifact.
*
* @return a list of extra artifacts
*/
@NonNull
Collection<ArtifactMetaData> getExtraArtifacts();
/**
* Returns the compilation target as a string. This is the full extended target hash string.
* (see com.android.sdklib.IAndroidTarget#hashString())
*
* @return the target hash string
*/
@NonNull
String getCompileTarget();
/**
* Returns the boot classpath matching the compile target. This is typically android.jar plus
* other optional libraries.
*
* @return a list of jar files.
*/
@NonNull
Collection<String> getBootClasspath();
/**
* Returns a list of folders or jar files that contains the framework source code.
* @return a list of folders or jar files that contains the framework source code.
*/
@NonNull
Collection<File> getFrameworkSources();
/**
* Returns a list of {@link SigningConfig}.
*
* @return a map of signing config
*/
@NonNull
Collection<SigningConfig> getSigningConfigs();
/**
* Returns the aapt options.
*
* @return the aapt options.
*/
@NonNull
AaptOptions getAaptOptions();
/**
* Returns the dependencies that were not successfully resolved. The returned list gets
* populated only if the system property {@link #BUILD_MODEL_ONLY_SYSTEM_PROPERTY} has been
* set to {@code true}.
* <p>
* Each value of the collection has the format group:name:version, for example:
* com.google.guava:guava:15.0.2
*
* @return the dependencies that were not successfully resolved.
*/
@NonNull
Collection<String> getUnresolvedDependencies();
/**
* @return the compile options for Java code.
*/
@NonNull
JavaCompileOptions getJavaCompileOptions();
}
|
