org.apache.flink.util

Class AbstractCloseableRegistry<C extends Closeable,T>

java.lang.Object

org.apache.flink.util.AbstractCloseableRegistry<C,T>

Type Parameters:

C - Type of the closeable this registers

T - Type for potential meta data associated with the registering closeables

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

CloseableRegistry, SafetyNetCloseableRegistry

@Internal
public abstract class AbstractCloseableRegistry<C extends Closeable,T>
extends Object
implements Closeable

This is the abstract base class for registries that allow to register instances of Closeable, which are all closed if this registry is closed.

Registering to an already closed registry will throw an exception and close the provided Closeable

All methods in this class are thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Closeable,T>	closeableToRef

Constructor Summary

Constructors

Constructor and Description
AbstractCloseableRegistry(Map<Closeable,T> closeableToRef)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
protected abstract void	doRegister(C closeable, Map<Closeable,T> closeableMap)
protected abstract void	doUnRegister(C closeable, Map<Closeable,T> closeableMap)
protected Object	getSynchronizationLock()
boolean	isClosed()
void	registerClosable(C closeable) Registers a Closeable with the registry.
void	unregisterClosable(C closeable) Removes a Closeable from the registry.

Methods inherited from class java.lang.Object

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

Field Detail

closeableToRef

protected final Map<Closeable,T> closeableToRef

Constructor Detail

AbstractCloseableRegistry

public AbstractCloseableRegistry(Map<Closeable,T> closeableToRef)

Method Detail

registerClosable

public final void registerClosable(C closeable)
                            throws IOException

Registers a Closeable with the registry. In case the registry is already closed, this method throws an IllegalStateException and closes the passed Closeable.

Parameters:

closeable - Closeable tor register

Throws:

IOException - exception when the registry was closed before

unregisterClosable

public final void unregisterClosable(C closeable)

Removes a Closeable from the registry.

Parameters:

closeable - instance to remove from the registry.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

isClosed

public boolean isClosed()

getSynchronizationLock

protected final Object getSynchronizationLock()

doUnRegister

protected abstract void doUnRegister(C closeable,
                Map<Closeable,T> closeableMap)

doRegister

protected abstract void doRegister(C closeable,
              Map<Closeable,T> closeableMap)
                            throws IOException

Throws:

IOException