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  /**
21   * Provides an object to a delegating proxy.
22   *
23   * @author James Carman
24   * @since 1.0
25   */
26  public interface ObjectProvider
27  {
28  //----------------------------------------------------------------------------------------------------------------------
29  // Other Methods
30  //----------------------------------------------------------------------------------------------------------------------
31  
32      /**
33       * Returns an object.  Implementing classes should throw a
34       * {@link org.apache.commons.proxy.exception.ObjectProviderException} if any problems arise while
35       * constructing/finding the object.
36       *
37       * @return the object on which the method should be called
38       */
39      public Object getObject();
40  }
41