1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.proxy2;
19  
20  import java.lang.reflect.Method;
21  
22  /**
23   * Method invocation for use by an {@link Interceptor}.
24   * 
25   * @since 1.0
26   */
27  public interface Invocation
28  {
29      //******************************************************************************************************************
30      // Other Methods
31      //******************************************************************************************************************
32  
33      /**
34       * Returns the arguments being passed to this method invocation. Changes in the elements of this array will be
35       * propagated to the recipient of this invocation.
36       * 
37       * @return the arguments being passed to this method invocation
38       */
39      Object[] getArguments();
40  
41      /**
42       * Returns the method being called.
43       * 
44       * @return the method being called
45       */
46      Method getMethod();
47  
48      /**
49       * Returns the proxy object on which this invocation was invoked.
50       * 
51       * @return the proxy object on which this invocation was invoked
52       */
53      Object getProxy();
54  
55      /**
56       * Called in order to let the invocation proceed.
57       * 
58       * @return the return value of the invocation
59       * @throws Throwable
60       *             any exception or error that was thrown as a result of this invocation
61       */
62      Object proceed() throws Throwable;
63  }