org.apache.maven.doxia.book.context

Class BookContext

java.lang.Object

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

public class BookContext
extends Object

Context to render a book.

Version:

$Id: BookContext.java 746976 2009-02-23 12:15:38Z vsiveton $

Author:

Trygve Laugstøl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BookContext.BookFile Represents a BookFile.

Constructor Summary

Constructors

Constructor and Description
BookContext()

Method Summary

Methods

Modifier and Type	Method and Description
BookModel	getBook() Return the BookModel of this BookContext.
Map	getFiles() Return the files of this BookContext.
BookIndex	getIndex() Return the index of this BookContext.
String	getInputEncoding() Getter for the field inputEncoding.
Locale	getLocale() Getter for the field locale.
File	getOutputDirectory() Return the outputDirectory of this BookContext.
String	getOutputEncoding() Getter for the field outputEncoding.
void	setBook(BookModel book) Set the BookModel of this BookContext.
void	setFiles(Map files) Set the files of this BookContext.
void	setIndex(BookIndex index) Set the index of this BookContext.
void	setInputEncoding(String inputEncoding) Setter for the field inputEncoding.
void	setLocale(Locale locale) Setter for the field locale.
void	setOutputDirectory(File outputDirectory) Set the outputDirectory of this BookContext.
void	setOutputEncoding(String outputEncoding) Setter for the field outputEncoding.

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 BookModel getBook()

Return the BookModel of this BookContext.

Returns:

BookModel.

setBook

public void setBook(BookModel book)

Set the BookModel of this BookContext.

Parameters:

book - the BookModel.

getFiles

public 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(Map files)

Set the files of this BookContext.

Parameters:

files - the Map of files.

getOutputDirectory

public File getOutputDirectory()

Return the outputDirectory of this BookContext.

Returns:

File.

setOutputDirectory

public void setOutputDirectory(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.

getLocale

public Locale getLocale()

Getter for the field locale.

Returns:

the locale

Since:

1.1

setLocale

public void setLocale(Locale locale)

Setter for the field locale.

Parameters:

locale - the locale to set

Since:

1.1

getInputEncoding

public String getInputEncoding()

Getter for the field inputEncoding.

Returns:

the inputEncoding

Since:

1.1

setInputEncoding

public void setInputEncoding(String inputEncoding)

Setter for the field inputEncoding.

Parameters:

inputEncoding - the inputEncoding to set

Since:

1.1

getOutputEncoding

public String getOutputEncoding()

Getter for the field outputEncoding.

Returns:

the outputEncoding

Since:

1.1

setOutputEncoding

public void setOutputEncoding(String outputEncoding)

Setter for the field outputEncoding.

Parameters:

outputEncoding - the outputEncoding to set

Since:

1.1