net.sf.jguiraffe.gui.builder

Interface BeanBuilderResult

public interface BeanBuilderResult

Definition of an interface for accessing the results of a BeanBuilder.

A bean builder processes a script with bean definitions, creates BeanProvider objects from them and stores these providers in BeanStore objects. An arbitrary number of BeanStore objects may be created during a builder operation, which can be organized in a hierarchical structure.

This interface allows access to the BeanStore objects created by the bean builder. They can be listed or queried by name. A client can thus obtain exactly the store objects it needs. Further, there is some information available about helper objects that have been used during processing of the builder script.

Version:

$Id: BeanBuilderResult.java 205 2012-01-29 18:29:57Z oheger $

Author:

Oliver Heger

Method Summary

Modifier and Type	Method and Description
BeanStore	getBeanStore(String name) Returns the BeanStore with the given name.
Set<String>	getBeanStoreNames() Returns a set with the names of the existing bean stores.
ClassLoaderProvider	getClassLoaderProvider() Returns the ClassLoaderProvider that was used by the builder during script processing.
InvocationHelper	getInvocationHelper() Returns the InvocationHelper object that was used by builder during script processing.

Method Detail

getBeanStoreNames

Set<String> getBeanStoreNames()

Returns a set with the names of the existing bean stores.

Returns:

a set with the names of the bean stores

getBeanStore

BeanStore getBeanStore(String name)

Returns the BeanStore with the given name. The name can be null, then the root BeanStore of the builder operation is returned.

Parameters:

name - the name of the desired BeanStore

Returns:

the BeanStore with this name

Throws:

NoSuchElementException - if there is no such BeanStore

getClassLoaderProvider

ClassLoaderProvider getClassLoaderProvider()

Returns the ClassLoaderProvider that was used by the builder during script processing.

Returns:

the ClassLoaderProvider

getInvocationHelper

InvocationHelper getInvocationHelper()

Returns the InvocationHelper object that was used by builder during script processing. This object also contains the ConversionHelper with all registered type converters. So this information may be of interest for a client. It is also required for releasing a builder result.

Returns:

the InvocationHelper used by the builder