Application.java

// =================================================================================================
// Copyright 2011 Twitter, Inc.
// -------------------------------------------------------------------------------------------------
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this work except in compliance with the License.
// You may obtain a copy of the License in the LICENSE file, or 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.
// =================================================================================================

package com.twitter.common.application;

import com.google.inject.Module;

/**
 * An application that supports a limited lifecycle and optional binding of guice modules.
 *
 * @author William Farner
 */
public interface Application extends Runnable {

  /**
   * Returns binding modules for the application.
   *
   * @return Application binding modules.
   */
  Iterable<? extends Module> getModules();

  /**
   * Returns an iterable containing modules that should <i>override</i> bindings made in the rest
   * of the application.  This is useful for providing custom bindings in place of system defaults.
   *
   * @return Application override binding modules.
   */
  Iterable<? extends Module> getOverridingModules();
}