dagger.internal

Class Keys

java.lang.Object

dagger.internal.Keys

public final class Keys
extends Object

Formats strings that identify the value to be injected. Keys are of one of three forms:

1. com.square.Foo: provides instances of Foo.
2. @com.square.Bar/com.square.Foo: provides instances of Foo qualified by the annotation.
3. members/com.square.Foo: injects members of Foo.

Bindings from @Provides methods are of the first two types. BindingsGroup created from @Inject-annotated members of a class are of the first and last types.

Method Summary

Modifier and Type	Method and Description
static String	get(Type type) Returns a key for type with no annotation.
static String	get(Type type, Annotation[] annotations, Object subject) Returns a key for type annotated with annotations, reporting failures against subject.
static String	getClassName(String key) Returns the class name for key, if key was created with a class instance.
static String	getMembersKey(Class<?> key) Returns a key for the members of type.
static String	getSetKey(Type type, Annotation[] annotations, Object subject) Returns a key for type annotated with annotations, wrapped by Set, reporting failures against subject.
static boolean	isAnnotated(String key) Returns true if key has a qualifier annotation.
static boolean	isPlatformType(String name) Returns true if name is the name of a platform-provided class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

get

public static String get(Type type)

Returns a key for type with no annotation.

getMembersKey

public static String getMembersKey(Class<?> key)

Returns a key for the members of type.

getSetKey

public static String getSetKey(Type type,
                               Annotation[] annotations,
                               Object subject)

Returns a key for type annotated with annotations, wrapped by Set, reporting failures against subject.

Parameters:

annotations - the annotations on a single method, field or parameter. This array may contain at most one qualifier annotation.

get

public static String get(Type type,
                         Annotation[] annotations,
                         Object subject)

Returns a key for type annotated with annotations, reporting failures against subject.

Parameters:

annotations - the annotations on a single method, field or parameter. This array may contain at most one qualifier annotation.

isAnnotated

public static boolean isAnnotated(String key)

Returns true if key has a qualifier annotation.

getClassName

public static String getClassName(String key)

Returns the class name for key, if key was created with a class instance. Returns null if key represents a parameterized type or an array type.

isPlatformType

public static boolean isPlatformType(String name)

Returns true if name is the name of a platform-provided class.