/*

 * Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.source.tree;

import java.util.List;

import javax.tools.JavaFileObject;

/**

 * Represents the abstract syntax tree for compilation units (source

 * files) and package declarations (package-info.java).

 *

 * @jls 7.3 Compilation Units

 * @jls 7.4 Package Declarations

 *

 * @author Peter von der Ahé

 * @since 1.6

 */

public interface CompilationUnitTree extends Tree {

    /**

     * Returns the annotations listed on any package declaration

     * at the head of this compilation unit, or {@code null} if there

     * is no package declaration.

     * @return the package annotations

     */

    List<? extends AnnotationTree> getPackageAnnotations();

    /**

     * Returns the name contained in any package declaration

     * at the head of this compilation unit, or {@code null} if there

     * is no package declaration.

     * @return the package name

     */

    ExpressionTree getPackageName();

    /**

     * Returns the package tree associated with this compilation unit,

     * or {@code null} if there is no package declaration.

     * @return the package tree

     * @since 9

     */

    PackageTree getPackage();

    /**

     * Returns the import declarations appearing in this compilation unit.

     * @return the import declarations

     */

    List<? extends ImportTree> getImports();

    /**

     * Returns the type declarations appearing in this compilation unit.

     * The list may also include empty statements resulting from

     * extraneous semicolons.

     * @return the type declarations

     */

    List<? extends Tree> getTypeDecls();

    /**

     * Returns the file object containing the source for this compilation unit.

     * @return the file object

     */

    JavaFileObject getSourceFile();

    /**

     * Returns the line map for this compilation unit, if available.

     * Returns {@code null} if the line map is not available.

     * @return the line map for this compilation unit

     */

    LineMap getLineMap();

}