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