proxy-1.0-work/src/main/java/org/apache/commons/proxy/ObjectProvider.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.commons.proxy;

/**
 * Provides an object to a delegating proxy.
 *
 * @author James Carman
 * @since 1.0
 */
public interface ObjectProvider
{
//----------------------------------------------------------------------------------------------------------------------
// Other Methods
//----------------------------------------------------------------------------------------------------------------------

    /**
     * Returns an object.  Implementing classes should throw a
     * {@link org.apache.commons.proxy.exception.ObjectProviderException} if any problems arise while
     * constructing/finding the object.
     *
     * @return the object on which the method should be called
     */
    public Object getObject();
}