src/jdk.dynalink/share/classes/jdk/dynalink/linker/package-info.java
author phh
Sat, 30 Nov 2019 14:33:05 -0800
changeset 59330 5b96c12f909d
parent 50695 36ca515343e0
permissions -rw-r--r--
8234541: C1 emits an empty message when it inlines successfully Summary: Use "inline" as the message when successfull Reviewed-by: thartmann, mdoerr Contributed-by: navy.xliu@gmail.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33339
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
     1
/*
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
     2
 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
     4
 *
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    10
 *
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    15
 * accompanied this code).
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    16
 *
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    20
 *
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    23
 * questions.
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    24
 */
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    25
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    26
/*
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    27
 * This file is available under and governed by the GNU General Public
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    28
 * License version 2 only, as published by the Free Software Foundation.
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    29
 * However, the following notice accompanied the original version of this
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    30
 * file, and Oracle licenses the original version of this file under the BSD
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    31
 * license:
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    32
 */
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    33
/*
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    34
   Copyright 2009-2013 Attila Szegedi
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    35
50695
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    36
   Redistribution and use in source and binary forms, with or without
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    37
   modification, are permitted provided that the following conditions are
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    38
   met:
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    39
   * Redistributions of source code must retain the above copyright
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    40
     notice, this list of conditions and the following disclaimer.
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    41
   * Redistributions in binary form must reproduce the above copyright
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    42
     notice, this list of conditions and the following disclaimer in the
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    43
     documentation and/or other materials provided with the distribution.
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    44
   * Neither the name of the copyright holder nor the names of
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    45
     contributors may be used to endorse or promote products derived from
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    46
     this software without specific prior written permission.
33339
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    47
50695
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    48
   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    49
   IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    50
   TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    51
   PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    52
   BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    53
   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    54
   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    55
   BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    56
   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    57
   OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
36ca515343e0 8203637: Fix Sources
jlaskey
parents: 47216
diff changeset
    58
   ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33339
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    59
*/
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    60
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    61
/**
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    62
 * <p>
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    63
 * Contains interfaces and classes needed by language runtimes to implement
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    64
 * their own language-specific object models and type conversions. The main
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    65
 * entry point is the
34447
ec4c069f9436 8141338: Move jdk.internal.dynalink package to jdk.dynalink
attila
parents: 33339
diff changeset
    66
 * {@link jdk.dynalink.linker.GuardingDynamicLinker} interface. It needs to be
33339
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    67
 * implemented in order to provide linking for the runtime's own object model.
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    68
 * A language runtime can have more than one guarding dynamic linker
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    69
 * implementation. When a runtime is configuring Dynalink for itself, it will
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    70
 * normally set these guarding linkers as the prioritized linkers in its
34447
ec4c069f9436 8141338: Move jdk.internal.dynalink package to jdk.dynalink
attila
parents: 33339
diff changeset
    71
 * {@link jdk.dynalink.DynamicLinkerFactory} (and maybe some of them as fallback
33339
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    72
 * linkers, for e.g. handling "method not found" and similar errors in a
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    73
 * language-specific manner if no other linker managed to handle the operation.)
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    74
 * </p><p>
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    75
 * A language runtime that wishes to make at least some of its linkers available
39792
3ed4aa54785e 8161928: Dynalink documentation updates
attila
parents: 35325
diff changeset
    76
 * to other language runtimes for interoperability will need to use a
3ed4aa54785e 8161928: Dynalink documentation updates
attila
parents: 35325
diff changeset
    77
 * {@link jdk.dynalink.linker.GuardingDynamicLinkerExporter}.
33339
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    78
 * </p><p>
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    79
 * Most language runtimes will be able to implement their own linking logic by
34447
ec4c069f9436 8141338: Move jdk.internal.dynalink package to jdk.dynalink
attila
parents: 33339
diff changeset
    80
 * implementing {@link jdk.dynalink.linker.TypeBasedGuardingDynamicLinker}
ec4c069f9436 8141338: Move jdk.internal.dynalink package to jdk.dynalink
attila
parents: 33339
diff changeset
    81
 * instead of {@link jdk.dynalink.linker.GuardingDynamicLinker}; it allows for
33339
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    82
 * faster type-based linking dispatch.
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    83
 * </p><p>
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    84
 * Language runtimes that allow type conversions other than those provided by
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    85
 * Java will need to have their guarding dynamic linker (or linkers) also
34447
ec4c069f9436 8141338: Move jdk.internal.dynalink package to jdk.dynalink
attila
parents: 33339
diff changeset
    86
 * implement the {@link jdk.dynalink.linker.GuardingTypeConverterFactory}
33339
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    87
 * interface to provide the logic for these conversions.
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    88
 * </p>
35325
7624a7d7e661 8136494: Update "@since 1.9" to "@since 9" to match java.version.specification
iris
parents: 34903
diff changeset
    89
 * @since 9
33339
334cd3ebfa5e 8139888: Improve Dynalink JavaDoc some more
attila
parents: 25865
diff changeset
    90
 */
34447
ec4c069f9436 8141338: Move jdk.internal.dynalink package to jdk.dynalink
attila
parents: 33339
diff changeset
    91
package jdk.dynalink.linker;