1 /* 2 * Copyright (c) 2010, 2013, 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 /* 27 * This file is available under and governed by the GNU General Public 28 * License version 2 only, as published by the Free Software Foundation. 29 * However, the following notice accompanied the original version of this 30 * file, and Oracle licenses the original version of this file under the BSD 31 * license: 32 */ 33 /* 34 Copyright 2009-2013 Attila Szegedi 35 36 Redistribution and use in source and binary forms, with or without 37 modification, are permitted provided that the following conditions are 38 met: 39 * Redistributions of source code must retain the above copyright 40 notice, this list of conditions and the following disclaimer. 41 * Redistributions in binary form must reproduce the above copyright 42 notice, this list of conditions and the following disclaimer in the 43 documentation and/or other materials provided with the distribution. 44 * Neither the name of the copyright holder nor the names of 45 contributors may be used to endorse or promote products derived from 46 this software without specific prior written permission. 47 48 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS 49 IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 50 TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A 51 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER 52 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 53 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 54 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 55 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 56 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 57 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 58 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 59 */ 60 61 package jdk.dynalink.linker; 62 63 import jdk.dynalink.CallSiteDescriptor; 64 import jdk.dynalink.DynamicLinker; 65 import jdk.dynalink.DynamicLinkerFactory; 66 67 /** 68 * Represents a request to link a particular invocation at a particular call 69 * site. Instances of these requests will be constructed and passed to all 70 * {@link GuardingDynamicLinker} objects managed by the {@link DynamicLinker} 71 * that is trying to link the call site. 72 */ 73 public interface LinkRequest { 74 /** 75 * Returns the call site descriptor for the call site being linked. 76 * 77 * @return the call site descriptor for the call site being linked. 78 */ getCallSiteDescriptor()79 public CallSiteDescriptor getCallSiteDescriptor(); 80 81 /** 82 * Returns the arguments for the invocation being linked. The returned array 83 * must be a clone; modifications to it must not affect the arguments in 84 * this request. 85 * 86 * @return the arguments for the invocation being linked. 87 */ getArguments()88 public Object[] getArguments(); 89 90 /** 91 * Returns the first argument for the invocation being linked; this is 92 * typically the receiver object. This is a shorthand for 93 * {@code getArguments()[0]} that also avoids the cloning of the arguments 94 * array. 95 * 96 * @return the receiver object. 97 */ getReceiver()98 public Object getReceiver(); 99 100 /** 101 * Returns true if the call site is considered unstable, that is, it has been relinked more times than was 102 * specified in {@link DynamicLinkerFactory#setUnstableRelinkThreshold(int)}. Linkers should use this as a 103 * hint to prefer producing linkage that is more stable (its guard fails less frequently), even if that assumption 104 * causes a less effective version of an operation to be linked. This is just a hint, though, and linkers are 105 * allowed to ignore this property. 106 * @return true if the call site is considered unstable. 107 */ isCallSiteUnstable()108 public boolean isCallSiteUnstable(); 109 110 /** 111 * Returns a request identical to this one with call site descriptor and arguments replaced with the ones specified. 112 * 113 * @param callSiteDescriptor the new call site descriptor 114 * @param arguments the new arguments 115 * @return a new request identical to this one, except with the call site descriptor and arguments replaced with the 116 * specified ones. 117 */ replaceArguments(CallSiteDescriptor callSiteDescriptor, Object... arguments)118 public LinkRequest replaceArguments(CallSiteDescriptor callSiteDescriptor, Object... arguments); 119 } 120