replaced <code></code> with more concise {@code}
[idea/community.git] / platform / editor-ui-api / src / com / intellij / openapi / actionSystem / DataProvider.java
1 /*
2  * Copyright 2000-2013 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.openapi.actionSystem;
17
18 import org.jetbrains.annotations.NonNls;
19 import org.jetbrains.annotations.Nullable;
20
21 /**
22  * Allows a component hosting actions to provide context information to the actions. When a specific
23  * data item is requested, the component hierarchy is walked up from the currently focused component,
24  * and every component implementing the {@code DataProvider} interface is queried for the data
25  * until one of them returns the data. Data items can also be mapped to each other - for example,
26  * if a data provider provides an item for {@link CommonDataKeys#NAVIGATABLE}, an item for
27  * {@link CommonDataKeys#NAVIGATABLE_ARRAY} can be generated from it automatically.
28  *
29  * @see DataContext
30  */
31 public interface DataProvider {
32   /**
33    * Returns the object corresponding to the specified data identifier. Some of the supported
34    * data identifiers are defined in the {@link com.intellij.openapi.actionSystem.PlatformDataKeys} class.
35    *
36    * @param dataId the data identifier for which the value is requested.
37    * @return the value, or null if no value is available in the current context for this identifier.
38    */
39   @Nullable
40   Object getData(@NonNls String dataId);
41 }