Parser.java revision 2571:10fc81ac75b4
1/*
2 * Copyright (c) 1999, 2008, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26
27package com.sun.tools.javac.parser;
28
29import com.sun.tools.javac.tree.JCTree.JCCompilationUnit;
30import com.sun.tools.javac.tree.JCTree.JCExpression;
31import com.sun.tools.javac.tree.JCTree.JCStatement;
32
33/**
34 * Reads syntactic units from source code.
35 * Parsers are normally created from a ParserFactory.
36 *
37 * <p><b>This is NOT part of any supported API.
38 * If you write code that depends on this, you do so at your own risk.
39 * This code and its internal interfaces are subject to change or
40 * deletion without notice.</b>
41 */
42public interface Parser {
43    /**
44     * Parse a compilation unit.
45     * @return a compilation unit
46     */
47    JCCompilationUnit parseCompilationUnit();
48
49    /**
50     * Parse an expression.
51     * @return an expression
52     */
53    JCExpression parseExpression();
54
55    /**
56     * Parse a statement.
57     * @return an expression
58     */
59    JCStatement parseStatement();
60
61    /**
62     * Parse a type.
63     * @return an expression for a type
64     */
65    JCExpression parseType();
66}
67