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.util;
21  
22  import javax.inject.Provider;
23  
24  /**
25   * A provider that can report at runtime the type it will provide.  This is mostly to allow instance
26   * and wrapper providers to pass through type information.
27   *
28   * @since 0.6
29   * @author <a href="http://grouplens.org">GroupLens Research</a>
30   */
31  public interface TypedProvider<T> extends Provider<T> {
32      /**
33       * Get the type of object that will be provided by this provider.  Any object returned from
34       * {@link #get()} must be of this type.  This is used to help the injector refine its types.
35       *
36       * @return The type of objects that will be provided.
37       */
38      Class<?> getProvidedType();
39  }