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;
21  
22  import org.grouplens.grapht.annotation.AnnotationBuilder;
23  
24  import javax.inject.Named;
25  
26  
27  /**
28   * Names is a utility class to create {@link Named} annotation instances when
29   * configuring an injector that relies on named qualifiers. Qualifiers with
30   * other attributes can by instantiated using the {@link AnnotationBuilder}.
31   * 
32   * @author <a href="http://grouplens.org">GroupLens Research</a>
33   */
34  public class Names {
35      /**
36       * Get a Named annotation instance whose value equals the provided String.
37       * The returned annotation is equal to annotations created by a declaration
38       * matching: <code>@Named(name)</code>, where name is the input String.
39       * 
40       * @param name The name value for the returned annotation
41       * @return A Named instance wrapping the given name
42       */
43      public static Named named(String name) {
44          return new AnnotationBuilder<Named>(Named.class)
45              .setValue(name)
46              .build();
47      }
48  }