Interface DestructorTree

All Superinterfaces:

AutoCloseable, DestructorRegistry

All Known Implementing Classes:

DefaultDestructorTree

public interface DestructorTree
extends AutoCloseable, DestructorRegistry

A hierarchical DestructorRegistry that is AutoCloseable.

This interface is often used by ReferencesSelector implementors, and normally by no other kinds of users.

Author:

Laird Nelson

See Also:

• close()
• DestructorRegistry

Nested Class Summary

Nested classes/interfaces inherited from interface org.microbean.reference.DestructorRegistry

DestructorRegistry.Destructor

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this DestructorTree implementation by effectively removing all registered contextual instances and running their affiliated Destructors.
DestructorTree	newChild()	Creates a new child instance of this implementation, or a subtype, registers it with this implementation, using a method reference to its close() method as the DestructorRegistry.Destructor, and returns it.
DestructorRegistry.Destructor	remove(Object instance)	Removes the supplied contextual instance and the DestructorRegistry.Destructor that was registered with it.

Methods inherited from interface org.microbean.reference.DestructorRegistry

register

Method Details

newChild

DestructorTree newChild()

Creates a new child instance of this implementation, or a subtype, registers it with this implementation, using a method reference to its close() method as the DestructorRegistry.Destructor, and returns it.

Returns:

a new (non-null) child instance of this implementation, or a subtype, registered with this implementation such that closing this implementation will also close the child instance

See Also:

• close()
• DestructorRegistry.register(Object, Destructor)

close

void close()

Closes this DestructorTree implementation by effectively removing all registered contextual instances and running their affiliated Destructors.

Specified by:

close in interface AutoCloseable

See Also:

• remove(Object)

remove

DestructorRegistry.Destructor remove(Object instance)

Removes the supplied contextual instance and the DestructorRegistry.Destructor that was registered with it.

The DestructorRegistry.Destructor.destroy() will not be invoked by implementations of this method.

Parameters:

instance - the contextual instance to remove; may be null in which case null will be returned

Returns:

a DestructorRegistry.Destructor registered with the supplied instance, or null if no such DestructorRegistry.Destructor exists