dagger.producers

Enum Produces.Type

java.lang.Object

java.lang.Enum<Produces.Type>

dagger.producers.Produces.Type

All Implemented Interfaces:

Serializable, Comparable<Produces.Type>

Enclosing class:

Produces

public static enum Produces.Type
extends Enum<Produces.Type>

The type of binding into which the return type of the annotated method contributes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MAP The method's return type forms the type argument for the value of a Map<K, Producer<V>>, and the combination of the annotated key and the returned value is contributed to the map as a key/value pair.
SET The method's resulting type forms the generic type argument of a Set<T>, and the returned value or future is contributed to the set.
SET_VALUES Like SET, except the method's return type is either Set<T> or Set<ListenableFuture<T>>, where any values are contributed to the set.
UNIQUE The method is the only one which can produce the value for the specified type.

Method Summary

Methods

Modifier and Type	Method and Description
static Produces.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static Produces.Type[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNIQUE

public static final Produces.Type UNIQUE

The method is the only one which can produce the value for the specified type. This is the default behavior.

SET

public static final Produces.Type SET

The method's resulting type forms the generic type argument of a Set<T>, and the returned value or future is contributed to the set. The Set<T> produced from the accumulation of values will be immutable.

SET_VALUES

public static final Produces.Type SET_VALUES

Like SET, except the method's return type is either Set<T> or Set<ListenableFuture<T>>, where any values are contributed to the set. An example use is to provide a default empty set binding, which is otherwise not possible using SET.

MAP

public static final Produces.Type MAP

The method's return type forms the type argument for the value of a Map<K, Producer<V>>, and the combination of the annotated key and the returned value is contributed to the map as a key/value pair. The Map<K, Producer<V>> produced from the accumulation of values will be immutable.

Method Detail

values

public static Produces.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Produces.Type c : Produces.Type.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Produces.Type valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null