Package com.intellij.openapi.actionSystem

Class DataKey<T>

java.lang.Object

com.intellij.openapi.actionSystem.DataKey<T>

Type Parameters:

T - Data type.

All Implemented Interfaces:

ValueKey<T>

public class DataKey<T>
extends java.lang.Object
implements ValueKey<T>

Type-safe named key.

Mainly used via AnActionEvent.getData(DataKey) calls and DataProvider.getData(String) implementations.

Corresponding data for given name is provided by DataProvider implementations. Globally available data can be provided via GetDataRule extension point.

See Also:

CommonDataKeys, PlatformDataKeys, LangDataKeys

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.util.ValueKey

ValueKey.BeforeIf<T>, ValueKey.BeforeThen<T,TT>

Method Summary

Modifier and Type	Method and Description
static <T> DataKey<T>	create(java.lang.String name)
T	getData(DataContext dataContext)
T	getData(DataProvider dataProvider)
java.lang.String	getName()
boolean	is(java.lang.String dataId) For short notation, use MY_KEY.is(dataId) instead of MY_KEY.getName().equals(dataId).

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.util.ValueKey

match, match

Method Detail

create

public static <T> DataKey<T> create(java.lang.String name)

getName

public java.lang.String getName()

Specified by:

getName in interface ValueKey<T>

Returns:

the name of the key

is

public final boolean is(java.lang.String dataId)

For short notation, use MY_KEY.is(dataId) instead of MY_KEY.getName().equals(dataId).

Parameters:

dataId - key name

Returns:

true if name of DataKey equals to dataId, false otherwise

getData

public T getData(DataContext dataContext)

getData

public T getData(DataProvider dataProvider)