View Javadoc

1   package org.apache.maven.doxia.module.confluence.parser;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.doxia.util.ByLineSource;
23  import org.apache.maven.doxia.parser.ParseException;
24  
25  /**
26   * <p>BlockParser interface.</p>
27   *
28   * @version $Id: BlockParser.java 785531 2009-06-17 09:47:59Z ltheussl $
29   */
30  public interface BlockParser
31  {
32      /**
33       * accept.
34       *
35       * @param line the line.
36       * @param source the source.
37       * @return boolean true if valid.
38       */
39      boolean accept( String line, ByLineSource source );
40  
41      /**
42       * visit.
43       *
44       * @param line the line.
45       * @param source the source.
46       * @return boolean true if valid.
47       * @throws org.apache.maven.doxia.parser.ParseException if any.
48       */
49      Block visit( String line, ByLineSource source ) throws ParseException;
50  }