team.unnamed.inject.key

Class Key<T>

java.lang.Object

team.unnamed.inject.key.Key<T>

Type Parameters:

T - The type of the key

All Implemented Interfaces:

java.io.Serializable

public final class Key<T>
extends java.lang.Object
implements java.io.Serializable

Represents a binding key used to store a relation of Key -> Provider. Holds a TypeReference representing the type of the key, and a Set of Qualifier representing the annotations or annotation types that works like qualifiers.

The key supports generic types using TypeReference, the key cannot be created using a sub-class like TypeReference.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Key(TypeReference<T> type, java.lang.Class<? extends java.lang.annotation.Annotation> qualifierType, java.lang.annotation.Annotation qualifier)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.annotation.Annotation	getQualifier() Returns the qualifier instance attached to this type key
java.lang.Class<? extends java.lang.annotation.Annotation>	getQualifierType() Returns the qualifier type attached to this type key
TypeReference<T>	getType()
int	hashCode()
boolean	isPureRawType() Determines if the Key represented by this is a raw-type
static <T> Key<T>	of(java.lang.Class<T> type)
static <T> Key<T>	of(TypeReference<T> type)
static <T> Key<T>	of(TypeReference<T> type, java.lang.Class<? extends java.lang.annotation.Annotation> qualifierType, java.lang.annotation.Annotation qualifier)
boolean	requiresContext() Checks if the wrapped type requires context or not
java.lang.String	toString() This should create a string with util information and very verbose.
Key<T>	withQualifier(java.lang.annotation.Annotation qualifier) Returns a new Key with the given qualifier
Key<T>	withQualifier(java.lang.Class<? extends java.lang.annotation.Annotation> qualifierType) Returns a new Key with the given qualifierType
<R> Key<R>	withType(TypeReference<R> type) Returns a new Key instance with the given type, the qualifier is copied

Methods inherited from class java.lang.Object

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

Constructor Detail

Key

public Key(TypeReference<T> type,
           java.lang.Class<? extends java.lang.annotation.Annotation> qualifierType,
           java.lang.annotation.Annotation qualifier)

Method Detail

of

public static <T> Key<T> of(java.lang.Class<T> type)

of

public static <T> Key<T> of(TypeReference<T> type)

of

public static <T> Key<T> of(TypeReference<T> type,
                            java.lang.Class<? extends java.lang.annotation.Annotation> qualifierType,
                            java.lang.annotation.Annotation qualifier)

isPureRawType

public boolean isPureRawType()

Determines if the Key represented by this is a raw-type

Returns:

true if the Key represented by this is a raw-type

requiresContext

public boolean requiresContext()

Checks if the wrapped type requires context or not

Returns:

true if the wrapped type requires context

getType

public TypeReference<T> getType()

Returns:

The generic or raw type of the key

getQualifier

public java.lang.annotation.Annotation getQualifier()

Returns the qualifier instance attached to this type key

Returns:

The qualifier instance

getQualifierType

public java.lang.Class<? extends java.lang.annotation.Annotation> getQualifierType()

Returns the qualifier type attached to this type key

Returns:

The qualifier type

withType

public <R> Key<R> withType(TypeReference<R> type)

Returns a new Key instance with the given type, the qualifier is copied

Type Parameters:

R - The new key type

Parameters:

type - The new key type

Returns:

The new key

withQualifier

public Key<T> withQualifier(java.lang.annotation.Annotation qualifier)

Returns a new Key with the given qualifier

Parameters:

qualifier - The new qualifier

Returns:

The new key

withQualifier

public Key<T> withQualifier(java.lang.Class<? extends java.lang.annotation.Annotation> qualifierType)

Returns a new Key with the given qualifierType

Parameters:

qualifierType - The new qualifier type

Returns:

The new key

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

This should create a string with util information and very verbose. Like

   team.unnamed.inject.ExampleType
     annotated with @Named("hello")
     marked with @Marker
 

If a class name starts with java, it isn't used, the used name is now Class.getSimpleName()

Overrides:

toString in class java.lang.Object

Returns:

The key information as string