org.eclipse.gef4.common.adapt

Class AdapterKey<T>

java.lang.Object

org.eclipse.gef4.common.adapt.AdapterKey<T>

Type Parameters:

T - The type parameter corresponding to the type parameter of the Class used as key (getKey()).

public class AdapterKey<T>
extends java.lang.Object

A pair of Class key and String role to register adapters at and retrieve them from IAdaptables. Using an AdapterKey instead of just a Class or TypeToken key allows to register several adapters under the same key, serving different roles. Nevertheless, adapters can still be accessed in a type-safe manner. To register a default adapter for a certain Class or TypeToken key, the DEFAULT_ROLE may be used.

Creating AdapterKeys is supported by get(Class, String) and get(TypeToken, String), as well as get(Class) and get(TypeToken) respectively, where the latter two will use the DEFAULT_ROLE.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_ROLE A default role to be used for AdapterKeys.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static <T> AdapterKey<T>	get(java.lang.Class<T> key) Creates a new AdapterKey for the given key and the DEFAULT_ROLE role.
static <T> AdapterKey<T>	get(java.lang.Class<T> key, java.lang.String role) Creates a new AdapterKey for the given key and role.
static <T> AdapterKey<T>	get(com.google.common.reflect.TypeToken<T> key) Creates a new AdapterKey for the given key and the DEFAULT_ROLE role.
static <T> AdapterKey<T>	get(com.google.common.reflect.TypeToken<T> key, java.lang.String role) Creates a new AdapterKey for the given key and role.
com.google.common.reflect.TypeToken<T>	getKey() Returns the key used by this AdapterKey.
java.lang.String	getRole() Returns the role used by this AdapterKey.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ROLE

public static final java.lang.String DEFAULT_ROLE

A default role to be used for AdapterKeys.

See Also:

get(Class), Constant Field Values

Method Detail

getKey

public com.google.common.reflect.TypeToken<T> getKey()

Returns the key used by this AdapterKey.

Returns:

The key being used.

getRole

public java.lang.String getRole()

Returns the role used by this AdapterKey.

Returns:

The role being used.

get

public static <T> AdapterKey<T> get(java.lang.Class<T> key,
                                    java.lang.String role)

Creates a new AdapterKey for the given key and role.

Type Parameters:

T - The adapter type.

Parameters:

key - The key to use for the newly created AdapterKey. May not be null.

role - The role to use for the newly created AdapterKey. May not be null.

Returns:

A new AdapterKey for the given key and role.

get

public static <T> AdapterKey<T> get(com.google.common.reflect.TypeToken<T> key,
                                    java.lang.String role)

Creates a new AdapterKey for the given key and role.

Type Parameters:

T - The adapter type.

Parameters:

key - The key to use for the newly created AdapterKey. May not be null.

role - The role to use for the newly created AdapterKey. May not be null.

Returns:

A new AdapterKey for the given key and role.

get

public static <T> AdapterKey<T> get(java.lang.Class<T> key)

Creates a new AdapterKey for the given key and the DEFAULT_ROLE role.

Type Parameters:

T - The adapter type.

Parameters:

key - The key to use for the newly created AdapterKey. May not be null.

Returns:

A new AdapterKey for the given key and role.

See Also:

get(Class, String)

get

public static <T> AdapterKey<T> get(com.google.common.reflect.TypeToken<T> key)

Creates a new AdapterKey for the given key and the DEFAULT_ROLE role.

Type Parameters:

T - The adapter type.

Parameters:

key - The key to use for the newly created AdapterKey. May not be null.

Returns:

A new AdapterKey for the given key and role.

See Also:

get(TypeToken, String)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object