src/com/google/inject/package-info.java

/**
 * Copyright (C) 2006 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * <i>Google Guice</i> (pronounced "juice") is an ultra-lightweight dependency
 * injection container.  Please refer to the Guice
 * <a href="">User's
 * Guide</a>
 * for a gentle introduction.
 *
 * <p>The principal public APIs in this package are:
 *
 * <dl>
 * <dt>{@link com.google.inject.Inject}
 * <dd>The annotation you will use in your implementation classes to tell Guice
 *     where and how it should send in ("inject") the objects you depend on
 *     (your "dependencies").
 *
 * <dt>{@link com.google.inject.Module}
 * <dd>The interface you will implement in order to specify "bindings" --
 *     instructions for how Guice should handle injection -- for a particular
 *     set of interfaces.
 *
 * <dt>{@link com.google.inject.ContainerBuilder}
 * <dd>The object that Guice passes into your {@link com.google.inject.Module}
 *     to collect these bindings.
 *
 * <dt>{@link com.google.inject.Factory} and
 *     {@link com.google.inject.ContextualFactory}
 * <dd>The interface you will implement when you need to customize exactly how
 *     Guice creates instances for a particular binding.  These differ only in
 *     whether a {@link com.google.inject.Context} is made available to the
 *     factory.
 * <dt>{@link com.google.inject.Container}
 * <dd>An object which creates and manages all the instances that make
 *     up your application.  It is created by a
 *     {@link com.google.inject.ContainerBuilder} after each of your
 *     {@link com.google.inject.Module Modules} has been allowed to contribute
 *     its bindings.  In most cases you will never need to interact directly
 *     with the container -- which is the main distinguishing feature of the
 *     Dependency Injection pattern from its rival, Service Locator.
 * </dl>
 *
 */
package com.google.inject;