Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 3f3f6bf8355115a92083429174c6d048c15bee23 (plain) (blame)
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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
/*******************************************************************************
 * Copyright (c) 2008, 2013 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.pde.api.tools.builder.tests.tags;

import junit.framework.Test;

import org.eclipse.core.runtime.IPath;
import org.eclipse.jdt.internal.compiler.impl.CompilerOptions;
import org.eclipse.pde.api.tools.internal.builder.BuilderMessages;
import org.eclipse.pde.api.tools.internal.problems.ApiProblemFactory;
import org.eclipse.pde.api.tools.internal.provisional.descriptors.IElementDescriptor;
import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblem;

/**
 * Tests unsupported javadoc tags for annotations
 * 
 * @since 1.0
 */
public class InvalidAnnotationTagTests extends TagTest {

	/**
	 * Constructor
	 * @param name
	 */
	public InvalidAnnotationTagTests(String name) {
		super(name);
	}

	/**
	 * @return the tests for this class
	 */
	public static Test suite() {
		return buildTestSuite(InvalidAnnotationTagTests.class);
	}
	
	/* (non-Javadoc)
	 * @see org.eclipse.pde.api.tools.builder.tests.ApiBuilderTests#getTestSourcePath()
	 */
	protected IPath getTestSourcePath() {
		return super.getTestSourcePath().append("annotation");
	}
	
	/* (non-Javadoc)
	 * @see org.eclipse.pde.api.tools.builder.tests.tags.TagTest#getDefaultProblemId()
	 */
	protected int getDefaultProblemId() {
		return ApiProblemFactory.createProblemId(IApiProblem.CATEGORY_USAGE, IElementDescriptor.TYPE, IApiProblem.UNSUPPORTED_TAG_USE, IApiProblem.NO_FLAGS);
	}
	
	/* (non-Javadoc)
	 * @see org.eclipse.pde.api.tools.builder.tests.ApiBuilderTest#getTestCompliance()
	 */
	protected String getTestCompliance() {
		return CompilerOptions.VERSION_1_5;
	}
	
	public void testInvalidAnnotationTag3I() {
		x3(true);
	}
	
	public void testInvalidAnnotationTag3F() {
		x3(false);
	}
	
	/**
	 * Tests having an @noextend tag on a variety of inner / outer / top-level annotations in package a.b.c
	 */
	private void x3(boolean inc) {
		setExpectedProblemIds(getDefaultProblemSet(4));
		setExpectedMessageArgs("@noextend", BuilderMessages.TagValidator_an_annotation, 4);
		String typename = "test3.java"; 
		deployTagTest(typename, inc, false);
	}
	
	public void testInvalidAnnotationTag4I() {
		x4(true);
	}

	public void testInvalidAnnotationTag4F() {
		x4(false);
	}
	
	/**
	 * Tests having an @noextend tag on an annotation in the default package
	 */
	private void x4(boolean inc) {
		setExpectedProblemIds(getDefaultProblemSet(1));
		setExpectedMessageArgs("@noextend", BuilderMessages.TagValidator_an_annotation, 1);
		String typename = "test4.java"; 
		deployTagTest(typename, inc, true);
	}
	
	public void testInvalidAnnotationTag5I() {
		x5(true);
	}
	
	public void testInvalidAnnotationTag5F() {
		x5(false);
	}
	
	/**
	 * Tests having an @nooverride tag on a variety of inner / outer / top-level annotations in package a.b.c
	 */
	private void x5(boolean inc) {
		setExpectedProblemIds(getDefaultProblemSet(4));
		setExpectedMessageArgs("@nooverride", BuilderMessages.TagValidator_an_annotation, 4);
		String typename = "test5.java"; 
		deployTagTest(typename, inc, false);
	}

	public void testInvalidAnnotationTag6I() {
		x6(true);
	}
	
	public void testInvalidAnnotationTag6F() {
		x6(false);
	}
	
	/**
	 * Tests having an @nooverride tag on an annotation in the default package
	 */
	private void x6(boolean inc) {
		setExpectedProblemIds(getDefaultProblemSet(1));
		setExpectedMessageArgs("@nooverride", BuilderMessages.TagValidator_an_annotation, 1);
		String typename = "test6.java"; 
		deployTagTest(typename, inc, true);
	}

	public void testInvalidAnnotationTag7I() {
		x7(true);
	}

	public void testInvalidAnnotationTag7F() {
		x7(false);
	}
	
	/**
	 * Tests having a variety of invalid tags on a variety of inner / outer / top-level annotations in package a.b.c
	 */
	private void x7(boolean inc) {
		setExpectedProblemIds(getDefaultProblemSet(12));
		setExpectedMessageArgs(new String[][] {
				{"@noinstantiate", BuilderMessages.TagValidator_an_annotation},
				/*{"@noreference", BuilderMessages.TagValidator_an_annotation},*/
				{"@noextend", BuilderMessages.TagValidator_an_annotation},
				{"@nooverride", BuilderMessages.TagValidator_an_annotation},
				{"@noinstantiate", BuilderMessages.TagValidator_an_annotation},
				/*{"@noreference", BuilderMessages.TagValidator_an_annotation},*/
				{"@noextend", BuilderMessages.TagValidator_an_annotation},
				{"@nooverride", BuilderMessages.TagValidator_an_annotation},
				{"@noinstantiate", BuilderMessages.TagValidator_an_annotation},
				/*{"@noreference", BuilderMessages.TagValidator_an_annotation},*/
				{"@noextend", BuilderMessages.TagValidator_an_annotation},
				{"@nooverride", BuilderMessages.TagValidator_an_annotation},
				{"@noinstantiate", BuilderMessages.TagValidator_an_annotation},
				/*{"@noreference", BuilderMessages.TagValidator_an_annotation},*/
				{"@noextend", BuilderMessages.TagValidator_an_annotation},
				{"@nooverride", BuilderMessages.TagValidator_an_annotation},
		});
		String typename = "test7.java"; 
		deployTagTest(typename, inc, false);
	}
	
	public void testInvalidAnnotationTag8I() {
		x8(true);
	}
	
	public void testInvalidAnnotationTag8F() {
		x8(false);
	}
	
	/**
	 * Tests having more than one invalid tag on an annotation in the default package
	 */
	private void x8(boolean inc) {
		setExpectedProblemIds(getDefaultProblemSet(3));
		setExpectedMessageArgs(new String[][] {
				{"@noinstantiate", BuilderMessages.TagValidator_an_annotation},
				/*{"@noreference", BuilderMessages.TagValidator_an_annotation},*/
				{"@noextend", BuilderMessages.TagValidator_an_annotation},
				{"@nooverride", BuilderMessages.TagValidator_an_annotation},
		});
		String typename = "test8.java"; 
		deployTagTest(typename, inc, true);
	}
	
	public void testInvalidAnnotationTag9I() {
		x9(true);
	}
	
	public void testInvalidAnnotationTag9F() {
		x9(false);
	}
	
	/**
	 * Tests having an @noinstantiate tag on a variety of inner / outer / top-level annotations in package a.b.c
	 */
	private void x9(boolean inc) {
		setExpectedProblemIds(getDefaultProblemSet(4));
		setExpectedMessageArgs("@noinstantiate", BuilderMessages.TagValidator_an_annotation, 4);
		String typename = "test9.java"; 
		deployTagTest(typename, inc, false);
	}
	
	public void testInvalidAnnotationTag10I() {
		x10(true);
	}
	
	public void testInvalidAnnotationTag10F() {
		x10(false);
	}
	
	/**
	 * Tests having an @noinstantiate tag on an annotation in the default package
	 */
	private void x10(boolean inc) {
		setExpectedProblemIds(getDefaultProblemSet(1));
		setExpectedMessageArgs("@noinstantiate", BuilderMessages.TagValidator_an_annotation, 1);
		String typename = "test10.java"; 
		deployTagTest(typename, inc, true);
	}
	
	public void testInvalidAnnotationTag11I() {
		x11(true);
	}
	
	public void testInvalidAnnotationTag11F() {
		x11(false);
	}
	
	/**
	 * Tests having an @noimplement tag on a variety of inner / outer / top-level annotations in package a.b.c
	 */
	private void x11(boolean inc) {
		setExpectedProblemIds(getDefaultProblemSet(4));
		setExpectedMessageArgs("@noimplement", BuilderMessages.TagValidator_an_annotation, 4);
		String typename = "test11.java"; 
		deployTagTest(typename, inc, false);
	}

	public void testInvalidAnnotationTag12I() {
		x12(true);
	}
	
	public void testInvalidAnnotationTag12F() {
		x12(false);
	}
	
	/**
	 * Tests having an @noimplement tag on an annotation in the default package
	 */
	private void x12(boolean inc) {
		setExpectedProblemIds(getDefaultProblemSet(1));
		setExpectedMessageArgs("@noimplement", BuilderMessages.TagValidator_an_annotation, 1);
		String typename = "test12.java"; 
		deployTagTest(typename, inc, true);
	}
	
	public void testInvalidAnnotationTag13I() {
		x13(true);
	}
	
	public void testInvalidAnnotationTag13F() {
		x13(false);
	}
	
	/**
	 * Tests all tags are invalid when parent annotation is private or package default
	 */
	private void x13(boolean inc) {
		setExpectedProblemIds(getDefaultProblemSet(7));
		setExpectedMessageArgs(new String[][] {
				{"@noextend", BuilderMessages.TagValidator_a_class_that_is_not_visible},
				{"@noinstantiate", BuilderMessages.TagValidator_a_class_that_is_not_visible},
				{"@noreference", BuilderMessages.TagValidator_a_class_that_is_not_visible},
				{"@noextend", BuilderMessages.TagValidator_an_interface_that_is_not_visible},
				{"@noimplement", BuilderMessages.TagValidator_an_interface_that_is_not_visible},
				{"@noreference", BuilderMessages.TagValidator_an_interface_that_is_not_visible},
				{"@noreference", BuilderMessages.TagValidator_annotation_field}	
				/*{"@noreference", BuilderMessages.TagValidator_an_annotation},
				{"@noreference", BuilderMessages.TagValidator_an_enum},*/
		});
		String typename = "test13.java"; 
		deployTagTest(typename, inc, true);
	}
}

Back to the top