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 1090706 2011-04-09 23:15:28Z hboutemy $

Author:

Trygve Laugstøl

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ROLE The plexus lookup role.

Method Summary

Methods

Modifier and Type	Method and Description
void	loadFiles(BookContext context, java.util.List<java.io.File> files) Loads files in a given context.
BookModel	readBook(java.io.File bookDescriptor) Read a BookModel from a descriptor file.

Field Detail

ROLE

static final java.lang.String ROLE

The plexus lookup role.

Method Detail

readBook

BookModel readBook(java.io.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,
             java.util.List<java.io.File> files)

Loads files in a given context.

Parameters:

context - the BookContext.

files - a list of files.