Module org.microbean.bean

Package org.microbean.bean

Class DefaultAutoCloseableRegistry

java.lang.Object

org.microbean.bean.DefaultAutoCloseableRegistry

All Implemented Interfaces:

AutoCloseable, AutoCloseableRegistry

public class DefaultAutoCloseableRegistry
extends Object
implements AutoCloseableRegistry

A straightforward AutoCloseableRegistry implementation.

Author:

Laird Nelson

See Also:

• AutoCloseableRegistry

Constructor Summary

Constructors

Constructor	Description
DefaultAutoCloseableRegistry()	Creates a new DefaultAutoCloseableRegistry.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultAutoCloseableRegistry

public DefaultAutoCloseableRegistry()

Creates a new DefaultAutoCloseableRegistry.

Method Details

newChild

public DefaultAutoCloseableRegistry newChild()

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

Specified by:

newChild in interface AutoCloseableRegistry

Returns:

a new, unclosed DefaultAutoCloseableRegistry registered with this DefaultAutoCloseableRegistry

Throws:

IllegalStateException - if this DefaultAutoCloseableRegistry is closed

See Also:

• register(AutoCloseable)

Idempotency:

Overrides of this method must return new, distinct DefaultAutoCloseableRegistry instances.

Nullability:

This method does not, and its overrides must not, return null.

Thread Safety:

This method is, and its overrides must be, safe for concurrent use by multiple threads.

close

public void close()

Closes this DefaultAutoCloseableRegistry and closes its registrants.

AutoCloseable.close() is called on all registrants, even in the presence of exceptions. RuntimeExceptions consequently thrown may therefore contain suppressed exceptions.

Overrides of this method wishing to add semantics to this behavior should perform that work before calling super.close().

Overrides of this method must call super.close() or undefined behavior may result.

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

Specified by:

close in interface AutoCloseable

Specified by:

close in interface AutoCloseableRegistry

See Also:

• closed()

Idempotency:

This method is, and its overrides must be, idempotent.

Thread Safety:

This method is, and its overrides must be, safe for concurrent use by multiple threads.

closed

public final boolean closed()

Returns true if and only if this DefaultAutoCloseableRegistry is closed.

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

This method will return false until an invocation of the close() method has successfully completed, and will return true thereafter.

Specified by:

closed in interface AutoCloseableRegistry

Returns:

true if and only if this DefaultAutoCloseableRegistry is closed

See Also:

• close()

Idempotency:

This method is idempotent.

Thread Safety:

This method is safe for concurrent use by multiple threads.

register

public final boolean register(AutoCloseable closeable)

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

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

Specified by:

register in interface AutoCloseableRegistry

Parameters:

closeable - the AutoCloseable to register; must not be null

Returns:

true if and only if this DefaultAutoCloseableRegistry 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:

This method is idempotent.

Thread Safety:

This method is safe for concurrent use by multiple threads.