1 /*
2  * Copyright (c) 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.api.metadata.eventtype;
27 
28 import java.util.ArrayList;
29 import java.util.Arrays;
30 import java.util.List;
31 
32 import jdk.jfr.Category;
33 import jdk.jfr.Description;
34 import jdk.jfr.Event;
35 import jdk.jfr.EventType;
36 import jdk.jfr.Label;
37 import jdk.test.lib.Asserts;
38 
39 /**
40  * @test
41  * @summary Test descriptive annotations for EventType
42  * @key jfr
43  * @requires vm.hasJFR
44  * @library /test/lib
45  * @run main/othervm jdk.jfr.api.metadata.eventtype.TestGetDescription
46  */
47 public class TestGetDescription {
48 
main(String[] args)49     public static void main(String[] args) throws Throwable {
50         EventType defaultType = EventType.getEventType(DefaultEvent.class);
51         System.out.printf("defaultType.category='%s'%n", defaultType.getCategoryNames());
52         System.out.printf("defaultType.desc='%s'%n", defaultType.getDescription());
53         System.out.printf("defaultType.label='%s'%n", defaultType.getLabel());
54 
55         List<String> defaultCategory = Arrays.asList(new String[] {"Uncategorized"});
56         Asserts.assertEquals(defaultType.getCategoryNames(), defaultCategory, "Wrong default category");
57         Asserts.assertNull(defaultType.getDescription(), "Wrong default description");
58         Asserts.assertEquals(defaultType.getLabel(), null, "Wrong default label"); // JavaDoc says "not null"
59 
60         EventType annotatedType = EventType.getEventType(AnnotatedEvent.class);
61         System.out.printf("annotated.category='%s'%n", annotatedType.getCategoryNames());
62         System.out.printf("annotated.desc='%s'%n", annotatedType.getDescription());
63         System.out.printf("annotated.label='%s'%n", annotatedType.getLabel());
64 
65         List<String> expectedCategorNames = new ArrayList<>();
66         expectedCategorNames.add("MyCategory");
67         Asserts.assertEquals(annotatedType.getCategoryNames(), expectedCategorNames, "Wrong default category");
68         Asserts.assertEquals(annotatedType.getDescription(), "MyDesc", "Wrong default description");
69         Asserts.assertEquals(annotatedType.getLabel(), "MyLabel", "Wrong default label");
70     }
71 
72     private static class DefaultEvent extends Event {
73     }
74 
75     @Category("MyCategory")
76     @Description("MyDesc")
77     @Label("MyLabel")
78     private static class AnnotatedEvent extends Event {
79     }
80 }
81