/*

 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

/*

 * This file is available under and governed by the GNU General Public

 * License version 2 only, as published by the Free Software Foundation.

 * However, the following notice accompanied the original version of this

 * file, and Oracle licenses the original version of this file under the BSD

 * license:

 */

/*

   Copyright 2009-2013 Attila Szegedi

*/

package jdk.dynalink.linker;

import jdk.dynalink.CallSiteDescriptor;

import jdk.dynalink.DynamicLinker;

import jdk.dynalink.DynamicLinkerFactory;

/**

 * Represents a request to link a particular invocation at a particular call

 * site. Instances of these requests will be constructed and passed to all

 * {@link GuardingDynamicLinker} objects managed by the {@link DynamicLinker}

 * that is trying to link the call site.

 */

public interface LinkRequest {

    /**

     * Returns the call site descriptor for the call site being linked.

     *

     * @return the call site descriptor for the call site being linked.

     */

    public CallSiteDescriptor getCallSiteDescriptor();

    /**

     * Returns the arguments for the invocation being linked. The returned array

     * must be a clone; modifications to it must not affect the arguments in

     * this request.

     *

     * @return the arguments for the invocation being linked.

     */

    public Object[] getArguments();

    /**

     * Returns the first argument for the invocation being linked; this is

     * typically the receiver object. This is a shorthand for

     * {@code getArguments()[0]} that also avoids the cloning of the arguments

     * array.

     *

     * @return the receiver object.

     */

    public Object getReceiver();

    /**

     * Returns true if the call site is considered unstable, that is, it has been relinked more times than was

     * specified in {@link DynamicLinkerFactory#setUnstableRelinkThreshold(int)}. Linkers should use this as a

     * hint to prefer producing linkage that is more stable (its guard fails less frequently), even if that assumption

     * causes a less effective version of an operation to be linked. This is just a hint, though, and linkers are

     * allowed to ignore this property.

     * @return true if the call site is considered unstable.

     */

    public boolean isCallSiteUnstable();

    /**

     * Returns a request identical to this one with call site descriptor and arguments replaced with the ones specified.

     *

     * @param callSiteDescriptor the new call site descriptor

     * @param arguments the new arguments

     * @return a new request identical to this one, except with the call site descriptor and arguments replaced with the

     * specified ones.

     */

    public LinkRequest replaceArguments(CallSiteDescriptor callSiteDescriptor, Object... arguments);

}