Package cn.sliew.milky.dsl

Class AbstractConfiguredBuilder<O,B extends ConfigurableBuilder<O,B>>

java.lang.Object

cn.sliew.milky.dsl.AbstractBuilder<O>

cn.sliew.milky.dsl.AbstractConfiguredBuilder<O,B>

Type Parameters:

O - The object that this builder returns

B - The type of this builder (that is returned by the base class)

All Implemented Interfaces:

Builder<O>, ConfigurableBuilder<O,B>

public abstract class AbstractConfiguredBuilder<O,B extends ConfigurableBuilder<O,B>>
extends AbstractBuilder<O>
implements ConfigurableBuilder<O,B>

A base Builder that allows Configurer to be applied to it. This makes modifying the Builder a strategy that can be customized and broken up into a number of Configurer objects that have more specific goals than that of the Builder.

Constructor Summary

Constructors

Constructor	Description
AbstractConfiguredBuilder()

Method Summary

Modifier and Type	Method	Description
<C extends AbstractConfigurer<O,B>> C	apply(C configurer)	Applies a AbstractConfigurer to this Builder and invokes AbstractConfigurer.setBuilder(Builder).
protected void	beforeConfigure()	Invoked prior to invoking each Configurer.configure(Builder) method.
protected void	beforeInit()	Invoked prior to invoking each Configurer.init(Builder) method.
protected O	doBuild()	Executes the build using the Configurer's that have been applied using the following steps: Invokes beforeInit() for any subclass to hook into Invokes Configurer.init(Builder) for any Configurer that was applied to this builder. Invokes beforeConfigure() for any subclass to hook into Invokes performBuild() which actually builds the Object
<C extends Configurer<O,B>> C	getConfigurer(Class<C> clazz)	Gets the Configurer by its class name or null if not found.
O	getOrBuild()	Similar to AbstractBuilder.build() and AbstractBuilder.getObject() but checks the state to determine if AbstractBuilder.build() needs to be called first.
protected abstract O	performBuild()	Subclasses must implement this method to build the object that is being returned.
<C extends Configurer<O,B>> C	removeConfigurer(Class<C> clazz)	Removes and returns the Configurer by its class name or null if not found.

Methods inherited from class cn.sliew.milky.dsl.AbstractBuilder

build, getObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface cn.sliew.milky.dsl.Builder

build

Constructor Detail

AbstractConfiguredBuilder

public AbstractConfiguredBuilder()

Method Detail

getOrBuild

public O getOrBuild()

Similar to AbstractBuilder.build() and AbstractBuilder.getObject() but checks the state to determine if AbstractBuilder.build() needs to be called first.

Returns:

the result of AbstractBuilder.build() or AbstractBuilder.getObject(). If an error occurs while building, returns null.

doBuild

protected final O doBuild()
                   throws Exception

Executes the build using the Configurer's that have been applied using the following steps:

• Invokes beforeInit() for any subclass to hook into
• Invokes Configurer.init(Builder) for any Configurer that was applied to this builder.
• Invokes beforeConfigure() for any subclass to hook into
• Invokes performBuild() which actually builds the Object

Specified by:

doBuild in class AbstractBuilder<O>

Returns:

the object that should be returned by AbstractBuilder.build().

Throws:

Exception - if an error occurs

beforeInit

protected void beforeInit()
                   throws Exception

Invoked prior to invoking each Configurer.init(Builder) method. Subclasses may override this method to hook into the lifecycle without using a Configurer.

Throws:

Exception

beforeConfigure

protected void beforeConfigure()
                        throws Exception

Invoked prior to invoking each Configurer.configure(Builder) method. Subclasses may override this method to hook into the lifecycle without using a Configurer.

Throws:

Exception

performBuild

protected abstract O performBuild()
                           throws Exception

Subclasses must implement this method to build the object that is being returned.

Returns:

the Object to be buit or null if the implementation allows it

Throws:

Exception

apply

public <C extends AbstractConfigurer<O,B>> C apply(C configurer)
                                                  throws Exception

Applies a AbstractConfigurer to this Builder and invokes AbstractConfigurer.setBuilder(Builder).

Parameters:

configurer -

Returns:

the AbstractConfigurer for further customizations

Throws:

Exception

apply

public <C extends Configurer<O,B>> C apply(C configurer)
                                          throws Exception

Applies a Configurer to this Builder overriding any Configurer of the exact same class. Note that object hierarchies are not considered.

Parameters:

configurer -

Returns:

the AbstractConfigurer for further customizations

Throws:

Exception

getConfigurer

public <C extends Configurer<O,B>> C getConfigurer(Class<C> clazz)

Gets the Configurer by its class name or null if not found. Note that object hierarchies are not considered.

Specified by:

getConfigurer in interface ConfigurableBuilder<O,B extends ConfigurableBuilder<O,B>>

Parameters:

clazz -

Returns:

the Configurer for further customizations

removeConfigurer

public <C extends Configurer<O,B>> C removeConfigurer(Class<C> clazz)

Removes and returns the Configurer by its class name or null if not found. Note that object hierarchies are not considered.

Specified by:

removeConfigurer in interface ConfigurableBuilder<O,B extends ConfigurableBuilder<O,B>>

Parameters:

clazz -

Returns: