|
1 /* |
|
2 * Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved. |
|
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
|
4 * |
|
5 * This code is free software; you can redistribute it and/or modify it |
|
6 * under the terms of the GNU General Public License version 2 only, as |
|
7 * published by the Free Software Foundation. Oracle designates this |
|
8 * particular file as subject to the "Classpath" exception as provided |
|
9 * by Oracle in the LICENSE file that accompanied this code. |
|
10 * |
|
11 * This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 * version 2 for more details (a copy is included in the LICENSE file that |
|
15 * accompanied this code). |
|
16 * |
|
17 * You should have received a copy of the GNU General Public License version |
|
18 * 2 along with this work; if not, write to the Free Software Foundation, |
|
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 * |
|
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
22 * or visit www.oracle.com if you need additional information or have any |
|
23 * questions. |
|
24 */ |
|
25 |
|
26 package jdk.jfr; |
|
27 |
|
28 import java.lang.annotation.ElementType; |
|
29 import java.lang.annotation.Retention; |
|
30 import java.lang.annotation.RetentionPolicy; |
|
31 import java.lang.annotation.Target; |
|
32 |
|
33 /** |
|
34 * Annotation that describes an element by using a sentence or two. |
|
35 * <p> |
|
36 * Use sentence-style capitalization, capitalize the first letter of the first |
|
37 * word, and any proper names such as the word Java. If the description is one |
|
38 * sentence, a period should not be included. |
|
39 * |
|
40 * @since 9 |
|
41 */ |
|
42 @MetadataDefinition |
|
43 @Target({ ElementType.TYPE, ElementType.FIELD, ElementType.METHOD }) |
|
44 @Retention(RetentionPolicy.RUNTIME) |
|
45 public @interface Description { |
|
46 /** |
|
47 * Returns a sentence or two that describes the annotated element. |
|
48 * |
|
49 * @return a description, not {@code null} |
|
50 */ |
|
51 String value(); |
|
52 } |