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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
|
/*******************************************************************************
* Copyright (c) 2005, 2019 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
* Stephan Herrmann - Contribution for
* Bug 440477 - [null] Infrastructure for feeding external annotations into compilation
*******************************************************************************/
package org.eclipse.jdt.core;
/**
* A classpath attribute defines a name/value pair that can be persisted with a classpath entry. Such an attribute
* can be created using the factory method {@link JavaCore#newClasspathAttribute(String, String) newClasspathAttribute(String name, String value)}.
*
* @see JavaCore#newContainerEntry(
* org.eclipse.core.runtime.IPath containerPath,
* IAccessRule[] accessRules,
* IClasspathAttribute[] extraAttributes,
* boolean isExported)
* @see JavaCore#newLibraryEntry(
* org.eclipse.core.runtime.IPath path,
* org.eclipse.core.runtime.IPath sourceAttachmentPath,
* org.eclipse.core.runtime.IPath sourceAttachmentRootPath,
* IAccessRule[] accessRules,
* IClasspathAttribute[] extraAttributes,
* boolean isExported)
* @see JavaCore#newProjectEntry(
* org.eclipse.core.runtime.IPath path,
* IAccessRule[] accessRules,
* boolean combineAccessRestrictions,
* IClasspathAttribute[] extraAttributes,
* boolean isExported)
* @see JavaCore#newSourceEntry(
* org.eclipse.core.runtime.IPath path,
* org.eclipse.core.runtime.IPath[] inclusionPatterns,
* org.eclipse.core.runtime.IPath[] exclusionPatterns,
* org.eclipse.core.runtime.IPath specificOutputLocation,
* IClasspathAttribute[] extraAttributes)
* @see JavaCore#newVariableEntry(
* org.eclipse.core.runtime.IPath variablePath,
* org.eclipse.core.runtime.IPath variableSourceAttachmentPath,
* org.eclipse.core.runtime.IPath variableSourceAttachmentRootPath,
* IAccessRule[] accessRules,
* IClasspathAttribute[] extraAttributes,
* boolean isExported)
* @since 3.1
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface IClasspathAttribute {
/**
* Constant for the name of the javadoc location attribute.
*
* <p>The value for this attribute has to be the string representation of a URL.</p>
*
* @since 3.1
*/
String JAVADOC_LOCATION_ATTRIBUTE_NAME = "javadoc_location"; //$NON-NLS-1$
/**
* Constant for the name of the index location attribute.
*
* <p>The value for this attribute has to be the string representation of a URL.
* It should point to an existing index file in a folder or a jar. The URL can also be of platform protocol.</p>
*
* @since 3.8
*/
String INDEX_LOCATION_ATTRIBUTE_NAME = "index_location"; //$NON-NLS-1$
/**
* Constant for the name of the encoding to be used for source attachments.
*
* <p>The value of this attribute has to be a string representation of a valid encoding. The encoding
* for a source attachment is determined in the following order: </p>
*
* <ul>
* <li> Encoding explicitly set on the source file (java or zip), i.e. <code>org.eclipse.core.resources.IFile#getCharset(false)</code> </li>
* <li> Encoding set on the corresponding classpath entry </li>
* <li> If the source attachment is a folder, then the encoding determined by the file content if detectable </li>
* <li> If the source attachment is in the workspace, then the encoding of the enclosing resources</li>
* </ul>
*
* @see org.eclipse.core.resources.IFile#getCharset()
* @since 3.8
*/
String SOURCE_ATTACHMENT_ENCODING = "source_encoding"; //$NON-NLS-1$
/**
* Constant for the name of the ignore optional compile problems attribute.
* This attribute is valid only for classpath entries describing source folders.
* The possible values for this attribute are <code>"true"</code> or
* <code>"false"</code>. When not present, <code>"false"</code> is assumed.
* If the value of this attribute is <code>"true"</code>, all optional problems
* from the source folder described by this classpath entry will not be reported
* by the compiler.
*
* @since 3.8
*/
String IGNORE_OPTIONAL_PROBLEMS = "ignore_optional_problems"; //$NON-NLS-1$
/**
* Constant for the name of the optional attribute. The possible values
* for this attribute are <code>"true"</code> or <code>"false"</code>.
* When not present, <code>"false"</code> is assumed.
* If the value of this attribute is <code>"true"</code>, the classpath entry
* is optional. If the underlying resource or jar file doesn't exist, no error
* is reported and the classpath entry is ignored.
*
* @since 3.2
*/
String OPTIONAL = "optional"; //$NON-NLS-1$
/**
* Constant for the name of the module attribute. The possible values
* for this attribute are <code>"true"</code> or <code>"false"</code>.
* When not present, <code>"false"</code> is assumed.
* If the value of this attribute is <code>"true"</code>, the classpath
* entry is considered to be on the module path and will be treated as a
* regular named module or as an automatic module.
*
* @since 3.14
*/
String MODULE = "module"; //$NON-NLS-1$
/**
* Constant for the name of the add-exports attribute.
*
* <p>The value of this attribute must adhere to the syntax of <code>javac's</code>
* {@code --add-exports} command line option: {@code <source-module>/<package>=<target-module>(,<target-module>)*}.
* Multiple such options are packed as a ':' separated list into a single classpath attribute.
* The given exports will be added at compile time.</p>
* <p>Classpath entries with this attribute should also have a {@link #MODULE} attribute
* with value <code>"true"</code>.</p>
*
* @since 3.14
*/
String ADD_EXPORTS = "add-exports"; //$NON-NLS-1$
/**
* Constant for the name of the add-reads attribute.
*
* <p>The value of this attribute must adhere to the syntax of <code>javac's</code>
* {@code --add-reads} command line option: {@code <source-module>=<target-module>}.
* The given reads edge will be added at compile time.</p>
*
* @since 3.14
*/
String ADD_READS = "add-reads"; //$NON-NLS-1$
/**
* Constant for the name of the patch-module attribute.
*
* <p>The value of this attribute must be the name of a module defined in the
* classpath entry, to which this attribute is attached.</p>
*
* <p>This attribute is supported for classpath entries of kind
* {@link IClasspathEntry#CPE_CONTAINER}, {@link IClasspathEntry#CPE_LIBRARY}
* and {@link IClasspathEntry#CPE_PROJECT}.
* A classpath entry having this attribute must also have the
* {@link #MODULE} attribute with value <code>"true"</code>.</p>
*
* @since 3.14
*/
String PATCH_MODULE = "patch-module"; //$NON-NLS-1$
/**
* Constant for the name of the limit-modules attribute.
*
* <p>The value of this attribute must be a comma-separated list of names of modules
* defined in the classpath entry, to which this attribute is attached.
* The set of modules observable through this entry will be limited to
* the transitive closure of modules in this list.</p>
*
* <p>This attribute is supported for classpath entries of kind
* {@link IClasspathEntry#CPE_CONTAINER}.
* A classpath entry having this attribute must also have the
* {@link #MODULE} attribute with value <code>"true"</code>.</p>
*
* @since 3.14
*/
String LIMIT_MODULES = "limit-modules"; //$NON-NLS-1$
/**
* Constant of the name of the module-main-class attribute.
* The classpath entry holding this attribute must refer to a source folder
* containing the implementation of a module.
*
* <p>The value of this attribute must be the name of a class defined in this module.
* It will be used for generating the <code>ModuleMainClass</code> attribute
* in <code>module-info.class</code>.</p>
*
* @since 3.14
*/
String MODULE_MAIN_CLASS = "module-main-class"; //$NON-NLS-1$
/**
* Constant for the name of the external annotation path attribute.
*
* <p>The value for this attribute has to be the string representation of a path.
* It should point to an existing directory where external annotations can be
* found to support annotation based null analysis involving 3rd party libraries.</p>
*
* @since 3.11
*/
String EXTERNAL_ANNOTATION_PATH = "annotationpath"; //$NON-NLS-1$
/**
* Constant for the name of the test attribute.
*
* <p>
* The possible values for this attribute are <code>"true"</code> or <code>"false"</code>. When not present,
* <code>"false"</code> is assumed. If the value of this attribute is <code>"true"</code>, and the classpath entry
* is a source folder, it is assumed to contain test sources, otherwise main sources.
* </p>
* <p>
* During the compilation of main sources, only code is visible, that is reachable via classpath entries which do
* not have the test attribute set to to "true". During the compilation of test sources, all code is visible as if
* this attribute didn't exist at all.
* </p>
*
* @since 3.14
*/
String TEST = "test"; //$NON-NLS-1$
/**
* Constant for the name of the without_test_code attribute.
*
* <p>
* The possible values for this attribute are <code>"true"</code> or <code>"false"</code>. When not present,
* <code>"false"</code> is assumed. If the value of this attribute is <code>"true"</code>, and the classpath entry
* is a project, any test code reachable via that classpath entry will not be visible even to test sources.
* </p>
*
* @since 3.14
*/
String WITHOUT_TEST_CODE = "without_test_code"; //$NON-NLS-1$
/**
* Returns the name of this classpath attribute.
*
* @return the name of this classpath attribute.
* @since 3.1
*/
String getName();
/**
* Returns the value of this classpath attribute.
*
* @return the value of this classpath attribute.
* @since 3.1
*/
String getValue();
}
|
