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    Licensed under both the Apache License, Version 2.0 (the "Apache License")

    37    and the BSD License (the "BSD License"), with licensee being free to

    38    choose either of the two at their discretion.

    39 

    40    You may not use this file except in compliance with either the Apache

    41    License or the BSD License.

    42 

    43    If you choose to use this file in compliance with the Apache License, the

    44    following notice applies to you:

    45 

    46        You may obtain a copy of the Apache License at

    47 

    48            http://www.apache.org/licenses/LICENSE-2.0

    49 

    50        Unless required by applicable law or agreed to in writing, software

    51        distributed under the License is distributed on an "AS IS" BASIS,

    52        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or

    53        implied. See the License for the specific language governing

    54        permissions and limitations under the License.

    55 

    56    If you choose to use this file in compliance with the BSD License, the

    57    following notice applies to you:

    58 

    59        Redistribution and use in source and binary forms, with or without

    60        modification, are permitted provided that the following conditions are

    61        met:

    62        * Redistributions of source code must retain the above copyright

    63          notice, this list of conditions and the following disclaimer.

    64        * Redistributions in binary form must reproduce the above copyright

    65          notice, this list of conditions and the following disclaimer in the

    66          documentation and/or other materials provided with the distribution.

    67        * Neither the name of the copyright holder nor the names of

    68          contributors may be used to endorse or promote products derived from

    69          this software without specific prior written permission.

    70 

    71        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS

    72        IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED

    73        TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A

    74        PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER

    75        BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR

    76        CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

    77        SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR

    78        BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,

    79        WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR

    80        OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF

    81        ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    82 */

    83 

    84 package jdk.internal.dynalink;

    85 

    86 import java.lang.invoke.MethodHandles.Lookup;

    87 import java.lang.invoke.MethodType;

    88 import jdk.internal.dynalink.support.CallSiteDescriptorFactory;

    89 

    90 

    91 /**

    92  * An immutable descriptor of a call site. It is an immutable object that contains all the information about a call

    93  * site: the class performing the lookups, the name of the method being invoked, and the method signature. The library

    94  * has a default {@link CallSiteDescriptorFactory} for descriptors that you can use, or you can create your own

    95  * descriptor classes, especially if you need to add further information (values passed in additional parameters to the

    96  * bootstrap method) to them. Call site descriptors are used in this library in place of passing a real call site to

    97  * guarding linkers so they aren't tempted to directly manipulate the call sites. The constructors of built-in

    98  * {@link RelinkableCallSite} implementations all need a call site descriptor. Even if you create your own call site

    99  * descriptors consider using {@link CallSiteDescriptorFactory#tokenizeName(String)} in your implementation.

   100  *

   101  * @author Attila Szegedi

   102  */

   103 public interface CallSiteDescriptor {

   104     /**

   105      * The index of the name token that will carry the operation scheme prefix (usually, "dyn").

   106      */

   107     public static final int SCHEME = 0;

   108     /**

   109      * The index of the name token that will usually carry the operation name.

   110      */

   111 

   112     public static final int OPERATOR=1;

   113     /**

   114      * The index of the name token that will usually carry a name of an operand (of a property, method, etc.)

   115      */

   116 

   117     public static final int NAME_OPERAND=2;

   118 

   119     /**

   120      * Character used to delimit tokens in an call site name.

   121      */

   122     public static final String TOKEN_DELIMITER = ":";

   123 

   124     /**

   125      * Character used to delimit operation names in a composite operation specification.

   126      */

   127     public static final String OPERATOR_DELIMITER = "|";

   128 

   129     /**

   130      * Returns the number of tokens in the name of the method at the call site. Method names are tokenized with the

   131      * colon ":" character, i.e. "dyn:getProp:color" would be the name used to describe a method that retrieves the

   132      * property named "color" on the object it is invoked on.

   133      * @return the number of tokens in the name of the method at the call site.

   134      */

   135     public int getNameTokenCount();

   136 

   137     /**

   138      * Returns the <i>i<sup>th</sup></i> token in the method name at the call site. Method names are tokenized with the

   139      * colon ":" character.

   140      * @param i the index of the token. Must be between 0 (inclusive) and {@link #getNameTokenCount()} (exclusive)

   141      * @throws IllegalArgumentException if the index is outside the allowed range.

   142      * @return the <i>i<sup>th</sup></i> token in the method name at the call site. The returned strings are interned.

   143      */

   144     public String getNameToken(int i);

   145 

   146     /**

   147      * Returns the name of the method at the call site. Note that the object internally only stores the tokenized name,

   148      * and has to reconstruct the full name from tokens on each invocation.

   149      * @return the name of the method at the call site.

   150      */

   151     public String getName();

   152 

   153     /**

   154      * The type of the method at the call site.

   155      *

   156      * @return type of the method at the call site.

   157      */

   158     public MethodType getMethodType();

   159 

   160     /**

   161      * Returns the lookup passed to the bootstrap method.

   162      * @return the lookup passed to the bootstrap method.

   163      */

   164     public Lookup getLookup();

   165 

   166     /**

   167      * Creates a new call site descriptor from this descriptor, which is identical to this, except it changes the method

   168      * type.

   169      *

   170      * @param newMethodType the new method type

   171      * @return a new call site descriptor, with the method type changed.

   172      */

   173     public CallSiteDescriptor changeMethodType(MethodType newMethodType);

   174 

   175 }