Module org.microbean.bean

Package org.microbean.bean

Interface AutoCloseableRegistry

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DefaultAutoCloseableRegistry

public interface AutoCloseableRegistry
extends AutoCloseable

A reigstry of AutoCloseable instances that itself is AutoCloseable.

Closing an AutoCloseableRegistry closes its registrants.

Author:

Laird Nelson

See Also:

• register(AutoCloseable)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this AutoCloseableRegistry and closes its registrants.
boolean	closed()	Returns true if and only if this AutoCloseableRegistry is closed.
AutoCloseableRegistry	newChild()	Returns a new AutoCloseableRegistry instance that is not closed, has no registrations yet, and is registered with this AutoCloseableRegistry.
boolean	register(AutoCloseable closeable)	If this AutoCloseableRegistry is not closed, and if the supplied AutoCloseable has not yet been registered, registers it such that it will be closed when this AutoCloseableRegistry is closed, and returns true.

Method Details

newChild

AutoCloseableRegistry newChild()

Returns a new AutoCloseableRegistry instance that is not closed, has no registrations yet, and is registered with this AutoCloseableRegistry.

The new AutoCloseableRegistry child therefore functions as an intermediate or leaf node in a tree of AutoCloseable implementations, such that if any node of the tree is closed, all of its descendants will be closed as well.

Returns:

a new, unclosed AutoCloseableRegistry registered with this AutoCloseableRegistry that functions as an intermediate or leaf node in a tree of such nodes

Throws:

IllegalStateException - if this AutoCloseableRegistry is closed

See Also:

• register(AutoCloseable)

Idempotency:

All successful invocations of implementations of this method must return new, distinct AutoCloseableRegistry instances.

Nullability:

Implementations of this method must not return null.

Thread Safety:

Implementations of this method must be safe for concurrent use by multiple threads.

close

void close()

Closes this AutoCloseableRegistry and closes its registrants.

After any successful invocation of this method, an invocation of the closed() method must forever after return true.

Specified by:

close in interface AutoCloseable

See Also:

• closed()

Idempotency:

Implementations of this method must be idempotent.

Thread Safety:

Implementations of this method must be safe for concurrent use by multiple threads.

closed

boolean closed()

Returns true if and only if this AutoCloseableRegistry is closed.

Once an invocation of this method has returned true, on any thread, subsequent invocations must also return true, on any thread.

An implementation of this method must return false until an invocation of the close() method has successfully completed, and must return true thereafter.

Returns:

true if and only if this AutoCloseableRegistry is closed

See Also:

• close()

Idempotency:

Implementations of this method must be idempotent.

Thread Safety:

Implementations of this method must be safe for concurrent use by multiple threads.

register

boolean register(AutoCloseable closeable)

If this AutoCloseableRegistry is not closed, and if the supplied AutoCloseable has not yet been registered, registers it such that it will be closed when this AutoCloseableRegistry is closed, and returns true.

This method takes no action and returns false in all other cases.

Parameters:

closeable - the AutoCloseable to register; must not be null

Returns:

true if and only if this AutoCloseableRegistry is not closed and the supplied AutoCloseable is not already registered and registration completed successfully; false in all other cases

Throws:

NullPointerException - if closeable is null

Idempotency:

Implementations of this method must be idempotent.

Thread Safety:

Implementations of this method must be safe for concurrent use by multiple threads.