001/*
002 * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.
008 *
009 * This code is distributed in the hope that it will be useful, but WITHOUT
010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
011 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
012 * version 2 for more details (a copy is included in the LICENSE file that
013 * accompanied this code).
014 *
015 * You should have received a copy of the GNU General Public License version
016 * 2 along with this work; if not, write to the Free Software Foundation,
017 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
018 *
019 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
020 * or visit www.oracle.com if you need additional information or have any
021 * questions.
022 */
023package com.oracle.graal.api.replacements;
024
025import java.lang.annotation.*;
026
027/**
028 * Denotes a class that substitutes methods of another specified class. The substitute methods are
029 * exactly those annotated by {@link MethodSubstitution}.
030 */
031@Retention(RetentionPolicy.RUNTIME)
032@Target(ElementType.TYPE)
033public @interface ClassSubstitution {
034
035    /**
036     * Specifies the original class.
037     * <p>
038     * If the default value is specified for this element, then a non-default value must be given
039     * for the {@link #className()} element.
040     */
041    Class<?> value() default ClassSubstitution.class;
042
043    /**
044     * Specifies the original class or classes if a single class is being used for multiple
045     * substitutions.
046     * <p>
047     * This method is provided for cases where the original class is not accessible (according to
048     * Java language access control rules).
049     * <p>
050     * If the default value is specified for this element, then a non-default value must be given
051     * for the {@link #value()} element.
052     */
053    String[] className() default {};
054
055    /**
056     * Determines if the substitutions are for classes that may not be part of the runtime.
057     * Substitutions for such classes are omitted if the original classes cannot be found.
058     */
059    boolean optional() default false;
060
061    /**
062     * Determines if the substitutions in a class are globally enabled. Individual
063     * MethodSubstitutions can also have guards and those override this guard.
064     */
065    Class<? extends SubstitutionGuard> defaultGuard() default SubstitutionGuard.class;
066}