SourceProvider


1   /**
2    * Copyright (C) 2006 Google Inc.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package com.google.inject.spi;
18  
19  /**
20   * Provides source objects to the {@link com.google.inject.Binder}.
21   * A source object is any object which points back to the current location
22   * within the configuration. Guice uses source objects in error messages
23   * and associates them with bindings.
24   *
25   * @author crazybob@google.com (Bob Lee)
26   */
27  public interface SourceProvider {
28  
29    /**
30     * Creates an object pointing to the current location within the
31     * configuration. If we run into a problem later, we'll be able to trace it
32     * back to the original source. Useful for debugging.
33     */
34    Object   source();
35  }
36

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags