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.context;
21
22 import org.grouplens.grapht.solver.InjectionContext;
23
24 /**
25 * Interface for context matchers. A context matcher matches contexts to
26 * determine whether particular bind rules are to be applied.
27 *
28 * @author <a href="http://grouplens.org">GroupLens Research</a>
29 */
30 public interface ContextMatcher {
31 /**
32 * Attempt to match this context matcher against the specified context. If the
33 * matcher matches, it will return a {@link ContextMatch} describing the result.
34 *
35 * @param context The context to match.
36 * @return The match information, or {@code null} if the matcher does not match.
37 */
38 ContextMatch matches(InjectionContext context);
39 }