compilationunit.java

来自「cqME :java framework for TCK test.」· Java 代码 · 共 102 行

/*
 * $Id$
 *
 * Copyright 1996-2007 Sun Microsystems, Inc. All Rights Reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 *
 * This program 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.
 *
 * This program 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 at /legal/license.txt).
 *
 * 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 Sun Microsystems, Inc., 4150 Network Circle, Santa
 * Clara, CA 95054 or visit www.sun.com if you need additional
 * information or have any questions.
 *
 */

package com.sun.tck.j2me.utils.javasourcemodel;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;

/**
 * This class represents CompilationUnit term of The Grammar of the Java
 * Programming Language (Third Edition). 
 *
 * Definition of CompilationUnit term in BNF notation:
 *
 * CompilationUnit:
 *      [[Annotations] package QualifiedIdentifier   ;  ] {ImportDeclaration}
 *      {TypeDeclaration}
 */
public abstract class CompilationUnit {
    
    /**
     * Parses input Java source file and builds CompilationUnit instance from
     * it.
     * 
     * @param   javaSource  Input Java source file.
     * @param   lang    Version of Java Language Specification. May be used
     *                  for choosing appropriate parser.
     *
     * @return  CompilationUnit instance built from input Java source file.
     *
     * @exception  FileNotFoundException if input Java source file is not found.
     * @exception  IOException if an I/O error occurs.
     * @exception  ParseException if input Java source file is invalid.
     */
    public static CompilationUnit fromSource(File javaSource, JavaLanguage lang)
            throws IOException, FileNotFoundException, ParseException {
        Parser parser = ParserFactory.getParser(lang);
        InputStream input = new FileInputStream(javaSource);
        try {
            return  parser.parse(input);
        } finally {
            input.close();
        }
    }
    
    /**
     * Gets package nam associated with this CompilationUnit.
     *
     * @return fully qualified Java package name.
     */
    public abstract String getPackageName();

    /**
     * Gets list of annotations associated with this CompilationUnit.
     *
     * @return  List of annotation objects.
     */
    public abstract List getAnnotations();
    
    /**
     * Gets list of import declarations associated with this CompilationUnit.
     *
     * @return  List of import declaration objects.
     */
    public abstract List getImportDeclarations();
    
    /**
     * Gets list of type declarations associated with this CompilationUnit.
     *
     * @return List of type declaration objects.
     */
    public abstract List getTypeDeclarations();
}