Package cn.sliew.milky.dsl

Class AbstractConfigurer<O,B extends Builder<O>>

java.lang.Object

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

Type Parameters:

O - The Object being built by B

B - The Builder that is building O and is configured by AbstractConfigurer

All Implemented Interfaces:

Configurer<O,B>

public abstract class AbstractConfigurer<O,B extends Builder<O>>
extends Object
implements Configurer<O,B>

A base class for Configurer that allows subclasses to only implement the methods they are interested in. It also provides a mechanism for using the Configurer and when done gaining access to the Builder that is being configured.

Constructor Summary

Constructors

Constructor	Description
AbstractConfigurer()

Method Summary

Modifier and Type	Method	Description
B	and()	Return the Builder when done using the Configurer.
void	configure(B builder)	Configure the Builder by setting the necessary properties on the Builder.
protected B	getBuilder()	Gets the Builder.
void	init(B builder)	Initialize the Builder.
void	setBuilder(B builder)	Sets the Builder to be used.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractConfigurer

public AbstractConfigurer()

Method Detail

init

public void init(B builder)
          throws Exception

Description copied from interface: Configurer

Initialize the Builder. Here only shared state should be created and modified, but not properties on the Builder used for building the object. This ensures that the Configurer.configure(Builder) method uses the correct shared objects when building. Configurers should be applied here.

Specified by:

init in interface Configurer<O,B extends Builder<O>>

Throws:

Exception

configure

public void configure(B builder)
               throws Exception

Description copied from interface: Configurer

Configure the Builder by setting the necessary properties on the Builder.

Specified by:

configure in interface Configurer<O,B extends Builder<O>>

Throws:

Exception

and

public B and()

Return the Builder when done using the Configurer. This is useful for method chaining.

Returns:

the Builder for further customizations

getBuilder

protected final B getBuilder()

Gets the Builder. Cannot be null.

Returns:

the Builder

Throws:

IllegalStateException - if Builder is null

setBuilder

public void setBuilder(B builder)

Sets the Builder to be used. This is automatically set when using AbstractConfiguredBuilder.apply(AbstractConfigurer)

Parameters:

builder - the Builder to set