source: other-projects/rsyntax-textarea/src/java/org/fife/ui/rsyntaxtextarea/parser/ParseResult.java@ 25584

/*
 * 07/27/2009
 *
 * ParseResult.java - The result of a Parser parsing some section of an
 * RSyntaxTextArea.
 * 
 * This library is distributed under a modified BSD license.  See the included
 * RSyntaxTextArea.License.txt file for details.
 */
package org.fife.ui.rsyntaxtextarea.parser;

import java.util.List;


/**
 * The result from a {@link Parser}.  This contains the section of lines
 * parsed and any notices for that section.
 *
 * @author Robert Futrell
 * @version 1.0
 * @see DefaultParseResult
 * @see ParserNotice
 */
public interface ParseResult {


    /**
     * Returns an error that occurred while parsing the document, if any.
     *
     * @return The error, or <code>null</code> if the document was
     *         successfully parsed.
     */
    public Exception getError();


    /**
     * Returns the first line parsed.  All parser implementations should
     * currently set this to <code>0</code> and parse the entire document.
     *
     * @return The first line parsed.
     * @see #getLastLineParsed()
     */
    public int getFirstLineParsed();


    /**
     * Returns the first line parsed.  All parser implementations should
     * currently set this to the document's line count and parse the entire
     * document.
     *
     * @return The last line parsed.
     * @see #getFirstLineParsed()
     */
    public int getLastLineParsed();


    /**
     * Returns the notices for the parsed section.
     *
     * @return A list of {@link ParserNotice}s.
     */
    public List getNotices();


    /**
     * Returns the parser that generated these notices.
     *
     * @return The parser.
     */
    public Parser getParser();


    /**
     * Returns the amount of time this parser took to parse the specified
     * range of text.  This is an optional operation; parsers are permitted
     * to return <code>0</code> for this value.
     *
     * @return The parse time, in milliseconds, or <code>0</code> if the
     *         parse time was not recorded.
     */
    public long getParseTime();


}