com.acsinet_solutions.util.build
Interface Builder

All Known Implementing Classes:

BlockBuilder, ConfigurationBuilder

public interface Builder

This interface represents a builder, which is a facade object that is in charge of building something.

Author:

Santiago Arriaga

Method Summary

void	enterObject(java.lang.String name, java.lang.String className) Add a new object to the builder
void	exitObject() Exit the current object instance.
java.lang.Object	getObject() Get the built object.
void	setValue(java.lang.String name, java.lang.Object value) Set a value to the current target object

Method Detail

enterObject

void enterObject(java.lang.String name,
                 java.lang.String className)
                 throws BuildException

Add a new object to the builder

Parameters:

name - The not-null not-empty name of the type instance

className - The maybe-null class type of the instance

Throws:

BuildException - Thrown if any building error occurs

setValue

void setValue(java.lang.String name,
              java.lang.Object value)
              throws BuildException

Set a value to the current target object

Parameters:

name - The not-null not-empty name of the attribute to be set

value - The maybe-null value of the given attribute

Throws:

BuildException - Thrown if any building error occurs

exitObject

void exitObject()
                throws BuildException

Exit the current object instance. Every exitObject() call is issued for a call of enterObject();

Throws:

BuildException - Thrown if any building error occurs

getObject

java.lang.Object getObject()
                           throws BuildException

Get the built object.

Returns:

A not-null not-empty Object instance

Throws:

BuildException - Thrown if any building error occurs