1 package org.apache.maven.doxia.module.twiki.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 * Parse a twiki syntax block
27 *
28 * @author Juan F. Codagnone
29 * @version $Id: BlockParser.java 785531 2009-06-17 09:47:59Z ltheussl $
30 */
31 public interface BlockParser
32 {
33 /**
34 * <p>accept.</p>
35 *
36 * @param line text line
37 * @return <code>true</code> if this class can handle this line
38 */
39 boolean accept( String line );
40
41 /**
42 * <p>visit.</p>
43 *
44 * @param line a line of text
45 * @param source the source of lines
46 * @return a block
47 * @throws org.apache.maven.doxia.parser.ParseException on error
48 */
49 Block visit( String line, ByLineSource source )
50 throws ParseException;
51 }