org.apache.maven.doxia.book.context

Class BookContext

public class BookContext extends 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 classBookContext.BookFile
Represents a BookFile.
Method Summary
BookModelgetBook()
Return the BookModel of this BookContext.
MapgetFiles()
Return the files of this BookContext.
BookIndexgetIndex()
Return the index of this BookContext.
FilegetOutputDirectory()
Return the outputDirectory of this BookContext.
voidsetBook(BookModel book)
Set the BookModel of this BookContext.
voidsetFiles(Map files)
Set the files of this BookContext.
voidsetIndex(BookIndex index)
Set the index of this BookContext.
voidsetOutputDirectory(File outputDirectory)
Set the outputDirectory of this BookContext.

Method Detail

getBook

public BookModel getBook()
Return the BookModel of this BookContext.

Returns: BookModel.

getFiles

public Map getFiles()
Return the files of this BookContext.

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

getIndex

public BookIndex getIndex()
Return the index of this BookContext.

Returns: BookIndex.

getOutputDirectory

public File getOutputDirectory()
Return the outputDirectory of this BookContext.

Returns: File.

setBook

public void setBook(BookModel book)
Set the BookModel of this BookContext.

Parameters: book the BookModel.

setFiles

public void setFiles(Map files)
Set the files of this BookContext.

Parameters: files the Map of files.

setIndex

public void setIndex(BookIndex index)
Set the index of this BookContext.

Parameters: index the index to set.

setOutputDirectory

public void setOutputDirectory(File outputDirectory)
Set the outputDirectory of this BookContext.

Parameters: outputDirectory the output directory.

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