/
Example.java
91 lines (83 loc) · 2.44 KB
/
Example.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
/*
* 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 java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.CLASS;
/**
* Denotes the model field value used as an example in the generated REST-based microservice documentation.
*
* @author nedis
* @see Description
* @see IncludeDescription
* @see IncludeMode
* @since 0.1
*/
@Documented
@Retention(CLASS)
@Target({FIELD, METHOD, PARAMETER})
@Repeatable(Example.List.class)
public @interface Example {
/**
* Returns the example value.
*
* @return the example value
*/
String value();
/**
* Returns the variable definitions for the provided example value, using key-value format.
*
* <p>
* For example:
*
* <pre>
* {@code
* @Example(
* value = "${key}.${value}",
* variables = {
* "${key}", EXTERNAL_CONSTANT_KEY,
* "${value}", EXTERNAL_CONSTANT_VALUE
* }
* )
* }
* </pre>
*
* @return the variable definitions for the provided example value, using key-value format.
*/
String[] variables() default {};
/**
* Defines several {@link Example} annotations on the same element.
*
* @author nedis
* @since 0.1
*/
@Documented
@Retention(CLASS)
@Target({FIELD, METHOD, PARAMETER})
@interface List {
/**
* Returns the several {@link Example} annotations on the same element.
*
* @return the several {@link Example} annotations on the same element.
*/
Example[] value();
}
}