1 package org.apache.maven.doxia.book.services.io;
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.BookDoxiaException;
24 import org.apache.maven.doxia.book.context.BookContext;
25
26 import java.io.File;
27 import java.util.List;
28
29 /**
30 * Common book-related IO methods.
31 *
32 * @author <a href="mailto:trygve.laugstol@objectware.no">Trygve Laugstøl</a>
33 * @version $Id: BookIo.java 1090706 2011-04-09 23:15:28Z hboutemy $
34 */
35 public interface BookIo
36 {
37 /** The plexus lookup role. */
38 String ROLE = BookIo.class.getName();
39
40 /**
41 * Read a BookModel from a descriptor file.
42 *
43 * @param bookDescriptor the book descriptor file.
44 * @return BookModel
45 * @throws org.apache.maven.doxia.book.BookDoxiaException if the model cannot be read.
46 */
47 BookModel readBook( File bookDescriptor )
48 throws BookDoxiaException;
49
50 /**
51 * Loads files in a given context.
52 *
53 * @param context the BookContext.
54 * @param files a list of files.
55 */
56 void loadFiles( BookContext context, List<File> files );
57 }