Mercurial > jdk8-mips64-public > nashorn / file comparison

comparison: src/jdk/internal/dynalink/CallSiteDescriptor.java

src/jdk/internal/dynalink/CallSiteDescriptor.java

changeset 0
b1a7da25b547
child 952
6d5471a497fb
equal deleted inserted replaced
-1:000000000000 0:b1a7da25b547
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 * An immutable descriptor of a call site. It is an immutable object that contains all the information about a call
92 * site: the class performing the lookups, the name of the method being invoked, and the method signature. The library
93 * has a default {@link CallSiteDescriptorFactory} for descriptors that you can use, or you can create your own
94 * descriptor classes, especially if you need to add further information (values passed in additional parameters to the
95 * bootstrap method) to them. Call site descriptors are used in this library in place of passing a real call site to
96 * guarding linkers so they aren't tempted to directly manipulate the call sites. The constructors of built-in
97 * {@link RelinkableCallSite} implementations all need a call site descriptor. Even if you create your own call site
98 * descriptors consider using {@link CallSiteDescriptorFactory#tokenizeName(String)} in your implementation.
99 *
100 * @author Attila Szegedi
101 */
102 public interface CallSiteDescriptor {
103 /**
104 * The index of the name token that will carry the operation scheme prefix (usually, "dyn").
105 */
106 public static final int SCHEME = 0;
107 /**
108 * The index of the name token that will usually carry the operation name.
109 */
110
111 public static final int OPERATOR=1;
112 /**
113 * The index of the name token that will usually carry a name of an operand (of a property, method, etc.)
114 */
115
116 public static final int NAME_OPERAND=2;
117
118 /**
119 * Character used to delimit tokens in an call site name.
120 */
121 public static final String TOKEN_DELIMITER = ":";
122
123 /**
124 * Character used to delimit operation names in a composite operation specification.
125 */
126 public static final String OPERATOR_DELIMITER = "|";
127
128 /**
129 * Returns the number of tokens in the name of the method at the call site. Method names are tokenized with the
130 * colon ":" character, i.e. "dyn:getProp:color" would be the name used to describe a method that retrieves the
131 * property named "color" on the object it is invoked on.
132 * @return the number of tokens in the name of the method at the call site.
133 */
134 public int getNameTokenCount();
135
136 /**
137 * Returns the <i>i<sup>th</sup></i> token in the method name at the call site. Method names are tokenized with the
138 * colon ":" character.
139 * @param i the index of the token. Must be between 0 (inclusive) and {@link #getNameTokenCount()} (exclusive)
140 * @throws IllegalArgumentException if the index is outside the allowed range.
141 * @return the <i>i<sup>th</sup></i> token in the method name at the call site. The returned strings are interned.
142 */
143 public String getNameToken(int i);
144
145 /**
146 * Returns the name of the method at the call site. Note that the object internally only stores the tokenized name,
147 * and has to reconstruct the full name from tokens on each invocation.
148 * @return the name of the method at the call site.
149 */
150 public String getName();
151
152 /**
153 * The type of the method at the call site.
154 *
155 * @return type of the method at the call site.
156 */
157 public MethodType getMethodType();
158
159 /**
160 * Returns the lookup passed to the bootstrap method.
161 * @return the lookup passed to the bootstrap method.
162 */
163 public Lookup getLookup();
164
165 /**
166 * Creates a new call site descriptor from this descriptor, which is identical to this, except it changes the method
167 * type.
168 *
169 * @param newMethodType the new method type
170 * @return a new call site descriptor, with the method type changed.
171 */
172 public CallSiteDescriptor changeMethodType(MethodType newMethodType);
173
174 }

Mercurial Repository: jdk8-mips64-public/nashorn

mercurial