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.Event;
  35 import jdk.jfr.EventType;
  36 import jdk.jfr.MetadataDefinition;
  37 import jdk.jfr.Name;
  38 import jdk.jfr.SettingDefinition;
  39 import jdk.jfr.SettingDescriptor;
  40 import jdk.jfr.ValueDescriptor;
  41 import jdk.test.lib.Asserts;
  42 import jdk.test.lib.jfr.Events;
  43 import jdk.test.lib.jfr.SimpleSetting;
  44 
  45 /*
  46  * @test
  47  * @key jfr
  48  * @library /test/lib
  49  * @run main/othervm jdk.jfr.api.metadata.annotations.TestName
  50  */
  51 public class TestName {
  52 
  53     @MetadataDefinition
  54     @Name("com.oracle.TestAnnotation")
  55     @Target({ ElementType.TYPE })
  56     @Retention(RetentionPolicy.RUNTIME)
  57     @interface NamedAnnotation {
  58     }
  59 
  60     @NamedAnnotation
  61     @Name("com.oracle.TestEvent")
  62     static class NamedEvent extends Event {
  63         @Name("testField")
  64         boolean namedField;
  65 
  66         @SettingDefinition
  67         @Name("name")
  68         boolean dummy(SimpleSetting ds) {
  69             return true;
  70         }
  71     }
  72 
  73     public static void main(String[] args) throws Exception {
  74         EventType t = EventType.getEventType(NamedEvent.class);
  75         ValueDescriptor testField = t.getField("testField");
  76         SettingDescriptor setting = getSetting(t, "name");
  77         AnnotationElement a = Events.getAnnotationByName(t, "com.oracle.TestAnnotation");
  78 
  79         // Check that names are overridden
  80         Asserts.assertNotNull(testField, "Can't find expected field testField");
  81         Asserts.assertEquals(t.getName(), "com.oracle.TestEvent", "Incorrect name for event");
  82         Asserts.assertEquals(a.getTypeName(), "com.oracle.TestAnnotation", "Incorrect name for annotation");
  83         Asserts.assertEquals(a.getTypeName(), "com.oracle.TestAnnotation", "Incorrect name for annotation");
  84         Asserts.assertEquals(setting.getName(), "name", "Incorrect name for setting");
  85 
  86         // Check that @Name is persisted
  87         assertAnnotation(t.getAnnotation(Name.class), "@Name should be persisted on event");
  88         assertAnnotation(testField.getAnnotation(Name.class), "@Name should be persisted on field");
  89         assertAnnotation(a.getAnnotation(Name.class), "@Name should be persisted on annotations");
  90         assertAnnotation(setting.getAnnotation(Name.class), "@Name should be persisted on setting");
  91     }
  92 
  93     // Can't use assert since the use toString on the object which doesn't work well JFR proxies.
  94     private static void assertAnnotation(Object annotation,String message) throws Exception {
  95        if (annotation == null) {
  96            throw new Exception(message);
  97        }
  98     }
  99 
 100     private static SettingDescriptor getSetting(EventType t, String name) {
 101         for (SettingDescriptor v : t.getSettingDescriptors()) {
 102             if (v.getName().equals(name)) {
 103                 return v;
 104             }
 105         }
 106         Asserts.fail("Could not find setting with name " + name);
 107         return null;
 108     }
 109 }