1 /* 2 * Copyright (c) 2011, 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. 8 * 9 * This code is distributed in the hope that it will be useful, but WITHOUT 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 12 * version 2 for more details (a copy is included in the LICENSE file that 13 * accompanied this code). 14 * 15 * You should have received a copy of the GNU General Public License version 16 * 2 along with this work; if not, write to the Free Software Foundation, 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 18 * 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 20 * or visit www.oracle.com if you need additional information or have any 21 * questions. 22 */ 23 24 25 package org.graalvm.compiler.api.replacements; 26 27 import java.lang.annotation.ElementType; 28 import java.lang.annotation.Retention; 29 import java.lang.annotation.RetentionPolicy; 30 import java.lang.annotation.Target; 31 32 /** 33 * Denotes a class that substitutes methods of another specified class. The substitute methods are 34 * exactly those annotated by {@link MethodSubstitution}. 35 */ 36 @Retention(RetentionPolicy.RUNTIME) 37 @Target(ElementType.TYPE) 38 public @interface ClassSubstitution { 39 40 /** 41 * Specifies the original class. 42 * <p> 43 * If the default value is specified for this element, then a non-default value must be given 44 * for the {@link #className()} element. 45 */ 46 Class<?> value() default ClassSubstitution.class; 47 48 /** 49 * Specifies the original class or classes if a single class is being used for multiple 50 * substitutions. 51 * <p> 52 * This method is provided for cases where the original class is not accessible (according to 53 * Java language access control rules). 54 * <p> 55 * If the default value is specified for this element, then a non-default value must be given 56 * for the {@link #value()} element. 57 */ 58 String[] className() default {}; 59 60 /** 61 * Determines if the substitutions are for classes that may not be part of the runtime. 62 * Substitutions for such classes are omitted if the original classes cannot be found. If 63 * multiple classes are specified using {@link #className()} and {@link #optional()} is false, 64 * then at least one of the classes is required to be reachable. 65 */ 66 boolean optional() default false; 67 }