• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /**
2  * Copyright (C) 2008 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;
18 
19 import com.google.inject.binder.AnnotatedElementBuilder;
20 
21 /**
22  * Returns a binder whose configuration information is hidden from its environment by default. See
23  * {@link com.google.inject.PrivateModule PrivateModule} for details.
24  *
25  * @author jessewilson@google.com (Jesse Wilson)
26  * @since 2.0
27  */
28 public interface PrivateBinder extends Binder {
29 
30   /** Makes the binding for {@code key} available to the enclosing environment */
expose(Key<?> key)31   void expose(Key<?> key);
32 
33   /**
34    * Makes a binding for {@code type} available to the enclosing environment. Use {@link
35    * com.google.inject.binder.AnnotatedElementBuilder#annotatedWith(Class) annotatedWith()} to expose {@code type} with a
36    * binding annotation.
37    */
expose(Class<?> type)38   AnnotatedElementBuilder expose(Class<?> type);
39 
40   /**
41    * Makes a binding for {@code type} available to the enclosing environment. Use {@link
42    * AnnotatedElementBuilder#annotatedWith(Class) annotatedWith()} to expose {@code type} with a
43    * binding annotation.
44    */
expose(TypeLiteral<?> type)45   AnnotatedElementBuilder expose(TypeLiteral<?> type);
46 
withSource(Object source)47   PrivateBinder withSource(Object source);
48 
skipSources(Class... classesToSkip)49   PrivateBinder skipSources(Class... classesToSkip);
50 }
51