nashorn/src/jdk.scripting.nashorn/share/classes/jdk/internal/dynalink/linker/GuardedTypeConversion.java
author attila
Mon, 19 Oct 2015 08:45:29 +0200
changeset 33333 0bad500ce4e0
parent 32534 b3ec7f3b3c2a
permissions -rw-r--r--
8139590: Improve Dynalink JavaDoc Reviewed-by: hannesw, lagergren
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
22669
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
     1
/*
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
     2
 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
     4
 *
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    10
 *
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    15
 * accompanied this code).
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    16
 *
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    20
 *
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    23
 * questions.
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    24
 */
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    25
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    26
/*
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    27
 * This file is available under and governed by the GNU General Public
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    28
 * License version 2 only, as published by the Free Software Foundation.
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    29
 * However, the following notice accompanied the original version of this
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    30
 * file, and Oracle licenses the original version of this file under the BSD
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    31
 * license:
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    32
 */
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    33
/*
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    34
   Copyright 2009-2013 Attila Szegedi
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    35
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    36
   Licensed under both the Apache License, Version 2.0 (the "Apache License")
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    37
   and the BSD License (the "BSD License"), with licensee being free to
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    38
   choose either of the two at their discretion.
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    39
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    40
   You may not use this file except in compliance with either the Apache
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    41
   License or the BSD License.
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    42
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    43
   If you choose to use this file in compliance with the Apache License, the
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    44
   following notice applies to you:
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    45
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    46
       You may obtain a copy of the Apache License at
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    47
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    48
           http://www.apache.org/licenses/LICENSE-2.0
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    49
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    50
       Unless required by applicable law or agreed to in writing, software
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    51
       distributed under the License is distributed on an "AS IS" BASIS,
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    52
       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    53
       implied. See the License for the specific language governing
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    54
       permissions and limitations under the License.
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    55
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    56
   If you choose to use this file in compliance with the BSD License, the
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    57
   following notice applies to you:
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    58
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    59
       Redistribution and use in source and binary forms, with or without
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    60
       modification, are permitted provided that the following conditions are
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    61
       met:
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    62
       * Redistributions of source code must retain the above copyright
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    63
         notice, this list of conditions and the following disclaimer.
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    64
       * Redistributions in binary form must reproduce the above copyright
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    65
         notice, this list of conditions and the following disclaimer in the
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    66
         documentation and/or other materials provided with the distribution.
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    67
       * Neither the name of the copyright holder nor the names of
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    68
         contributors may be used to endorse or promote products derived from
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    69
         this software without specific prior written permission.
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    70
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    71
       THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    72
       IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    73
       TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    74
       PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    75
       BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    76
       CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    77
       SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    78
       BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    79
       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    80
       OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    81
       ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    82
*/
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    83
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    84
package jdk.internal.dynalink.linker;
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    85
33333
0bad500ce4e0 8139590: Improve Dynalink JavaDoc
attila
parents: 32534
diff changeset
    86
24720
75f8388b79df 8035836: Array performance improvements
lagergren
parents: 22669
diff changeset
    87
/**
33333
0bad500ce4e0 8139590: Improve Dynalink JavaDoc
attila
parents: 32534
diff changeset
    88
 * A tuple of a {@link GuardedInvocation} describing a conditional type
0bad500ce4e0 8139590: Improve Dynalink JavaDoc
attila
parents: 32534
diff changeset
    89
 * conversion and a boolean flag indicating whether the result is allowed to
0bad500ce4e0 8139590: Improve Dynalink JavaDoc
attila
parents: 32534
diff changeset
    90
 * be cached. While most type conversions are cacheable, some can have security
0bad500ce4e0 8139590: Improve Dynalink JavaDoc
attila
parents: 32534
diff changeset
    91
 * implications. An example is converting e.g. function objects from the source
0bad500ce4e0 8139590: Improve Dynalink JavaDoc
attila
parents: 32534
diff changeset
    92
 * language into implementations of Java functional interface objects, with
0bad500ce4e0 8139590: Improve Dynalink JavaDoc
attila
parents: 32534
diff changeset
    93
 * adapter classes for those interfaces being created on the fly and being
0bad500ce4e0 8139590: Improve Dynalink JavaDoc
attila
parents: 32534
diff changeset
    94
 * sensitive to the protection domain of their creator. Such converter
0bad500ce4e0 8139590: Improve Dynalink JavaDoc
attila
parents: 32534
diff changeset
    95
 * invocation must be marked as non-cacheable so that Dynalink will know not to
0bad500ce4e0 8139590: Improve Dynalink JavaDoc
attila
parents: 32534
diff changeset
    96
 * keep and reuse them in different contexts.
24720
75f8388b79df 8035836: Array performance improvements
lagergren
parents: 22669
diff changeset
    97
 */
22669
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    98
public class GuardedTypeConversion {
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
    99
    private final GuardedInvocation conversionInvocation;
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
   100
    private final boolean cacheable;
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
   101
24720
75f8388b79df 8035836: Array performance improvements
lagergren
parents: 22669
diff changeset
   102
    /**
33333
0bad500ce4e0 8139590: Improve Dynalink JavaDoc
attila
parents: 32534
diff changeset
   103
     * Creates a new guarded type conversion.
0bad500ce4e0 8139590: Improve Dynalink JavaDoc
attila
parents: 32534
diff changeset
   104
     * @param conversionInvocation guarded invocation implementing this type
0bad500ce4e0 8139590: Improve Dynalink JavaDoc
attila
parents: 32534
diff changeset
   105
     * conversion.
0bad500ce4e0 8139590: Improve Dynalink JavaDoc
attila
parents: 32534
diff changeset
   106
     * @param cacheable true if this invocation is cacheable, false otherwise.
24720
75f8388b79df 8035836: Array performance improvements
lagergren
parents: 22669
diff changeset
   107
     */
22669
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
   108
    public GuardedTypeConversion(final GuardedInvocation conversionInvocation, final boolean cacheable) {
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
   109
        this.conversionInvocation = conversionInvocation;
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
   110
        this.cacheable = cacheable;
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
   111
    }
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
   112
24720
75f8388b79df 8035836: Array performance improvements
lagergren
parents: 22669
diff changeset
   113
    /**
33333
0bad500ce4e0 8139590: Improve Dynalink JavaDoc
attila
parents: 32534
diff changeset
   114
     * Returns the invocation implementing the type conversion.
0bad500ce4e0 8139590: Improve Dynalink JavaDoc
attila
parents: 32534
diff changeset
   115
     * @return the invocation implementing the type conversion.
24720
75f8388b79df 8035836: Array performance improvements
lagergren
parents: 22669
diff changeset
   116
     */
22669
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
   117
    public GuardedInvocation getConversionInvocation() {
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
   118
        return conversionInvocation;
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
   119
    }
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
   120
24720
75f8388b79df 8035836: Array performance improvements
lagergren
parents: 22669
diff changeset
   121
    /**
33333
0bad500ce4e0 8139590: Improve Dynalink JavaDoc
attila
parents: 32534
diff changeset
   122
     * Returns true if this conversion is allowed to be cached and reused by
0bad500ce4e0 8139590: Improve Dynalink JavaDoc
attila
parents: 32534
diff changeset
   123
     * Dynalink.
0bad500ce4e0 8139590: Improve Dynalink JavaDoc
attila
parents: 32534
diff changeset
   124
     * @return true if this conversion is allowed to be cached and reused by
0bad500ce4e0 8139590: Improve Dynalink JavaDoc
attila
parents: 32534
diff changeset
   125
     * Dynalink.
24720
75f8388b79df 8035836: Array performance improvements
lagergren
parents: 22669
diff changeset
   126
     */
22669
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
   127
    public boolean isCacheable() {
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
   128
        return cacheable;
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
   129
    }
75563515567f 8032681: Issues with Nashorn
attila
parents:
diff changeset
   130
}