Thu, 03 Dec 2015 13:41:24 -0800
Merge
attila@90 | 1 | /* |
attila@90 | 2 | * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved. |
attila@90 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
attila@90 | 4 | * |
attila@90 | 5 | * This code is free software; you can redistribute it and/or modify it |
attila@90 | 6 | * under the terms of the GNU General Public License version 2 only, as |
attila@90 | 7 | * published by the Free Software Foundation. Oracle designates this |
attila@90 | 8 | * particular file as subject to the "Classpath" exception as provided |
attila@90 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
attila@90 | 10 | * |
attila@90 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
attila@90 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
attila@90 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
attila@90 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
attila@90 | 15 | * accompanied this code). |
attila@90 | 16 | * |
attila@90 | 17 | * You should have received a copy of the GNU General Public License version |
attila@90 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
attila@90 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
attila@90 | 20 | * |
attila@90 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
attila@90 | 22 | * or visit www.oracle.com if you need additional information or have any |
attila@90 | 23 | * questions. |
attila@90 | 24 | */ |
attila@90 | 25 | |
attila@90 | 26 | /* |
attila@90 | 27 | * This file is available under and governed by the GNU General Public |
attila@90 | 28 | * License version 2 only, as published by the Free Software Foundation. |
attila@90 | 29 | * However, the following notice accompanied the original version of this |
attila@90 | 30 | * file, and Oracle licenses the original version of this file under the BSD |
attila@90 | 31 | * license: |
attila@90 | 32 | */ |
attila@90 | 33 | /* |
attila@90 | 34 | Copyright 2009-2013 Attila Szegedi |
attila@90 | 35 | |
attila@90 | 36 | Licensed under both the Apache License, Version 2.0 (the "Apache License") |
attila@90 | 37 | and the BSD License (the "BSD License"), with licensee being free to |
attila@90 | 38 | choose either of the two at their discretion. |
attila@90 | 39 | |
attila@90 | 40 | You may not use this file except in compliance with either the Apache |
attila@90 | 41 | License or the BSD License. |
attila@90 | 42 | |
attila@90 | 43 | If you choose to use this file in compliance with the Apache License, the |
attila@90 | 44 | following notice applies to you: |
attila@90 | 45 | |
attila@90 | 46 | You may obtain a copy of the Apache License at |
attila@90 | 47 | |
attila@90 | 48 | http://www.apache.org/licenses/LICENSE-2.0 |
attila@90 | 49 | |
attila@90 | 50 | Unless required by applicable law or agreed to in writing, software |
attila@90 | 51 | distributed under the License is distributed on an "AS IS" BASIS, |
attila@90 | 52 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or |
attila@90 | 53 | implied. See the License for the specific language governing |
attila@90 | 54 | permissions and limitations under the License. |
attila@90 | 55 | |
attila@90 | 56 | If you choose to use this file in compliance with the BSD License, the |
attila@90 | 57 | following notice applies to you: |
attila@90 | 58 | |
attila@90 | 59 | Redistribution and use in source and binary forms, with or without |
attila@90 | 60 | modification, are permitted provided that the following conditions are |
attila@90 | 61 | met: |
attila@90 | 62 | * Redistributions of source code must retain the above copyright |
attila@90 | 63 | notice, this list of conditions and the following disclaimer. |
attila@90 | 64 | * Redistributions in binary form must reproduce the above copyright |
attila@90 | 65 | notice, this list of conditions and the following disclaimer in the |
attila@90 | 66 | documentation and/or other materials provided with the distribution. |
attila@90 | 67 | * Neither the name of the copyright holder nor the names of |
attila@90 | 68 | contributors may be used to endorse or promote products derived from |
attila@90 | 69 | this software without specific prior written permission. |
attila@90 | 70 | |
attila@90 | 71 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS |
attila@90 | 72 | IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED |
attila@90 | 73 | TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A |
attila@90 | 74 | PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER |
attila@90 | 75 | BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
attila@90 | 76 | CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
attila@90 | 77 | SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR |
attila@90 | 78 | BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, |
attila@90 | 79 | WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR |
attila@90 | 80 | OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF |
attila@90 | 81 | ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
attila@90 | 82 | */ |
attila@90 | 83 | |
attila@90 | 84 | package jdk.internal.dynalink; |
attila@90 | 85 | |
attila@90 | 86 | import java.lang.invoke.MethodHandles.Lookup; |
attila@90 | 87 | import java.lang.invoke.MethodType; |
attila@90 | 88 | import jdk.internal.dynalink.support.CallSiteDescriptorFactory; |
attila@90 | 89 | |
attila@90 | 90 | /** |
attila@90 | 91 | * An immutable descriptor of a call site. It is an immutable object that contains all the information about a call |
attila@90 | 92 | * site: the class performing the lookups, the name of the method being invoked, and the method signature. The library |
attila@90 | 93 | * has a default {@link CallSiteDescriptorFactory} for descriptors that you can use, or you can create your own |
attila@90 | 94 | * descriptor classes, especially if you need to add further information (values passed in additional parameters to the |
attila@90 | 95 | * bootstrap method) to them. Call site descriptors are used in this library in place of passing a real call site to |
attila@90 | 96 | * guarding linkers so they aren't tempted to directly manipulate the call sites. The constructors of built-in |
attila@90 | 97 | * {@link RelinkableCallSite} implementations all need a call site descriptor. Even if you create your own call site |
attila@90 | 98 | * descriptors consider using {@link CallSiteDescriptorFactory#tokenizeName(String)} in your implementation. |
attila@90 | 99 | * |
attila@90 | 100 | * @author Attila Szegedi |
attila@90 | 101 | */ |
attila@90 | 102 | public interface CallSiteDescriptor { |
attila@90 | 103 | /** |
attila@90 | 104 | * The index of the name token that will carry the operation scheme prefix (usually, "dyn"). |
attila@90 | 105 | */ |
attila@90 | 106 | public static final int SCHEME = 0; |
attila@90 | 107 | /** |
attila@90 | 108 | * The index of the name token that will usually carry the operation name. |
attila@90 | 109 | */ |
attila@90 | 110 | |
attila@90 | 111 | public static final int OPERATOR=1; |
attila@90 | 112 | /** |
attila@90 | 113 | * The index of the name token that will usually carry a name of an operand (of a property, method, etc.) |
attila@90 | 114 | */ |
attila@90 | 115 | |
attila@90 | 116 | public static final int NAME_OPERAND=2; |
attila@90 | 117 | |
attila@90 | 118 | /** |
attila@90 | 119 | * Character used to delimit tokens in an call site name. |
attila@90 | 120 | */ |
attila@90 | 121 | public static final String TOKEN_DELIMITER = ":"; |
attila@90 | 122 | |
attila@90 | 123 | /** |
attila@90 | 124 | * Character used to delimit operation names in a composite operation specification. |
attila@90 | 125 | */ |
attila@90 | 126 | public static final String OPERATOR_DELIMITER = "|"; |
attila@90 | 127 | |
attila@90 | 128 | /** |
attila@90 | 129 | * Returns the number of tokens in the name of the method at the call site. Method names are tokenized with the |
attila@90 | 130 | * colon ":" character, i.e. "dyn:getProp:color" would be the name used to describe a method that retrieves the |
attila@90 | 131 | * property named "color" on the object it is invoked on. |
attila@90 | 132 | * @return the number of tokens in the name of the method at the call site. |
attila@90 | 133 | */ |
attila@90 | 134 | public int getNameTokenCount(); |
attila@90 | 135 | |
attila@90 | 136 | /** |
attila@90 | 137 | * Returns the <i>i<sup>th</sup></i> token in the method name at the call site. Method names are tokenized with the |
attila@90 | 138 | * colon ":" character. |
attila@90 | 139 | * @param i the index of the token. Must be between 0 (inclusive) and {@link #getNameTokenCount()} (exclusive) |
attila@90 | 140 | * @throws IllegalArgumentException if the index is outside the allowed range. |
attila@90 | 141 | * @return the <i>i<sup>th</sup></i> token in the method name at the call site. The returned strings are interned. |
attila@90 | 142 | */ |
attila@90 | 143 | public String getNameToken(int i); |
attila@90 | 144 | |
attila@90 | 145 | /** |
attila@90 | 146 | * Returns the name of the method at the call site. Note that the object internally only stores the tokenized name, |
attila@90 | 147 | * and has to reconstruct the full name from tokens on each invocation. |
attila@90 | 148 | * @return the name of the method at the call site. |
attila@90 | 149 | */ |
attila@90 | 150 | public String getName(); |
attila@90 | 151 | |
attila@90 | 152 | /** |
attila@90 | 153 | * The type of the method at the call site. |
attila@90 | 154 | * |
attila@90 | 155 | * @return type of the method at the call site. |
attila@90 | 156 | */ |
attila@90 | 157 | public MethodType getMethodType(); |
attila@90 | 158 | |
attila@90 | 159 | /** |
attila@90 | 160 | * Returns the lookup passed to the bootstrap method. |
attila@90 | 161 | * @return the lookup passed to the bootstrap method. |
attila@90 | 162 | */ |
attila@90 | 163 | public Lookup getLookup(); |
attila@90 | 164 | |
attila@90 | 165 | /** |
attila@90 | 166 | * Creates a new call site descriptor from this descriptor, which is identical to this, except it changes the method |
attila@90 | 167 | * type. |
attila@90 | 168 | * |
attila@90 | 169 | * @param newMethodType the new method type |
attila@90 | 170 | * @return a new call site descriptor, with the method type changed. |
attila@90 | 171 | */ |
attila@90 | 172 | public CallSiteDescriptor changeMethodType(MethodType newMethodType); |
attila@90 | 173 | |
attila@101 | 174 | } |