blob: bafbc758edad42fcd53b690628e9fd16251fecdf [file] [log] [blame]
crazyboblee6ab7e1f2006-12-02 00:20:36 +00001/**
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
17package com.google.inject;
18
19/**
crazyboblee61257a82007-03-03 00:23:40 +000020 * A module contributes configuration information, typically interface
kevinb9nb950ad92007-03-13 02:16:16 +000021 * bindings, which will be used to create an {@link Injector}. A Guice-based
crazybobleec1d0c642007-03-07 17:20:22 +000022 * application is ultimately composed of little more than a set of
23 * {@code Module}s and some bootstrapping code.
crazyboblee0bfdbc62007-02-20 21:47:19 +000024 *
25 * <p>Your Module classes can use a more streamlined syntax by extending
26 * {@link AbstractModule} rather than implementing this interface directly.
crazyboblee6ab7e1f2006-12-02 00:20:36 +000027 */
crazyboblee63b592b2007-01-25 02:45:24 +000028public interface Module {
crazyboblee6ab7e1f2006-12-02 00:20:36 +000029
crazyboblee7c5b2c42007-01-20 02:05:20 +000030 /**
kevinb9nb950ad92007-03-13 02:16:16 +000031 * Contributes bindings and other configurations for this module to a
32 * {@code Binder}.
crazyboblee7c5b2c42007-01-20 02:05:20 +000033 */
crazyboblee9d573ed2007-02-20 19:23:10 +000034 void configure(Binder binder);
crazyboblee6ab7e1f2006-12-02 00:20:36 +000035}