-
Notifications
You must be signed in to change notification settings - Fork 0
/
FutureApi.java
44 lines (40 loc) · 1.65 KB
/
FutureApi.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
/*
* This is part of Geomajas, a GIS framework, http://www.geomajas.org/.
*
* Copyright 2008-2015 Geosparc nv, http://www.geosparc.com/, Belgium.
*
* The program is available in open source according to the Apache
* License, Version 2.0. All contributions in this program are covered
* by the Geomajas Contributors License Agreement. For full licensing
* details, see LICENSE.txt in the project root.
*/
package org.geomajas.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotation which indicates that a class and/or method are planned to be part of the supported Geomajas API.
* <p/>
* This is an annotation to indicate that this should be part of the API, but there is still some room for discussion
* or validation before changing to {@link Api}.
* <p/>
* The intention is that these annotations only remain for a short time, either removing the annotation or changing to
* {@link Api}. In principle this should be checked before a release. It is recommended to add some comments to
* indicate why it is not yet @Api and/or indicate when it should become {@link Api}.
*
* @author Joachim Van der Auwera
* @since 1.0.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.LOCAL_VARIABLE,
ElementType.ANNOTATION_TYPE, ElementType.FIELD })
@Documented
@Api(allMethods = true)
public @interface FutureApi {
/**
* For class level annotation, does it apply to all methods?
*/
boolean allMethods() default false;
}