001package org.apache.maven.doxia.module.twiki.parser;
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.util.ByLineSource;
023import org.apache.maven.doxia.parser.ParseException;
024
025/**
026 * Parse a twiki syntax block
027 *
028 * @author Juan F. Codagnone
029 * @version $Id: BlockParser.html 905940 2014-04-12 16:27:29Z hboutemy $
030 */
031public interface BlockParser
032{
033    /**
034     * <p>accept.</p>
035     *
036     * @param line text line
037     * @return <code>true</code> if this class can handle this line
038     */
039    boolean accept( String line );
040
041    /**
042     * <p>visit.</p>
043     *
044     * @param line   a line of text
045     * @param source the source of lines
046     * @return a block
047     * @throws org.apache.maven.doxia.parser.ParseException on error
048     */
049    Block visit( String line, ByLineSource source )
050        throws ParseException;
051}