View Javadoc

1   package org.apache.maven.doxia.parser.manager;
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.parser.Parser;
23  
24  /**
25   * Handles parser lookups.
26   *
27   * @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
28   * @version $Id: ParserManager.java 746978 2009-02-23 12:20:33Z vsiveton $
29   * @since 1.0
30   */
31  public interface ParserManager
32  {
33      /** The Plexus lookup role. */
34      String ROLE = ParserManager.class.getName();
35  
36      /**
37       * Returns the parser that corresponds to the given id.
38       *
39       * @param id The identifier.
40       * @return The corresponding parser.
41       * @throws org.apache.maven.doxia.parser.manager.ParserNotFoundException if no parser could be found
42       * for the given id.
43       */
44      Parser getParser( String id )
45          throws ParserNotFoundException;
46  }