001    /*
002     * Copyright (C) 2006-2007 the original author or authors.
003     *
004     * Licensed under the Apache License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     *     http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    
017    package org.codehaus.gmaven.runtime.support.stubgen.parser;
018    
019    import org.codehaus.gmaven.runtime.support.stubgen.UnexpectedNodeException;
020    
021    /**
022     * Abstraction of nodes of a parse tree.
023     *
024     * @version $Id: Node.java 18 2009-07-16 09:39:40Z user57 $
025     * @author <a href="mailto:jason@planet57.com">Jason Dillon</a>
026     */
027    public interface Node
028    {
029        String text();
030    
031        boolean isLeaf();
032    
033        Node firstChild();
034    
035        Node nextSibling();
036    
037        int line();
038    
039        int column();
040    
041        //
042        // Type helpers
043        //
044        
045        boolean is(String name);
046    
047        boolean is(String[] names);
048    
049        void ensure(String name) throws UnexpectedNodeException;
050    
051        Node skip(String name) throws UnexpectedNodeException;
052    
053        //
054        // Debug helpers
055        //
056    
057        void dump();
058    
059        void dump(String pad);    
060    }