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

Interface BookIo

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
StringROLE
The plexus lookup role.
Method Summary
voidloadFiles(BookContext context, List files)
Loads files in a given context.
BookModelreadBook(File bookDescriptor)
Read a BookModel from a descriptor file.

Field Detail

ROLE

public String ROLE
The plexus lookup role.

Method Detail

loadFiles

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

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

readBook

public BookModel readBook(File bookDescriptor)
Read a BookModel from a descriptor file.

Parameters: bookDescriptor the book descriptor file.

Returns: BookModel

Throws: BookDoxiaException if the model cannot be read.

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