org.apache.maven.doxia.book.context
Class BookContext

java.lang.Object
  org.apache.maven.doxia.book.context.BookContext

public class BookContext
extends java.lang.Object

Context to render a book.

Version:

$Id: BookContext.java 572956 2007-09-05 14:22:50Z ltheussl $

Author:

Trygve Laugstøl

Nested Class Summary

static class

BookContext.BookFile Represents a BookFile.

Constructor Summary

BookContext()

Method Summary

org.apache.maven.doxia.book.model.BookModel	getBook() Return the BookModel of this BookContext.
java.util.Map	getFiles() Return the files of this BookContext.
BookIndex	getIndex() Return the index of this BookContext.
java.io.File	getOutputDirectory() Return the outputDirectory of this BookContext.
void	setBook(org.apache.maven.doxia.book.model.BookModel book) Set the BookModel of this BookContext.
void	setFiles(java.util.Map files) Set the files of this BookContext.
void	setIndex(BookIndex index) Set the index of this BookContext.
void	setOutputDirectory(java.io.File outputDirectory) Set the outputDirectory of this BookContext.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BookContext

public BookContext()

Method Detail

getBook

public org.apache.maven.doxia.book.model.BookModel getBook()

Return the BookModel of this BookContext.

Returns:

BookModel.

setBook

public void setBook(org.apache.maven.doxia.book.model.BookModel book)

Set the BookModel of this BookContext.

Parameters:

book - the BookModel.

getFiles

public java.util.Map getFiles()

Return the files of this BookContext.

Returns:

Map. A new HashMap is constructed if the current Map is null.

setFiles

public void setFiles(java.util.Map files)

Set the files of this BookContext.

Parameters:

files - the Map of files.

getOutputDirectory

public java.io.File getOutputDirectory()

Return the outputDirectory of this BookContext.

Returns:

File.

setOutputDirectory

public void setOutputDirectory(java.io.File outputDirectory)

Set the outputDirectory of this BookContext.

Parameters:

outputDirectory - the output directory.

getIndex

public BookIndex getIndex()

Return the index of this BookContext.

Returns:

BookIndex.

setIndex

public void setIndex(BookIndex index)

Set the index of this BookContext.

Parameters:

index - the index to set.