01: /**
02: * Copyright (C) 2006 Google Inc.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
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: */package com.google.inject.spi;
16:
17: /**
18: * Provides source objects to the {@link com.google.inject.Binder}.
19: * A source object is any object which points back to the current location
20: * within the configuration. Guice uses source objects in error messages
21: * and associates them with bindings.
22: *
23: * @author crazybob@google.com (Bob Lee)
24: */
25: public interface SourceProvider {
26:
27: /**
28: * Creates an object pointing to the current location within the
29: * configuration. If we run into a problem later, we'll be able to trace it
30: * back to the original source. Useful for debugging.
31: */
32: Object source();
33: }
|