1 /*
2  * Copyright (C) 2015 Google Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.google.inject.multibindings;
18 
19 import static java.lang.annotation.ElementType.METHOD;
20 import static java.lang.annotation.RetentionPolicy.RUNTIME;
21 
22 import com.google.inject.Module;
23 import java.lang.annotation.Documented;
24 import java.lang.annotation.Retention;
25 import java.lang.annotation.Target;
26 
27 /**
28  * Annotates methods of a {@link Module} to add items to a {@link Multibinder}. The method's return
29  * type and binding annotation determines what Set this will contribute to. For example,
30  *
31  * <pre>
32  * {@literal @}ProvidesIntoSet
33  * {@literal @}Named("urls")
34  * String provideFooUrl(FooManager fm) { returm fm.getUrl(); }
35  *
36  * {@literal @}ProvidesIntoSet
37  * {@literal @}Named("urls")
38  * String provideBarUrl(BarManager bm) { return bm.getUrl(); }
39  * </pre>
40  *
41  * will add two items to the {@code @Named("urls") Set<String>} set. The items are bound as
42  * providers and will be evaluated at injection time.
43  *
44  * @author sameb@google.com (Sam Berlin)
45  * @since 4.0
46  */
47 @Documented
48 @Target(METHOD)
49 @Retention(RUNTIME)
50 public @interface ProvidesIntoSet {}
51