001package org.apache.maven.doxia;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.maven.doxia.parser.ParseException;
023import org.apache.maven.doxia.parser.Parser;
024import org.apache.maven.doxia.parser.manager.ParserNotFoundException;
025import org.apache.maven.doxia.sink.Sink;
026
027import java.io.Reader;
028
029/**
030 * Basic interface of the Doxia framework.
031 *
032 * @author Jason van Zyl
033 * @version $Id: Doxia.html 905940 2014-04-12 16:27:29Z hboutemy $
034 * @since 1.0
035 */
036public interface Doxia
037{
038    /** The Plexus lookup role. */
039    String ROLE = Doxia.class.getName();
040
041    /**
042     * Parses the given source model using a parser with given id,
043     * and emits Doxia events into the given sink.
044     *
045     * @param source not null reader that provides the source document.
046     * You could use <code>newReader</code> methods from {@link org.codehaus.plexus.util.ReaderFactory}.
047     * @param parserId Identifier for the parser to use.
048     * @param sink A sink that consumes the Doxia events.
049     * @throws org.apache.maven.doxia.parser.manager.ParserNotFoundException
050     * if no parser could be found for the given id.
051     * @throws org.apache.maven.doxia.parser.ParseException if the model could not be parsed.
052     */
053    void parse( Reader source, String parserId, Sink sink )
054        throws ParserNotFoundException, ParseException;
055
056    /**
057     * Return a parser for the given <code>parserId</code>.
058     *
059     * @param parserId Identifier for the parser to use.
060     * @return the parser defining by parserId.
061     * @throws org.apache.maven.doxia.parser.manager.ParserNotFoundException
062     * if no parser could be found for the given id.
063     */
064    Parser getParser( String parserId )
065        throws ParserNotFoundException;
066}