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) Deprecated. Use Oven(JBakeConfiguration) instead 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) Deprecated. Use Oven(JBakeConfiguration) instead Creates a new instance of the Oven with references to the source and destination folders.
Oven(JBakeConfiguration config) Create an Oven instance by a JBakeConfiguration
Oven(Utensils utensils) Create an Oven instance with given Utensils

Method Summary

Modifier and Type	Method and Description
void	bake() All the good stuff happens in here...
org.apache.commons.configuration.CompositeConfiguration	getConfig() Deprecated.
java.util.List<java.lang.Throwable>	getErrors()
Utensils	getUtensils()
void	setConfig(org.apache.commons.configuration.CompositeConfiguration config) Deprecated.
void	setupPaths() Deprecated. There is no need for this method anymore. Validation is now part of the instantiation. Can be removed with 3.0.0.

Methods inherited from class java.lang.Object

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

Constructor Detail

Oven

@Deprecated
public Oven(java.io.File source,
                        java.io.File destination,
                        boolean isClearCache)
                 throws java.lang.Exception

Deprecated. Use Oven(JBakeConfiguration) instead 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:

java.lang.Exception - if configuration is not loaded correctly

Oven

@Deprecated
public Oven(java.io.File source,
                        java.io.File destination,
                        org.apache.commons.configuration.CompositeConfiguration config,
                        boolean isClearCache)
                 throws java.lang.Exception

Deprecated. Use Oven(JBakeConfiguration) instead 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

Throws:

java.lang.Exception - if configuration is not loaded correctly

Oven

public Oven(JBakeConfiguration config)

Create an Oven instance by a JBakeConfiguration

It creates default Utensils needed to bake sites.

Parameters:

config - The project configuration. see JBakeConfiguration

Oven

public Oven(Utensils utensils)

Create an Oven instance with given Utensils

Parameters:

utensils - All Utensils necessary to bake

Method Detail

getConfig

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

Deprecated.

setConfig

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

Deprecated.

setupPaths

@Deprecated
public void setupPaths()

Deprecated. There is no need for this method anymore. Validation is now part of the instantiation. Can be removed with 3.0.0.

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

bake

public void bake()

All the good stuff happens in here...

getErrors

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

getUtensils

public Utensils getUtensils()