GoTo Test: do not show 'Create Test' action if not applicable.
[idea/community.git] / platform / lang-api / src / com / intellij / testIntegration / TestFramework.java
1 /*
2  * Copyright 2000-2009 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
17 package com.intellij.testIntegration;
18
19 import com.intellij.ide.fileTemplates.FileTemplateDescriptor;
20 import com.intellij.openapi.extensions.ExtensionPointName;
21 import com.intellij.openapi.module.Module;
22 import com.intellij.psi.PsiElement;
23 import com.intellij.util.IncorrectOperationException;
24 import org.jetbrains.annotations.NotNull;
25 import org.jetbrains.annotations.Nullable;
26
27 import javax.swing.*;
28
29 public interface TestFramework {
30   ExtensionPointName<TestFramework> EXTENSION_NAME = ExtensionPointName.create("com.intellij.testFramework");
31
32   @NotNull
33   String getName();
34
35   @NotNull
36   Icon getIcon();
37
38   boolean isLibraryAttached(@NotNull Module module);
39
40   @NotNull
41   String getLibraryPath();
42
43   @Nullable
44   String getDefaultSuperClass();
45
46   boolean isTestClass(@NotNull PsiElement clazz);
47
48   boolean isPotentialTestClass(@NotNull PsiElement clazz);
49
50   @Nullable
51   PsiElement findSetUpMethod(@NotNull PsiElement clazz);
52
53   @Nullable
54   PsiElement findTearDownMethod(@NotNull PsiElement clazz);
55
56   @Nullable
57   PsiElement findOrCreateSetUpMethod(@NotNull PsiElement clazz) throws IncorrectOperationException;
58
59   FileTemplateDescriptor getSetUpMethodFileTemplateDescriptor();
60
61   FileTemplateDescriptor getTearDownMethodFileTemplateDescriptor();
62
63   FileTemplateDescriptor getTestMethodFileTemplateDescriptor();
64 }