org.sitemesh.builder

Class BaseSiteMeshFilterBuilder<BUILDER extends BaseSiteMeshBuilder>

java.lang.Object

org.sitemesh.builder.BaseSiteMeshBuilder<BUILDER,WebAppContext,javax.servlet.Filter>

org.sitemesh.builder.BaseSiteMeshFilterBuilder<BUILDER>

Type Parameters:

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

Direct Known Subclasses:

SiteMeshFilterBuilder

public abstract class BaseSiteMeshFilterBuilder<BUILDER extends BaseSiteMeshBuilder>
extends BaseSiteMeshBuilder<BUILDER,WebAppContext,javax.servlet.Filter>

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

Clients should use the concrete SiteMeshFilterBuilder implementation.

Author:

Joe Walnes

See Also:

BaseSiteMeshBuilder, SiteMeshFilter

Constructor Summary

Constructors

Constructor and Description
BaseSiteMeshFilterBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
BUILDER	addExcludedPath(String exclude) Add a path to be excluded by SiteMesh.
abstract javax.servlet.Filter	create() Create the SiteMesh Filter.
Selector	getSelector() Get configured Selector.
boolean	isIncludeErrorPages() If error pages should be also decorated.
BUILDER	setCustomSelector(Selector selector) Set a custom Selector.
BUILDER	setIncludeErrorPages(boolean includeErrorPages) Set if the error pages should be decorated as well.
BUILDER	setMimeTypes(List<String> mimeTypes) Set MIME types that the Filter should intercept.
BUILDER	setMimeTypes(String... mimeTypes) Set MIME types that the Filter should intercept.
protected void	setupDefaults() See setupDefaults().

Methods inherited from class org.sitemesh.builder.BaseSiteMeshBuilder

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseSiteMeshFilterBuilder

public BaseSiteMeshFilterBuilder()

Method Detail

create

public abstract javax.servlet.Filter create()

Create the SiteMesh Filter.

Specified by:

create in class BaseSiteMeshBuilder<BUILDER extends BaseSiteMeshBuilder,WebAppContext,javax.servlet.Filter>

setupDefaults

protected void setupDefaults()

See setupDefaults(). In addition to the parent setup, this also calls setMimeTypes(String[]) with {"text/html"}.

Overrides:

setupDefaults in class BaseSiteMeshBuilder<BUILDER extends BaseSiteMeshBuilder,WebAppContext,javax.servlet.Filter>

addExcludedPath

public BUILDER addExcludedPath(String exclude)

Add a path to be excluded by SiteMesh.

setMimeTypes

public BUILDER setMimeTypes(String... mimeTypes)

Set MIME types that the Filter should intercept. The default is {"text/html"}.

Note: The MIME types are ignored if setCustomSelector(Selector) is called.

setMimeTypes

public BUILDER setMimeTypes(List<String> mimeTypes)

Set MIME types that the Filter should intercept. The default is {"text/html"}.

Note: The MIME types are ignored if setCustomSelector(Selector) is called.

setIncludeErrorPages

public BUILDER setIncludeErrorPages(boolean includeErrorPages)

Set if the error pages should be decorated as well. The default is false.

Note: The error pages inclusion is ignored if setCustomSelector(Selector) is called.

setCustomSelector

public BUILDER setCustomSelector(Selector selector)

Set a custom Selector.

Note: If this is called, it will override any MIME types passed to setMimeTypes(String[]) as these are specific to the default Selector.

getSelector

public Selector getSelector()

Get configured Selector.

isIncludeErrorPages

public boolean isIncludeErrorPages()

If error pages should be also decorated.

Returns:

if error pages should be also decorated.