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