org.apache.maven.doxia.book.services.io
Interface BookIo

All Known Implementing Classes:
DefaultBookIo

public interface BookIo

Common book-related IO methods.

Version:
$Id: BookIo.java 572956 2007-09-05 14:22:50Z ltheussl $
Author:
Trygve Laugstøl

Field Summary
static String ROLE
          The plexus lookup role.
 
Method Summary
 void loadFiles(BookContext context, List files)
          Loads files in a given context.
 org.apache.maven.doxia.book.model.BookModel readBook(File bookDescriptor)
          Read a BookModel from a descriptor file.
 

Field Detail

ROLE

static final String ROLE
The plexus lookup role.

Method Detail

readBook

org.apache.maven.doxia.book.model.BookModel readBook(File bookDescriptor)
                                                     throws BookDoxiaException
Read a BookModel from a descriptor file.

Parameters:
bookDescriptor - the book descriptor file.
Returns:
BookModel
Throws:
BookDoxiaException - if the model cannot be read.

loadFiles

void loadFiles(BookContext context,
               List files)
Loads files in a given context.

Parameters:
context - the BookContext.
files - a list of files.


Copyright © 2005-2011 Apache Software Foundation. All Rights Reserved.