View Javadoc

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.proxy;
19  
20  import java.lang.reflect.Method;
21  
22  /**
23   * Represents a method invocation.
24   *
25   * @author James Carman
26   * @since 1.0
27   */
28  public interface Invocation
29  {
30  //**********************************************************************************************************************
31  // Other Methods
32  //**********************************************************************************************************************
33  
34      /**
35       * Returns the arguments being passed to this method invocation.  Changes in the elements of this array will be
36       * propagated to the recipient of this invocation.
37       *
38       * @return the arguments being passed to this method invocation
39       */
40      public Object[] getArguments();
41  
42      /**
43       * Returns the method being called.
44       *
45       * @return the method being called
46       */
47      public Method getMethod();
48  
49      /**
50       * Returns the proxy object on which this invocation was invoked.
51       *
52       * @return the proxy object on which this invocation was invoked
53       */
54      public Object getProxy();
55  
56      /**
57       * Called in order to let the invocation proceed.
58       *
59       * @return the return value of the invocation
60       * @throws Throwable any exception or error that was thrown as a result of this invocation
61       */
62      public Object proceed() throws Throwable;
63  }