/
License.java
112 lines (103 loc) · 3.18 KB
/
License.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
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
/*
* Copyright (c) 2020. https://rxmicro.io
*
* 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 io.rxmicro.documentation;
import java.lang.annotation.Documented;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static io.rxmicro.documentation.DocumentationConstants.DEFAULT_LICENSE_NAME;
import static io.rxmicro.documentation.DocumentationConstants.DEFAULT_LICENSE_URL;
import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.MODULE;
import static java.lang.annotation.RetentionPolicy.CLASS;
/**
* Denotes the license of REST-based microservice in the generated REST-based microservice documentation.
*
* <p>
* (<i>Allows overriding the license of REST-based microservice specified in the license directive to pom.xml</i>)
*
* @author nedis
* @see Author
* @see BaseEndpoint
* @see DocumentationConstants
* @see Description
* @see DocumentationDefinition
* @see DocumentationVersion
* @see IncludeDescription
* @see IncludeMode
* @see IntroductionDefinition
* @see ResourceDefinition
* @see ResourceGroupDefinition
* @see Title
* @since 0.1
*/
@Documented
@Retention(CLASS)
@Target({MODULE, ANNOTATION_TYPE})
@Repeatable(License.List.class)
public @interface License {
/**
* Returns the license name.
*
* @return the license name
*/
String name() default DEFAULT_LICENSE_NAME;
/**
* Returns the license url.
*
* @return the license url
*/
String url() default DEFAULT_LICENSE_URL;
/**
* Returns the variable definitions for the provided license name and(or) url, using key-value format.
*
* <p>
* For example:
*
* <pre>
* {@code
* @License(
* name = "${firstName} ${lastName} Licence",
* url = "http://${firstName}.${lastName}.licence.org",
* variables = {
* "${firstName}", EXTERNAL_CONSTANT_FIRST_NAME,
* "${lastName}", EXTERNAL_CONSTANT_LAST_NAME
* }
* )
* }
* </pre>
*
* @return the variable definitions for the provided license name and(or) url, using key-value format.
*/
String[] variables() default {};
/**
* Defines several {@link License} annotations on the same element.
*
* @author nedis
* @since 0.1
*/
@Documented
@Retention(CLASS)
@Target({MODULE, ANNOTATION_TYPE})
@interface List {
/**
* Returns the several {@link License} annotations on the same element.
*
* @return the several {@link License} annotations on the same element.
*/
License[] value();
}
}