View Javadoc

1   /*
2    * Grapht, an open source dependency injector.
3    * Copyright 2014-2015 various contributors (see CONTRIBUTORS.txt)
4    * Copyright 2010-2014 Regents of the University of Minnesota
5    *
6    * This program is free software; you can redistribute it and/or modify
7    * it under the terms of the GNU Lesser General Public License as
8    * published by the Free Software Foundation; either version 2.1 of the
9    * License, or (at your option) any later version.
10   *
11   * This program is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
13   * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
14   * details.
15   *
16   * You should have received a copy of the GNU General Public License along with
17   * this program; if not, write to the Free Software Foundation, Inc., 51
18   * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19   */
20  package org.grouplens.grapht.solver;
21  
22  import org.grouplens.grapht.ResolutionException;
23  
24  import javax.annotation.Nullable;
25  
26  /**
27   * Locate bindings for an injection point.
28   *
29   * @author <a href="http://grouplens.org">GroupLens Research</a>
30   */
31  public interface BindingFunction {
32      /**
33       * Find the applicable binding, if any, for a desire in a particular context.
34       *
35       * @param context The context.
36       * @param desire The desire.
37       * @return The result of binding {@code desire}, or {@code null} if there is no binding.
38       * @throws ResolutionException If there is an error (such as ambiguous bindings).
39       */
40      @Nullable
41      BindingResult bind(InjectionContext context, DesireChain desire) throws ResolutionException;
42  }