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; 18 19 /** 20 * A module contributes configuration information, typically interface bindings, which will be used 21 * to create an {@link Injector}. A Guice-based application is ultimately composed of little more 22 * than a set of {@code Module}s and some bootstrapping code. 23 * 24 * <p>Your Module classes can use a more streamlined syntax by extending {@link AbstractModule} 25 * rather than implementing this interface directly. 26 * 27 * <p>In addition to the bindings configured via {@link #configure}, bindings will be created for 28 * all methods annotated with {@literal @}{@link Provides}. Use scope and binding annotations on 29 * these methods to configure the bindings. 30 */ 31 public interface Module { 32 33 /** 34 * Contributes bindings and other configurations for this module to {@code binder}. 35 * 36 * <p><strong>Do not invoke this method directly</strong> to install submodules. Instead use 37 * {@link Binder#install(Module)}, which ensures that {@link Provides provider methods} are 38 * discovered. 39 */ 40 void configure(Binder binder); 41 } 42
