blob: 626bde2b8cf22168446d0d56aebaee023e8f7abb [file] [log] [blame]
crazyboblee66b415a2006-08-25 02:01:19 +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
17/**
kevinb9n6a565c72007-02-11 01:58:33 +000018 * <i>Google Guice</i> (pronounced "juice") is an ultra-lightweight dependency
crazyboblee61257a82007-03-03 00:23:40 +000019 * injection framework. Please refer to the Guice
kevinb9na2915a92007-02-28 06:20:30 +000020 * <a href="http://docs.google.com/Doc?id=dd2fhx4z_5df5hw8">User's Guide</a>
kevinb9n6a565c72007-02-11 01:58:33 +000021 * for a gentle introduction.
22 *
23 * <p>The principal public APIs in this package are:
24 *
25 * <dl>
26 * <dt>{@link com.google.inject.Inject}
27 * <dd>The annotation you will use in your implementation classes to tell Guice
28 * where and how it should send in ("inject") the objects you depend on
29 * (your "dependencies").
30 *
31 * <dt>{@link com.google.inject.Module}
32 * <dd>The interface you will implement in order to specify "bindings" --
33 * instructions for how Guice should handle injection -- for a particular
34 * set of interfaces.
35 *
crazyboblee9d573ed2007-02-20 19:23:10 +000036 * <dt>{@link com.google.inject.Binder}
kevinb9n6a565c72007-02-11 01:58:33 +000037 * <dd>The object that Guice passes into your {@link com.google.inject.Module}
38 * to collect these bindings.
39 *
crazyboblee6b0e91b2007-02-25 20:53:48 +000040 * <dt>{@link com.google.inject.Provider}
kevinb9n6a565c72007-02-11 01:58:33 +000041 * <dd>The interface you will implement when you need to customize exactly how
kevinb9na2915a92007-02-28 06:20:30 +000042 * Guice creates instances for a particular binding.
crazyboblee5746d5d2007-02-18 21:52:24 +000043 *
kevinb9n6a565c72007-02-11 01:58:33 +000044 * </dl>
45 *
crazyboblee66b415a2006-08-25 02:01:19 +000046 */
crazyboblee07e41822006-11-21 01:27:08 +000047package com.google.inject;