com.github.wuic.config

Interface ObjectBuilder<T>

Type Parameters:

T - the built type

All Known Implementing Classes:

AbstractObjectBuilder

public interface ObjectBuilder<T>

This interface describes the contract for a class which implements the builder pattern inside WUIC. Because objects can be built in so many different ways, the builder has very abstract behavior. Its contains a property(String, Object) method to configure the state of the built objects.

Since:

0.4.0

Version:

1.0

Author:

Guillaume DROUET

Method Summary

Methods

Modifier and Type	Method and Description
T	build() Builds a new NutDao thanks to the current state of this builder.
ObjectBuilder<T>	disableSupport(String key, Object value) Disables the support of a property with a particular value.
Map<String,Object>	getProperties() Gets the property Map.
Object	property(String key) Gets the property identified by the given key.
ObjectBuilder<T>	property(String key, Object value) Decorates this builder with a property.

Method Detail

property

ObjectBuilder<T> property(String key,
                        Object value)

Decorates this builder with a property.

Throws an IllegalArgumentException if the property key is not supported or if the value is incorrect.

Parameters:

key - the key

value - the value

Returns:

a builder taking in consideration the new property

disableSupport

ObjectBuilder<T> disableSupport(String key,
                              Object value)

Disables the support of a property with a particular value. Any future setting which match the given key/value pair (when calling property(String, Object)) will result in an IllegalArgumentException.

Parameters:

key - the key

value - the value

Returns:

a builder taking in consideration the new setting

property

Object property(String key)

Gets the property identified by the given key.

Throws an IllegalArgumentException if the property key is not supported.

Parameters:

key - the key

Returns:

the value associated to the key

getProperties

Map<String,Object> getProperties()

Gets the property Map.

Returns:

the properties

build

T build()

Builds a new NutDao thanks to the current state of this builder.

If the NutDao could not be built, then an IllegalArgumentException should be thrown.

Returns:

the new NutDao