1 package org.apache.maven.doxia.book.services.indexer;
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.book.model.BookModel;
23 import org.apache.maven.doxia.book.context.BookContext;
24 import org.apache.maven.doxia.book.BookDoxiaException;
25
26 /**
27 * Index a book.
28 *
29 * @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
30 * @version $Id: BookIndexer.java 746976 2009-02-23 12:15:38Z vsiveton $
31 */
32 public interface BookIndexer
33 {
34 /** The plexus lookup role. */
35 String ROLE = BookIndexer.class.getName();
36
37 /**
38 * Index a book.
39 *
40 * @param book the book to index.
41 * @param bookContext the BookContext.
42 * @throws org.apache.maven.doxia.book.BookDoxiaException if the book cannot be indexed.
43 */
44 void indexBook( BookModel book, BookContext bookContext )
45 throws BookDoxiaException;
46 }