dagger.model

Class Key

java.lang.Object

dagger.model.Key

public abstract class Key
extends java.lang.Object

A type and an optional qualifier that is the lookup key for a binding.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Key.Builder A builder for Keys.
static class	Key.MultibindingContributionIdentifier An object that identifies a multibinding contribution method and the module class that contributes it to the graph.

Constructor Summary

Constructors

Constructor and Description
Key()

Method Summary

Modifier and Type	Method and Description
static Key.Builder	builder(javax.lang.model.type.TypeMirror type) Returns a builder for Keys.
abstract boolean	equals(java.lang.Object o)
abstract int	hashCode()
abstract java.util.Optional<Key.MultibindingContributionIdentifier>	multibindingContributionIdentifier() Distinguishes keys for multibinding contributions that share a type() and qualifier().
java.util.Optional<javax.lang.model.element.AnnotationMirror>	qualifier() A Qualifier annotation that provides a unique namespace prefix for the type of this key.
abstract Key.Builder	toBuilder() Returns a Key.Builder that inherits the properties of this key.
java.lang.String	toString()
javax.lang.model.type.TypeMirror	type() The type represented by this key.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Key

public Key()

Method Detail

qualifier

public final java.util.Optional<javax.lang.model.element.AnnotationMirror> qualifier()

A Qualifier annotation that provides a unique namespace prefix for the type of this key.

type

public final javax.lang.model.type.TypeMirror type()

The type represented by this key.

multibindingContributionIdentifier

public abstract java.util.Optional<Key.MultibindingContributionIdentifier> multibindingContributionIdentifier()

Distinguishes keys for multibinding contributions that share a type() and qualifier().

Each multibound map and set has a synthetic multibinding that depends on the specific contributions to that map or set using keys that identify those multibinding contributions.

Absent except for multibinding contributions.

toBuilder

public abstract Key.Builder toBuilder()

Returns a Key.Builder that inherits the properties of this key.

hashCode

@Memoized
public abstract int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public abstract boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static Key.Builder builder(javax.lang.model.type.TypeMirror type)

Returns a builder for Keys.