4b39c8b346d93c556f718b93699d41040141ed56
[idea/community.git] / java / jsp-base-openapi / src / com / intellij / psi / jsp / BaseJspFile.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 package com.intellij.psi.jsp;
17
18 import com.intellij.lang.jsp.JspxFileViewProvider;
19 import com.intellij.psi.PsiElement;
20 import com.intellij.psi.PsiFile;
21 import com.intellij.psi.xml.XmlFile;
22 import com.intellij.psi.xml.XmlTag;
23 import org.jetbrains.annotations.NotNull;
24
25 public interface BaseJspFile extends XmlFile {
26   BaseJspFile[] EMPTY_ARRAY = new BaseJspFile[0];
27
28   PsiElement[] getContentsElements();
29
30   boolean isErrorPage();
31   boolean isSessionPage();
32   boolean isTagPage();
33
34   XmlTag[] getDirectiveTags(JspDirectiveKind directiveKind, final boolean searchInIncludes);
35   XmlTag createDirective(XmlTag context, JspDirectiveKind directiveKind);
36
37   /**
38    * Method with a bad name. Returns file corresponding to getTemplateDataLanguage() method of ViewProvider
39    * @see com.intellij.psi.templateLanguages.TemplateLanguageFileViewProvider#getTemplateDataLanguage()
40    */
41   PsiFile getBaseLanguageRoot();
42   /**
43    * @return file which the errorPage directive references,
44    * or null, if there is no errorPage directive or directive references invalid file
45    */
46   PsiFile getErrorPage();
47
48   @NotNull
49   JspxFileViewProvider getViewProvider();
50 }