se.natusoft.doc.markdown.api.Parser.groovy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of markdown-doc-lib Show documentation
Parses markdown and generates HTML and PDF.
The newest version!
/* 
 * 
 * PROJECT
 *     Name
 *         MarkdownDoc Library
 *     
 *     Code Version
 *         1.2.9
 *     
 *     Description
 *         Parses markdown and generates HTML and PDF.
 *         
 * COPYRIGHTS
 *     Copyright (C) 2012 by Natusoft AB All rights reserved.
 *     
 * LICENSE
 *     Apache 2.0 (Open Source)
 *     
 *     Licensed under the Apache License, Version 2.0 (the "License");
 *     you may not use this file except in compliance with the License.
 *     You may obtain a copy of the License at
 *     
 *       http://www.apache.org/licenses/LICENSE-2.0
 *     
 *     Unless required by applicable law or agreed to in writing, software
 *     distributed under the License is distributed on an "AS IS" BASIS,
 *     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *     See the License for the specific language governing permissions and
 *     limitations under the License.
 *     
 * AUTHORS
 *     Tommy Svensson ([email protected])
 *         Changes:
 *         2012-11-04: Created!
 *         
 */
package se.natusoft.doc.markdown.api

import se.natusoft.doc.markdown.exception.ParseException
import se.natusoft.doc.markdown.model.Doc

/**
 * This defines the API of a parser.
 */
public interface Parser {

    /**
     * Parses a file and adds its document structure to the passed Doc.
     *
     * @param document The parsed result is added to this.
     * @param parseFile The file whose content to parse.
     * @param parserOptions options to pass on to the parser.
     *
     * @throws IOException on failure.
     * @throws ParseException on parse failures.
     */
    public void parse(Doc document, File parseFile, Properties parserOptions) throws IOException, ParseException

    /**
     * Parses a file and adds its document structure to the passed Doc.
     *
     * @param document The parsed result is added to this.
     * @param parseStream The stream whose content to parse.
     * @param parserOptions options to pass on to the parser.
     *
     * @throws IOException on failure.
     * @throws ParseException on parse failures.
     */
    public void parse(Doc document, InputStream parseStream, Properties parserOptions) throws IOException, ParseException

    /**
     * Returns true if extension of the passed fileName is valid for this parser.
     *
     * @param fileName The fileName whose extension to test.
     *
     * @return true or false.
     */
    public boolean validFileExtension(String fileName)

}