001package org.apache.maven.doxia.module.confluence.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 * <p>BlockParser interface.</p>
027 */
028public interface BlockParser
029{
030    /**
031     * accept.
032     *
033     * @param line the line.
034     * @param source the source.
035     * @return boolean true if valid.
036     */
037    boolean accept( String line, ByLineSource source );
038
039    /**
040     * visit.
041     *
042     * @param line the line.
043     * @param source the source.
044     * @return boolean true if valid.
045     * @throws org.apache.maven.doxia.parser.ParseException if any.
046     */
047    Block visit( String line, ByLineSource source ) throws ParseException;
048}