com.google.gwt.inject.rebind.binding.Binding Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gin Show documentation

GIN (GWT INjection) brings automatic dependency injection to Google Web Toolkit client-side code. GIN is built on top of Guice and uses (a subset of) Guice's binding language.

There is a newer version: 2.1.2

Show newest version

/*
 * Copyright 2008 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.
 */
package com.google.gwt.inject.rebind.binding;

import com.google.gwt.user.rebind.SourceWriter;

/**
 * Interface used by {@code InjectorGeneratorImpl} to represent different kinds
 * of bindings.
 */
public interface Binding {

  /**
   * Writes the method necessary to create the binding's type to the writer.
   * A method with the {@code creatorMethodSignature} must be written,
   * other methods are optional.
   *
   * @param writer writer that methods are written to
   * @param creatorMethodSignature signature of method that needs to be created
   */
  void writeCreatorMethods(SourceWriter writer, String creatorMethodSignature);

  /**
   * @return A tuple of two sets:  One set of keys that this binding requires.
   *     This set is used to find more classes that need to be bound. The
   *     second set contains all keys that have been optionally requested.
   */
  RequiredKeys getRequiredKeys();
}