GroovyFile.java

/*
 * Copyright 2000-2014 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 org.jetbrains.plugins.groovy.lang.psi;

import com.intellij.psi.PsiType;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.plugins.groovy.lang.psi.api.statements.GrVariableDeclaration;
import org.jetbrains.plugins.groovy.lang.psi.api.toplevel.imports.GrImportStatement;
import org.jetbrains.plugins.groovy.lang.psi.api.toplevel.packaging.GrPackageDefinition;

/**
 * @author ven
 */
public interface GroovyFile extends GroovyFileBase {
  GroovyFile[] EMPTY_ARRAY = new GroovyFile[0];

  GrImportStatement[] getImportStatements();

  @Override
  @NotNull
  String getPackageName();

  @Nullable
  GrPackageDefinition getPackageDefinition();

  @Override
  void setPackageName(String packageName);

  @Nullable
  GrPackageDefinition setPackage(GrPackageDefinition newPackage);

  @Nullable
  PsiType getInferredScriptReturnType();

  /**
   * Top level script variable declarations are declarations within script body.
   * <pre>
   *   def a // top level
   *   if (condition) {
   *     def b // top level
   *   }
   *   def foo() {
   *     def c // script declaration, but not in script body.
   *   }
   *   class SomeClass {
   *     def var() {
   *       def d // not script declaration, it appears within SomeClass
   *     }
   *   }
   * </pre>
   * @param topLevelOnly whether script body declarations are needed only
   * @return script variable declarations which have at least one annotation.
   * @see org.jetbrains.plugins.groovy.transformations.impl.BaseScriptTransformationSupport
   * @see org.jetbrains.plugins.groovy.transformations.impl.FieldScriptTransformationSupport
   */
  @NotNull
  GrVariableDeclaration[] getScriptDeclarations(boolean topLevelOnly);
}