001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.proxy2;
019
020import java.lang.reflect.Method;
021
022/**
023 * Method invocation for use by an {@link Interceptor}.
024 * 
025 * @since 1.0
026 */
027public interface Invocation
028{
029    //******************************************************************************************************************
030    // Other Methods
031    //******************************************************************************************************************
032
033    /**
034     * Returns the arguments being passed to this method invocation. Changes in the elements of this array will be
035     * propagated to the recipient of this invocation.
036     * 
037     * @return the arguments being passed to this method invocation
038     */
039    Object[] getArguments();
040
041    /**
042     * Returns the method being called.
043     * 
044     * @return the method being called
045     */
046    Method getMethod();
047
048    /**
049     * Returns the proxy object on which this invocation was invoked.
050     * 
051     * @return the proxy object on which this invocation was invoked
052     */
053    Object getProxy();
054
055    /**
056     * Called in order to let the invocation proceed.
057     * 
058     * @return the return value of the invocation
059     * @throws Throwable
060     *             any exception or error that was thrown as a result of this invocation
061     */
062    Object proceed() throws Throwable;
063}