[git tests] refresh correctly: with marking dirty
[idea/community.git] / plugins / git4idea / tests / git4idea / test / TestDialogHandler.java
1 /*
2  * Copyright 2000-2011 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 git4idea.test;
17
18 import com.intellij.openapi.ui.DialogWrapper;
19
20 /**
21  * TestDialogHandler is invoked by the {@link TestDialogManager} instead of showing a dialog on a screen
22  * (which is usually impossible for tests).
23  * It's purpose is to modify dialog fields and return the dialog exit code,
24  * which will be available to the code which has invoked the dialog.
25  *
26  * @author Kirill Likhodedov
27  */
28 public interface TestDialogHandler<T extends DialogWrapper> {
29
30   /**
31    * Do something with the dialog (modify its instance fields, for example)
32    * and return the exit code - as if user pressed one of exit buttons.
33    *
34    * @param dialog dialog to be handled.
35    * @return DialogWrapper exit code, for example, {@link DialogWrapper#OK_EXIT_CODE}.
36    */
37   int handleDialog(T dialog);
38
39 }