1 /*
   2  * Copyright (c) 2015, 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.annotations;
  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 import jdk.jfr.AnnotationElement;
  34 import jdk.jfr.Description;
  35 import jdk.jfr.Event;
  36 import jdk.jfr.EventType;
  37 import jdk.jfr.MetadataDefinition;
  38 import jdk.jfr.SettingDefinition;
  39 import jdk.jfr.SettingDescriptor;
  40 import jdk.test.lib.Asserts;
  41 import jdk.test.lib.jfr.Events;
  42 import jdk.test.lib.jfr.SimpleSetting;
  43 
  44 /**
  45  * @test
  46  * @key jfr
  47  *
  48  * @library /lib /
  49  * @run main/othervm jdk.jfr.api.metadata.annotations.TestDescription
  50  */
  51 public class TestDescription {
  52 
  53     @MetadataDefinition
  54     @Target({ ElementType.TYPE })
  55     @Retention(RetentionPolicy.RUNTIME)
  56     @Description("Meta Annotation")
  57     @interface AnnotationWithDescription {
  58     }
  59 
  60     @AnnotationWithDescription
  61     @Description("Event Annotation")
  62     static class DescriptionEvent extends Event {
  63         @Description("Field Annotation")
  64         String field;
  65 
  66         @SettingDefinition
  67         @Description("Setting description")
  68         boolean dummy(SimpleSetting ds) {
  69             return true;
  70         }
  71     }
  72 
  73     public static void main(String[] args) throws Exception {
  74 
  75         EventType t = EventType.getEventType(DescriptionEvent.class);
  76 
  77         // field description
  78         AnnotationElement aMax = Events.getAnnotation(t.getField("field"), Description.class);
  79         String d = (String) aMax.getValue("value");
  80         Asserts.assertEquals("Field Annotation", d, "Incorrect annotation for field, got '" + d + "'");
  81 
  82         // event description
  83         d = t.getAnnotation(Description.class).value();
  84         Asserts.assertEquals("Event Annotation", d, "Incorrect annotation for event, got '" + d + "'");
  85 
  86         // annotation description
  87         AnnotationElement a = Events.getAnnotationByName(t, AnnotationWithDescription.class.getName());
  88         Description de = a.getAnnotation(Description.class);
  89         Asserts.assertEquals("Meta Annotation", de.value(), "Incorrect annotation for event, got '" + de.value() + "'");
  90 
  91         for (SettingDescriptor v: t.getSettingDescriptors()) {
  92             if (v.getName().equals("dummy")) {
  93                 Description settingDescription = v.getAnnotation(Description.class);
  94                 Asserts.assertEquals(settingDescription.value(), "Setting description", "Incorrect description for setting");
  95             }
  96         }
  97     }
  98 }