net.sf.beanlib.spi
Interface BeanPopulatorBaseSpi

All Known Subinterfaces:

BeanPopulatorSpi, BeanTransformerSpi

All Known Implementing Classes:

BeanPopulator, BeanTransformer, Hibernate3BeanReplicator, Hibernate3BeanTransformer, HibernateBeanReplicator

public interface BeanPopulatorBaseSpi

The base interface of the Bean Populator SPI. This SPI provides various options to control the propagation behavior of JavaBean properties.

Author:

Joe D. Velopar

Method Summary

BeanPopulationExceptionHandler	getBeanPopulationExceptionHandler() Returns the exception handler configured for bean population.
BeanPopulatorBaseConfig	getBeanPopulatorBaseConfig() Returns the other configuration options as a single configuration object.
BeanSourceHandler	getBeanSourceHandler() Returns the call-back configured that would be invoked after the property value has been retrieved from the source bean, but before being propagated across to the target bean.
DetailedPropertyFilter	getDetailedPropertyFilter() Returns the detailed property filter configured.
PropertyFilter	getPropertyFilter() Returns the property filter configured.
BeanMethodFinder	getReaderMethodFinder() Returns the finder configured to find the property getter methods of a source JavaBean.
BeanMethodCollector	getSetterMethodCollector() Returns the collector configured to collect the property setter methods of a target JavaBean.
BeanPopulatorBaseSpi	initBeanPopulationExceptionHandler(BeanPopulationExceptionHandler beanPopulationExceptionHandler) Used to configure a handler to handle any exception thrown.
BeanPopulatorBaseSpi	initBeanPopulatorBaseConfig(BeanPopulatorBaseConfig baseConfig) Used to conveniently provide all the other configuration options as a single configuration object.
BeanPopulatorBaseSpi	initBeanSourceHandler(BeanSourceHandler beanSourceHandler) Used to configure a call-back (to produce whatever side-effects deemed necessary) that is invoked after the property value has been retrieved from the source bean, but before being propagated across to the target bean.
BeanPopulatorBaseSpi	initDebug(boolean debug) Used to control whether debug messages should be logged.
BeanPopulatorBaseSpi	initDetailedPropertyFilter(DetailedPropertyFilter detailedPropertyFilter) Used to configure a detailed prperty filter (which has more context information) to determine whether a specific property should be propagated from the source bean to the target bean.
BeanPopulatorBaseSpi	initPropertyFilter(PropertyFilter propertyFilter) Used to configure a property filter to determine whether a specific property should be propagated from a source bean to a target bean.
BeanPopulatorBaseSpi	initReaderMethodFinder(BeanMethodFinder readerMethodFinder) Used to configure a finder to find the property getter methods of a source JavaBean.
BeanPopulatorBaseSpi	initSetterMethodCollector(BeanMethodCollector setterMethodCollector) Used to configure a collector to collect the property setter methods of a target JavaBean.
boolean	isDebug() Returns true if debug message logging is on; false otherwise.

Method Detail

initPropertyFilter

BeanPopulatorBaseSpi initPropertyFilter(PropertyFilter propertyFilter)

Used to configure a property filter to determine whether a specific property should be propagated from a source bean to a target bean.

Parameters:

propertyFilter - is similar to DetailedPropertyFilter but with a simpler API that is used to control whether a specific property should be propagated from a source bean to a target bean.

Returns:

the current object (ie this) for method chaining purposes.

getPropertyFilter

PropertyFilter getPropertyFilter()

Returns the property filter configured.

initDetailedPropertyFilter

BeanPopulatorBaseSpi initDetailedPropertyFilter(DetailedPropertyFilter detailedPropertyFilter)

Used to configure a detailed prperty filter (which has more context information) to determine whether a specific property should be propagated from the source bean to the target bean.

Parameters:

detailedPropertyFilter - is used to control whether a specific property should be propagated from the source bean to the target bean.

Returns:

the current object (ie this) for method chaining purposes.

getDetailedPropertyFilter

DetailedPropertyFilter getDetailedPropertyFilter()

Returns the detailed property filter configured.

initBeanSourceHandler

BeanPopulatorBaseSpi initBeanSourceHandler(BeanSourceHandler beanSourceHandler)

Used to configure a call-back (to produce whatever side-effects deemed necessary) that is invoked after the property value has been retrieved from the source bean, but before being propagated across to the target bean.

Parameters:

beanSourceHandler - can be used to act as a call-back (to produce whatever side-effects deemed necessary) after the property value has been retrieved from the source bean, but before being propagated across to the target bean.

Returns:

the current object (ie this) for method chaining purposes.

getBeanSourceHandler

BeanSourceHandler getBeanSourceHandler()

Returns the call-back configured that would be invoked after the property value has been retrieved from the source bean, but before being propagated across to the target bean.

initReaderMethodFinder

BeanPopulatorBaseSpi initReaderMethodFinder(BeanMethodFinder readerMethodFinder)

Used to configure a finder to find the property getter methods of a source JavaBean.

Parameters:

readerMethodFinder - can be used to find the property getter methods of a source JavaBean.

Returns:

the current object (ie this) for method chaining purposes.

getReaderMethodFinder

BeanMethodFinder getReaderMethodFinder()

Returns the finder configured to find the property getter methods of a source JavaBean.

initSetterMethodCollector

BeanPopulatorBaseSpi initSetterMethodCollector(BeanMethodCollector setterMethodCollector)

Used to configure a collector to collect the property setter methods of a target JavaBean.

Parameters:

setterMethodCollector - can be used to collect the property setter methods of a target JavaBean.

Returns:

the current object (ie this) for method chaining purposes.

getSetterMethodCollector

BeanMethodCollector getSetterMethodCollector()

Returns the collector configured to collect the property setter methods of a target JavaBean.

initBeanPopulationExceptionHandler

BeanPopulatorBaseSpi initBeanPopulationExceptionHandler(BeanPopulationExceptionHandler beanPopulationExceptionHandler)

Used to configure a handler to handle any exception thrown.

Parameters:

beanPopulationExceptionHandler - can be used to handle any exception thrown.

Returns:

the current object (ie this) for method chaining purposes.

getBeanPopulationExceptionHandler

BeanPopulationExceptionHandler getBeanPopulationExceptionHandler()

Returns the exception handler configured for bean population.

initDebug

BeanPopulatorBaseSpi initDebug(boolean debug)

Used to control whether debug messages should be logged.

Returns:

the current object (ie this) for method chaining purposes.

isDebug

boolean isDebug()

Returns true if debug message logging is on; false otherwise.

initBeanPopulatorBaseConfig

BeanPopulatorBaseSpi initBeanPopulatorBaseConfig(BeanPopulatorBaseConfig baseConfig)

Used to conveniently provide all the other configuration options as a single configuration object.

Parameters:

baseConfig - is used to conveniently group all the other initializable options into a single unit.

Returns:

the current object (ie this) for method chaining purposes.

getBeanPopulatorBaseConfig

BeanPopulatorBaseConfig getBeanPopulatorBaseConfig()

Returns the other configuration options as a single configuration object.