1 /*

     2  * Copyright (c) 2015, 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 2015 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 /**

    87  * Defines the standard dynamic operations. Getter and setter operations defined

    88  * in this enumeration can be composed into a {@link CompositeOperation}, and

    89  * {@link NamedOperation} can be used to bind the name parameter of operations

    90  * that take one, in which case it disappears from the type signature.

    91  */

    92 public enum StandardOperation implements Operation {

    93     /**

    94      * Get the value of a property defined on an object. Call sites with this

    95      * operation should have a signature of

    96      * <tt>(receiver,&nbsp;propertyName)&rarr;value</tt> or

    97      * <tt>(receiver)&rarr;value</tt> when used with {@link NamedOperation}, with

    98      * all parameters and return type being of any type (either primitive or

    99      * reference).

   100      */

   101     GET_PROPERTY,

   102     /**

   103      * Set the value of a property defined on an object. Call sites with this

   104      * operation should have a signature of

   105      * <tt>(receiver,&nbsp;propertyName,&nbsp;value)&rarr;void</tt> or

   106      * <tt>(receiver,&nbsp;value)&rarr;void</tt> when used with {@link NamedOperation},

   107      * with all parameters and return type being of any type (either primitive

   108      * or reference).

   109      */

   110     SET_PROPERTY,

   111     /**

   112      * Get the value of an element of a collection. Call sites with this

   113      * operation should have a signature of

   114      * <tt>(receiver,&nbsp;index)&rarr;value</tt> or

   115      * <tt>(receiver)&rarr;value</tt> when used with {@link NamedOperation}, with

   116      * all parameters and return type being of any type (either primitive or

   117      * reference).

   118      */

   119     GET_ELEMENT,

   120     /**

   121      * Set the value of an element of a collection. Call sites with this

   122      * operation should have a signature of

   123      * <tt>(receiver,&nbsp;index,&nbsp;value)&rarr;void</tt> or

   124      * <tt>(receiver,&nbsp;value)&rarr;void</tt> when used with {@link NamedOperation},

   125      * with all parameters and return type being of any type (either primitive

   126      * or reference).

   127      */

   128     SET_ELEMENT,

   129     /**

   130      * Get the length of an array of size of a collection. Call sites with

   131      * this operation should have a signature of <tt>(receiver)&rarr;value</tt>,

   132      * with all parameters and return type being of any type (either primitive

   133      * or reference).

   134      */

   135     GET_LENGTH,

   136     /**

   137      * Gets an object representing a method defined on an object. Call sites

   138      * with this operation should have a signature of

   139      * <tt>(receiver,&nbsp;methodName)&rarr;value</tt>, or

   140      * <tt>(receiver)&rarr;value</tt> when used with {@link NamedOperation}

   141      * with all parameters and return type being of any type (either primitive

   142      * or reference).

   143      */

   144     GET_METHOD,

   145     /**

   146      * Calls a method defined on an object. Call sites with this

   147      * operation should have a signature of

   148      * <tt>(receiver,&nbsp;methodName,&nbsp;arguments...)&rarr;value</tt> or

   149      * <tt>(receiver,&nbsp;arguments...)&rarr;value</tt> when used with {@link NamedOperation},

   150      * with all parameters and return type being of any type (either primitive

   151      * or reference).

   152      */

   153     CALL_METHOD,

   154     /**

   155      * Calls a callable object. Call sites with this operation should have a

   156      * signature of <tt>(receiver,&nbsp;arguments...)&rarr;value</tt>, with all

   157      * parameters and return type being of any type (either primitive or

   158      * reference). Typically, if the callable is a method of an object, the

   159      * first argument will act as the "this" value passed to the called method.

   160      * The <tt>CALL</tt> operation is allowed to be used with a

   161      * {@link NamedOperation} even though it does not take a name. Using it with

   162      * a named operation won't affect its signature; the name is solely meant to

   163      * be used as a diagnostic description for error messages.

   164      */

   165     CALL,

   166     /**

   167      * Calls a constructor object. Call sites with this operation should have a

   168      * signature of <tt>(receiver,&nbsp;arguments...)&rarr;value</tt>, with all

   169      * parameters and return type being of any type (either primitive or

   170      * reference). The <tt>NEW</tt> operation is allowed to be used with a

   171      * {@link NamedOperation} even though it does not take a name. Using it with

   172      * a named operation won't affect its signature; the name is solely meant to

   173      * be used as a diagnostic description for error messages.

   174      */

   175     NEW

   176 }