java/jsp-base-openapi/src/com/intellij/psi/jsp/BaseJspFile.java

/*
 * Copyright 2000-2009 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.intellij.psi.jsp;

import com.intellij.lang.jsp.JspxFileViewProvider;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiFile;
import com.intellij.psi.xml.XmlFile;
import com.intellij.psi.xml.XmlTag;
import org.jetbrains.annotations.NotNull;

public interface BaseJspFile extends XmlFile {
  BaseJspFile[] EMPTY_ARRAY = new BaseJspFile[0];

  PsiElement[] getContentsElements();

  boolean isErrorPage();
  boolean isSessionPage();
  boolean isTagPage();

  XmlTag[] getDirectiveTags(JspDirectiveKind directiveKind, final boolean searchInIncludes);
  XmlTag createDirective(XmlTag context, JspDirectiveKind directiveKind);
  XmlTag createDirective(JspDirectiveKind directiveKind);

  /**
   * Method with a bad name. Returns file corresponding to getTemplateDataLanguage() method of ViewProvider
   * @see com.intellij.psi.templateLanguages.TemplateLanguageFileViewProvider#getTemplateDataLanguage()
   */
  PsiFile getBaseLanguageRoot();
  /**
   * @return file which the errorPage directive references,
   * or null, if there is no errorPage directive or directive references invalid file
   */
  PsiFile getErrorPage();

  @NotNull
  JspxFileViewProvider getViewProvider();

  @NotNull
  XmlTag getRootTag();
}