com.github.wuic

Class WuicFacadeBuilder

java.lang.Object

com.github.wuic.WuicFacadeBuilder

public class WuicFacadeBuilder
extends Object

This class handles several settings in its state and is required to create a WuicFacade.

Since:

0.5.0

Version:

1.0

Author:

Guillaume DROUET

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	WuicFacadeBuilder.ContextBuilderFacade This class gives a chance to directly define settings for the final ContextBuilder of the built WuicFacade.

Constructor Summary

Constructors

Constructor and Description
WuicFacadeBuilder() Builds an instance with default settings.
WuicFacadeBuilder(BiFunction<String,String,String> properties) Builds an instance with settings initialized with the given properties.

Method Summary

Methods

Modifier and Type	Method and Description
WuicFacade	build() Builds a new facade.
WuicFacadeBuilder.ContextBuilderFacade	contextBuilder() Returns the central ContextBuilder.
WuicFacadeBuilder	contextBuilderConfigurators(ContextBuilderConfigurator... contextBuilderConfigurator) Adds additional context builder configurators.
WuicFacadeBuilder	contextPath(String cp) Sets a context path.
WuicFacadeBuilder	disableMultipleConfigInTagSupport() Disables a re-configuration from view template each time a workflow execution is performed.
WuicFacadeBuilder	noDefaultContextBuilderConfigurator() Indicates that configurator creating default DAOs and engines should not be used when the context is initialized.
WuicFacadeBuilder	noXmlConfiguration() Do not use any wuic.xml file to configure the context.
WuicFacadeBuilder	objectBuilderInspector(ObjectBuilderInspector obi) Sets an inspector for any object creation.
WuicFacadeBuilder	warmUpStrategy(WuicFacade.WarmupStrategy wus) Specifies a WuicFacade.WarmupStrategy.
WuicFacadeBuilder	wuicPropertiesPath(URL properties) Sets a new location for wuic.properties file.
WuicFacadeBuilder	wuicXmlPath(URL xml) Sets a new location for wuic.xml file.

Methods inherited from class java.lang.Object

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

Constructor Detail

WuicFacadeBuilder

public WuicFacadeBuilder()

Builds an instance with default settings.

WuicFacadeBuilder

public WuicFacadeBuilder(BiFunction<String,String,String> properties)

Builds an instance with settings initialized with the given properties. The @link BiFunction} must returns the value corresponding to the key (first parameter) or the second parameter if the return value is null.

Parameters:

properties - the properties

Method Detail

wuicXmlPath

public final WuicFacadeBuilder wuicXmlPath(URL xml)

Sets a new location for wuic.xml file.

Parameters:

xml - the new location

Returns:

this

wuicPropertiesPath

public final WuicFacadeBuilder wuicPropertiesPath(URL properties)

Sets a new location for wuic.properties file.

Parameters:

properties - the new location

Returns:

this

noXmlConfiguration

public final WuicFacadeBuilder noXmlConfiguration()

Do not use any wuic.xml file to configure the context.

Returns:

this

contextPath

public final WuicFacadeBuilder contextPath(String cp)

Sets a context path.

Parameters:

cp - the context path.

Returns:

this

warmUpStrategy

public final WuicFacadeBuilder warmUpStrategy(WuicFacade.WarmupStrategy wus)

Specifies a WuicFacade.WarmupStrategy.

Parameters:

wus - the new strategy

Returns:

this

disableMultipleConfigInTagSupport

public final WuicFacadeBuilder disableMultipleConfigInTagSupport()

Disables a re-configuration from view template each time a workflow execution is performed.

Returns:

this

noDefaultContextBuilderConfigurator

public final WuicFacadeBuilder noDefaultContextBuilderConfigurator()

Indicates that configurator creating default DAOs and engines should not be used when the context is initialized.

Returns:

this

objectBuilderInspector

public final WuicFacadeBuilder objectBuilderInspector(ObjectBuilderInspector obi)

Sets an inspector for any object creation.

Parameters:

obi - the ObjectBuilderInspector

Returns:

this

contextBuilderConfigurators

public final WuicFacadeBuilder contextBuilderConfigurators(ContextBuilderConfigurator... contextBuilderConfigurator)

Adds additional context builder configurators.

Parameters:

contextBuilderConfigurator - additional context builder configurator

Returns:

this

contextBuilder

public final WuicFacadeBuilder.ContextBuilderFacade contextBuilder()

Returns the central ContextBuilder.

Returns:

the context builder

build

public WuicFacade build()
                 throws WuicException

Builds a new facade.

Returns:

the facade using the settings defines in this builder

Throws:

WuicException - if facade cannot be built