dagger.multibindings.Multibinds Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of dagger Show documentation
Show all versions of dagger Show documentation
A fast dependency injector for Android and Java.
/*
* Copyright (C) 2015 The Dagger Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package dagger.multibindings;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
/**
* Annotates abstract module methods that declare multibindings.
*
* You can declare that a multibound set or map is bound by annotating an abstract module method
* that returns the set or map you want to declare with {@code @Multibinds}.
*
*
You do not have to use {@code @Multibinds} for sets or maps that have at least one
* contribution, but you do have to declare them if they may be empty.
*
*
* {@literal @Module} abstract class MyModule {
* {@literal @Multibinds abstract Set aSet();}
* {@literal @Multibinds abstract @MyQualifier Set aQualifiedSet();}
* {@literal @Multibinds abstract Map aMap();}
* {@literal @Multibinds abstract @MyQualifier Map aQualifiedMap();}
*
* {@literal @Provides}
* {@literal static Object usesMultibindings(Set set, @MyQualifier Map map}) {
* return …
* }
* }
*
* A given set or map multibinding can be declared any number of times without error. Dagger
* never implements or calls any {@code @Multibinds} methods.
*
* @see Multibindings
*/
@Documented
@Target(METHOD)
@Retention(RUNTIME)
public @interface Multibinds {}