org.jbake.app

Class Oven

java.lang.Object

org.jbake.app.Oven

public class Oven
extends java.lang.Object

All the baking happens in the Oven!

Constructor Summary

Constructors

Constructor and Description
Oven(java.io.File source, java.io.File destination, boolean isClearCache) Delegate c'tor to prevent API break for the moment.
Oven(java.io.File source, java.io.File destination, org.apache.commons.configuration.CompositeConfiguration config, boolean isClearCache) Creates a new instance of the Oven with references to the source and destination folders.

Method Summary

Modifier and Type	Method and Description
void	bake() All the good stuff happens in here...
org.apache.commons.configuration.CompositeConfiguration	getConfig()
java.util.List<java.lang.Throwable>	getErrors()
void	setConfig(org.apache.commons.configuration.CompositeConfiguration config)
void	setupPaths() Checks source path contains required sub-folders (i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

Oven

public Oven(java.io.File source,
            java.io.File destination,
            boolean isClearCache)
     throws org.apache.commons.configuration.ConfigurationException

Delegate c'tor to prevent API break for the moment.

Parameters:

source - Project source directory

destination - The destination folder

isClearCache - Should the cache be cleaned

Throws:

org.apache.commons.configuration.ConfigurationException - if configuration is not loaded correctly

Oven

public Oven(java.io.File source,
            java.io.File destination,
            org.apache.commons.configuration.CompositeConfiguration config,
            boolean isClearCache)

Creates a new instance of the Oven with references to the source and destination folders.

Parameters:

source - Project source directory

destination - The destination folder

config - Project configuration

isClearCache - Should the cache be cleaned

Method Detail

getConfig

public org.apache.commons.configuration.CompositeConfiguration getConfig()

setConfig

public void setConfig(org.apache.commons.configuration.CompositeConfiguration config)

setupPaths

public void setupPaths()

Checks source path contains required sub-folders (i.e. templates) and setups up variables for them.

Throws:

JBakeException - If template or contents folder don't exist

bake

public void bake()

All the good stuff happens in here...

getErrors

public java.util.List<java.lang.Throwable> getErrors()