public class DestructionAwareAttributeHolder
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
private java.util.Map<java.lang.String,java.lang.Object> |
attributes
The map containing the registered attributes.
|
private java.util.Map<java.lang.String,java.lang.Runnable> |
registeredDestructionCallbacks
The optional map having any destruction callbacks registered using the
name of the bean as the key.
|
Constructor and Description |
---|
DestructionAwareAttributeHolder() |
Modifier and Type | Method and Description |
---|---|
void |
clear()
Clears the map by removing all registered attribute values and invokes
every destruction callback registered.
|
java.lang.Object |
getAttribute(java.lang.String name)
Returns the attribute having the specified name, if available,
null otherwise. |
java.util.Map<java.lang.String,java.lang.Object> |
getAttributeMap()
Returns the map representation of the registered attributes directly.
|
java.lang.Runnable |
getDestructionCallback(java.lang.String name,
boolean remove)
Returns the destruction callback, if any registered for the attribute
with the given name or
null if no such callback was
registered. |
void |
registerDestructionCallback(java.lang.String name,
java.lang.Runnable callback)
Register a callback to be executed on destruction of the specified object
in the scope (or at destruction of the entire scope, if the scope does
not destroy individual objects but rather only terminates in its
entirety).
|
java.lang.Object |
removeAttribute(java.lang.String name)
Remove the object with the given
name from the underlying
scope. |
java.lang.Object |
setAttribute(java.lang.String name,
java.lang.Object value)
Puts the given object with the specified name as an attribute to the
underlying map.
|
private final java.util.Map<java.lang.String,java.lang.Object> attributes
private java.util.Map<java.lang.String,java.lang.Runnable> registeredDestructionCallbacks
public java.util.Map<java.lang.String,java.lang.Object> getAttributeMap()
public java.lang.Object getAttribute(java.lang.String name)
null
otherwise.name
- the name of the attribute to be returnednull
if not availablepublic java.lang.Object setAttribute(java.lang.String name, java.lang.Object value)
name
- the name of the attributevalue
- the value to be storednull
otherwisepublic java.lang.Object removeAttribute(java.lang.String name)
name
from the underlying
scope.
Returns null
if no object was found; otherwise returns the
removed Object
.
Note that an implementation should also remove a registered destruction callback for the specified object, if any. It does, however, not need to execute a registered destruction callback in this case, since the object will be destroyed by the caller (if appropriate).
Note: This is an optional operation. Implementations may throw
UnsupportedOperationException
if they do not support explicitly
removing an object.
name
- the name of the object to removenull
if no object was presentregisterDestructionCallback(java.lang.String, java.lang.Runnable)
public void clear()
public void registerDestructionCallback(java.lang.String name, java.lang.Runnable callback)
Note: This is an optional operation. This method will only be called for scoped beans with actual destruction configuration (DisposableBean, destroy-method, DestructionAwareBeanPostProcessor). Implementations should do their best to execute a given callback at the appropriate time. If such a callback is not supported by the underlying runtime environment at all, the callback must be ignored and a corresponding warning should be logged.
Note that 'destruction' refers to to automatic destruction of the object
as part of the scope's own lifecycle, not to the individual scoped object
having been explicitly removed by the application. If a scoped object
gets removed via this facade's removeAttribute(String)
method,
any registered destruction callback should be removed as well, assuming
that the removed object will be reused or manually destroyed.
name
- the name of the object to execute the destruction callback forcallback
- the destruction callback to be executed. Note that the
passed-in Runnable will never throw an exception, so it can
safely be executed without an enclosing try-catch block.
Furthermore, the Runnable will usually be serializable,
provided that its target object is serializable as well.DisposableBean
,
AbstractBeanDefinition.getDestroyMethodName()
,
DestructionAwareBeanPostProcessor
public java.lang.Runnable getDestructionCallback(java.lang.String name, boolean remove)
null
if no such callback was
registered.name
- the name of the registered callback requestedremove
- true
, if the callback should be removed after
this call, false
, if it staysnull
otherwise