Key

java.lang.Object

dagger.model.Key

public abstract class Key extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

Key.Builder

A builder for Keys.

static final 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

Description

Key()
Method Summary

Modifier and Type

Method

Description

static Key.Builder

builder(TypeMirror type)

Returns a builder for Keys.

abstract boolean

equals(Object o)

abstract int

hashCode()

abstract Optional<Key.MultibindingContributionIdentifier>

multibindingContributionIdentifier()

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

final Optional<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.

final String

toString()

final TypeMirror

type()

The type represented by this key.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details
- Key
  
  public Key()
Method Details
- qualifier
  
  public final Optional<AnnotationMirror> qualifier()
  
  A Qualifier annotation that provides a unique namespace prefix for the type of this key.
- type
  
  public final TypeMirror type()
  
  The type represented by this key.
- multibindingContributionIdentifier
  
  public abstract 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 Object
- equals
  
  public abstract boolean equals(Object o)
  
  Overrides:
  
  equals in class Object
- toString
  
  public final String toString()
  
  Overrides:
  
  toString in class Object
- builder
  
  public static Key.Builder builder(TypeMirror type)
  
  Returns a builder for Keys.