blob: 0ef1cacb48df961ec8cb4f60a787fad8f7439b2e (
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
|
/*******************************************************************************
* Copyright (c) 2011 Stephan Herrmann 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:
* Stephan Herrmann - initial API and implementation
* IBM Corporation - bug fixes
*******************************************************************************/
package org.eclipse.jdt.annotation;
import static java.lang.annotation.ElementType.CONSTRUCTOR;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PACKAGE;
import static java.lang.annotation.ElementType.TYPE;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* This annotation can be applied to a package, type, method or constructor in order to
* define that all contained entities for which a null annotation is otherwise lacking
* should be considered as {@link NonNull @NonNull}.
* <dl>
* <dt>Canceling a default</dt>
* <dd>By using a <code>@NonNullByDefault</code> annotation with the argument <code>false</code>,
* a default from any enclosing scope can be canceled for the element being annotated.
* <dt>Nested defaults</dt>
* <dd>If a <code>@NonNullByDefault</code>
* annotation is used within the scope of another <code>@NonNullByDefault</code>
* annotation or a project-wide default setting, the innermost annotation defines the
* default applicable at any given position (depending on the parameter {@link #value()}).</dd>
* </dl>
* Note that for applying an annotation to a package, a file by the name
* <code>package-info.java</code> is used.
*
* @since 1.0
*/
@Documented
@Retention(RetentionPolicy.CLASS)
@Target({ PACKAGE, TYPE, METHOD, CONSTRUCTOR })
public @interface NonNullByDefault {
/**
* When parameterized with <code>false</code>, the annotation specifies that the current element should not apply
* any default to un-annotated types.
*/
boolean value() default true;
}
|