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.annotation;
21  
22  import org.grouplens.grapht.CachePolicy;
23  
24  import javax.inject.Provider;
25  import java.lang.annotation.*;
26  
27  /**
28   * DefaultProvider specifies a Provider implementation to act as a default binding
29   * for types annotated with it.
30   */
31  @Documented
32  @Target(ElementType.TYPE)
33  @Retention(RetentionPolicy.RUNTIME)
34  public @interface DefaultProvider {
35      Class<? extends Provider<?>> value();
36  
37      /**
38       * The default cache policy of this default.
39       * @return The default cache policy for this binding.
40       */
41      CachePolicy cachePolicy() default CachePolicy.NO_PREFERENCE;
42  
43      /**
44       * Whether the default binding should be skipped if its dependencies cannot be satisfied.
45       * @return {@code true} if this default should be skipped if its dependencies cannot be satisfied.
46       */
47      boolean skipIfUnusable() default false;
48  }