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    
018    package org.apache.commons.proxy;
019    
020    import java.lang.reflect.Method;
021    
022    /**
023     * Represents a method invocation.
024     *
025     * @author James Carman
026     * @since 1.0
027     */
028    public interface Invocation
029    {
030    //**********************************************************************************************************************
031    // Other Methods
032    //**********************************************************************************************************************
033    
034        /**
035         * Returns the arguments being passed to this method invocation.  Changes in the elements of this array will be
036         * propagated to the recipient of this invocation.
037         *
038         * @return the arguments being passed to this method invocation
039         */
040        public Object[] getArguments();
041    
042        /**
043         * Returns the method being called.
044         *
045         * @return the method being called
046         */
047        public Method getMethod();
048    
049        /**
050         * Returns the proxy object on which this invocation was invoked.
051         *
052         * @return the proxy object on which this invocation was invoked
053         */
054        public Object getProxy();
055    
056        /**
057         * Called in order to let the invocation proceed.
058         *
059         * @return the return value of the invocation
060         * @throws Throwable any exception or error that was thrown as a result of this invocation
061         */
062        public Object proceed() throws Throwable;
063    }