Package org.coliper.ibean.proxy.handler

Class ModificationAwareHandler

java.lang.Object

org.coliper.ibean.proxy.handler.StatefulExtensionHandler

org.coliper.ibean.proxy.handler.ModificationAwareHandler

All Implemented Interfaces:

ModificationAware, ModificationAwareExt, ExtensionHandler

public class ModificationAwareHandler
extends StatefulExtensionHandler
implements ModificationAwareExt

ExtensionHandler implementation for bean extension interface ModificationAware and ModificationAwareExt.

Field Summary

Fields

Modifier and Type	Field	Description
static ExtensionSupport	SUPPORT	ExtensionSupport related to this handler supposed to be used when configuring extension handlers in IBeanFactorys, for example in ProxyIBeanFactory.Builder.withInterfaceSupport(ExtensionSupport).

Constructor Summary

Constructors

Constructor	Description
ModificationAwareHandler()

Method Summary

Modifier and Type	Method	Description
boolean	allFieldsModified()	Checks if every field has been set since creation or ModificationAware.resetModified().
String[]	getModifiedFieldNames()	Gives the names of all bean fields that have been modified since creation or respectively since the last call of ModificationAware.resetModified().
Object	interceptSetterCall(IBeanContext<?> context, IBeanFieldMetaInfo fieldMeta, Object newValue, Object proxyInstance)	Called as an optional hook with every setter call on an IBean.
boolean	isModified()
void	onInitStateful(Object proxyInstance, IBeanTypeMetaInfo<?> metaInfo, IBeanFactory unused)	Initialization method for stateful handlers that is called after initialization of the IBean.
void	resetModified()	Sets a bean to not modified.

Methods inherited from class org.coliper.ibean.proxy.handler.StatefulExtensionHandler

handleExtendedInterfaceCall

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.coliper.ibean.proxy.ExtensionHandler

interceptGetterCall

Field Detail

SUPPORT

public static final ExtensionSupport SUPPORT

ExtensionSupport related to this handler supposed to be used when configuring extension handlers in IBeanFactorys, for example in ProxyIBeanFactory.Builder.withInterfaceSupport(ExtensionSupport).

Constructor Detail

ModificationAwareHandler

public ModificationAwareHandler()

Method Detail

onInitStateful

public void onInitStateful(Object proxyInstance,
                           IBeanTypeMetaInfo<?> metaInfo,
                           IBeanFactory unused)

Description copied from interface: ExtensionHandler

Initialization method for stateful handlers that is called after initialization of the IBean. If a handler is registered as stateful a new instance of the ExtensionHandler implementation is created for each new IBean. After the IBean itself and all handlers created this method is called on all stateful handlers. This method should therefore be overwritten if a handler needs some initialization after creation.

The default implementation does nothing.

Specified by:

onInitStateful in interface ExtensionHandler

Parameters:

proxyInstance - the IBean instance

metaInfo - meta information about the IBean

unused - the factory that creates the IBean instance

isModified

public boolean isModified()

Specified by:

isModified in interface ModificationAware

Returns:

true if the bean is dirty, that is, if a setter has been called since creation or last ModificationAware.resetModified()

resetModified

public void resetModified()

Description copied from interface: ModificationAware

Sets a bean to not modified. If the bean was not dirty it does nothing.

Specified by:

resetModified in interface ModificationAware

interceptSetterCall

public Object interceptSetterCall(IBeanContext<?> context,
                                  IBeanFieldMetaInfo fieldMeta,
                                  Object newValue,
                                  Object proxyInstance)

Description copied from interface: ExtensionHandler

Called as an optional hook with every setter call on an IBean. Setter calls on IBeans are handled by the IBean implementation itself but an ExtensionHandler can implement this method to hook into the setter call. It can just peak on the new value or it can even change it or throw an exception.

When you have several extension handlers registered for an IBean type the intercept calls will be called in the order in which the handlers are registered in the ProxyIBeanFactory. See also ProxyIBeanFactory.Builder.withInterfaceSupport(ExtensionSupport).

The default implementation just returns newValue.

Specified by:

interceptSetterCall in interface ExtensionHandler

Parameters:

context - provides meta information about the IBean

fieldMeta - provides meta information about the field related to the setter

newValue - the current new value of the field. This must not match to the initial value given in the setter call of the IBean as the value might have already been changed by intercept calls from other handlers

proxyInstance - the IBean instance itself

Returns:

the value the field is supposed to be set to. If you do not want to change the value just pass the value provided in newValue

getModifiedFieldNames

public String[] getModifiedFieldNames()

Description copied from interface: ModificationAwareExt

Gives the names of all bean fields that have been modified since creation or respectively since the last call of ModificationAware.resetModified().

Specified by:

getModifiedFieldNames in interface ModificationAwareExt

Returns:

a string array containing the names of the modified fields. If no fields have been modified an empty array will be returned. The names of the fields are deducible from the getter and setter names depending on the bean style.
The order of field names returned is random and not be reliable!

allFieldsModified

public boolean allFieldsModified()

Description copied from interface: ModificationAwareExt

Checks if every field has been set since creation or ModificationAware.resetModified(). Can for example be used as a runtime check if an initialization has been complete.

Specified by:

allFieldsModified in interface ModificationAwareExt

Returns:

true if each setter had been called