org.sitemesh.builder

Class BaseSiteMeshOfflineBuilder<BUILDER extends BaseSiteMeshOfflineBuilder>

java.lang.Object

org.sitemesh.builder.BaseSiteMeshBuilder<BUILDER,OfflineContext,SiteMeshOffline>

org.sitemesh.builder.BaseSiteMeshOfflineBuilder<BUILDER>

Type Parameters:

BUILDER - The type to return from the builder methods. Subclasses should type this as their own class type.

Direct Known Subclasses:

SiteMeshOfflineBuilder

public abstract class BaseSiteMeshOfflineBuilder<BUILDER extends BaseSiteMeshOfflineBuilder>
extends BaseSiteMeshBuilder<BUILDER,OfflineContext,SiteMeshOffline>

Functionality for building a SiteMeshOffline. Inherits common functionality from BaseSiteMeshBuilder.

Clients should use the concrete SiteMeshOfflineBuilder implementation.

Author:

Joe Walnes

See Also:

BaseSiteMeshBuilder, SiteMeshOffline

Constructor Summary

Constructors

Constructor and Description
BaseSiteMeshOfflineBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
abstract SiteMeshOffline	create() Create the SiteMeshOfflineGenerator.
Directory	getDestinationDirectory() Get the destination directory.
Directory	getSourceDirectory() Get the source directory.
BUILDER	setDestinationDirectory(Directory destinationDirectory) Set destination directory, were the processed files will be written to.
BUILDER	setDestinationDirectory(File destinationDirectory) Set destination directory, were the processed files will be written to.
BUILDER	setDestinationDirectory(String destinationDirectoryPath) Set destination directory, were the processed files will be written to.
BUILDER	setSourceDirectory(Directory sourceDirectory) Set source directory, were the unprocessed files will be read from.
BUILDER	setSourceDirectory(File sourceDirectory) Set source directory, were the processed files will be read from.
BUILDER	setSourceDirectory(String sourceDirectoryPath) Set source directory, were the processed files will be read from.

Methods inherited from class org.sitemesh.builder.BaseSiteMeshBuilder

addDecoratorPath, addDecoratorPaths, addDecoratorPaths, addTagRuleBundle, addTagRuleBundles, addTagRuleBundles, clearTagRuleBundles, getContentProcessor, getDecoratorSelector, self, setCustomContentProcessor, setCustomDecoratorSelector, setTagRuleBundles, setTagRuleBundles, setupDefaults

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseSiteMeshOfflineBuilder

public BaseSiteMeshOfflineBuilder()

Method Detail

create

public abstract SiteMeshOffline create()

Create the SiteMeshOfflineGenerator.

Specified by:

create in class BaseSiteMeshBuilder<BUILDER extends BaseSiteMeshOfflineBuilder,OfflineContext,SiteMeshOffline>

setSourceDirectory

public BUILDER setSourceDirectory(Directory sourceDirectory)

Set source directory, were the unprocessed files will be read from.

The Directory abstraction allows for plugging into other storage mechanisms than a standard file system (e.g. in memory, database, etc).

setSourceDirectory

public BUILDER setSourceDirectory(File sourceDirectory)

Set source directory, were the processed files will be read from. This should be a readable directory.

setSourceDirectory

public BUILDER setSourceDirectory(String sourceDirectoryPath)

Set source directory, were the processed files will be read from. This should be a readable directory path, relative to the directory the process is running in.

getSourceDirectory

public Directory getSourceDirectory()
                             throws IllegalStateException

Get the source directory.

Throws:

IllegalStateException - if directory has not been set.

setDestinationDirectory

public BUILDER setDestinationDirectory(Directory destinationDirectory)

Set destination directory, were the processed files will be written to.

The Directory abstraction allows for plugging into other storage mechanisms than a standard file system (e.g. in memory, database, etc).

setDestinationDirectory

public BUILDER setDestinationDirectory(File destinationDirectory)

Set destination directory, were the processed files will be written to. This should be a writable directory.

setDestinationDirectory

public BUILDER setDestinationDirectory(String destinationDirectoryPath)

Set destination directory, were the processed files will be written to. This should be a writable directory path, relative to the directory the process is running in.

getDestinationDirectory

public Directory getDestinationDirectory()
                                  throws IllegalStateException

Get the destination directory.

Throws:

IllegalStateException - if directory has not been set.