org.coliper.ibean.proxy.handler

Class FreezableHandler

java.lang.Object

org.coliper.ibean.proxy.handler.StatefulExtensionHandler

org.coliper.ibean.proxy.handler.FreezableHandler

All Implemented Interfaces:

Freezable<Object>, TempFreezable<Object>, ExtensionHandler

public class FreezableHandler
extends StatefulExtensionHandler
implements TempFreezable<Object>

ExtensionHandler implementation for bean extension interface Freezable and TempFreezable.

Field Summary

Fields

Modifier and Type	Field and 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 and Description
FreezableHandler()

Method Summary

Modifier and Type	Method and Description
Object	freeze() Set the bean to immutable and prevents all further setter calls.
Object	interceptSetterCall(IBeanContext<?> context, IBeanFieldMetaInfo fieldMeta, Object newValue, Object proxyInstance) Called as an optional hook with every setter call on an IBean.
boolean	isFrozen()
void	onInitStateful(Object proxyInstance, IBeanTypeMetaInfo<?> metaInfo, IBeanFactory unused) Initialization method for stateful handlers that is called after initialization of the IBean.
Object	unfreeze()

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

FreezableHandler

public FreezableHandler()

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

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

freeze

public Object freeze()

Description copied from interface: Freezable

Set the bean to immutable and prevents all further setter calls.

Specified by:

freeze in interface Freezable<Object>

Returns:

this (the bean itself); used for chaining with setter calls in ModernBeanStyle

isFrozen

public boolean isFrozen()

Specified by:

isFrozen in interface Freezable<Object>

Returns:

true if the bean was switched to immutable with a previous Freezable.freeze() call

unfreeze

public Object unfreeze()

Specified by:

unfreeze in interface TempFreezable<Object>