• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /**
2  * Copyright (C) 2014 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 import com.google.inject.Key;
20 import com.google.inject.Provides;
21 
22 import java.lang.annotation.Annotation;
23 import java.lang.reflect.Method;
24 
25 /**
26  * An {@literal @}{@link Provides} binding or binding produced by a
27  * {@link ModuleAnnotatedMethodScanner}.
28  *
29  * @since 4.0
30  * @author sameb@google.com (Sam Berlin)
31  */
32 public interface ProvidesMethodBinding<T> extends HasDependencies {
33 
34   /** Returns the method this binding uses. */
getMethod()35   Method getMethod();
36 
37   /** Returns the instance of the object the method is defined in. */
getEnclosingInstance()38   Object getEnclosingInstance();
39 
40   /** Returns the key of the binding. */
getKey()41   Key<T> getKey();
42 
43   /**
44    * Returns the annotation that caused this binding to be created. For {@code @Provides} methods,
45    * this is an instance of the {@code @Provides} annotation. For bindings from
46    * {@link ModuleAnnotatedMethodScanner}, this is the annotation that caused the scanner to produce
47    * the binding.
48    */
getAnnotation()49   Annotation getAnnotation();
50 }
51