hu.akarnokd.reactive4java.util

Class TaggedCompositeCloseable

java.lang.Object

hu.akarnokd.reactive4java.util.TaggedCompositeCloseable

All Implemented Interfaces:

Cancelable, java.io.Closeable, java.lang.AutoCloseable

public class TaggedCompositeCloseable
extends java.lang.Object
implements java.io.Closeable, Cancelable

A composite, modifyable holder of Closeable values with tag objects. The container ensures that once it is closed, attempts to add new closeables will instantly close them.

Since:

0.97

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	done Flag to indicate this item container is closed.
protected java.util.Map<java.lang.Object,java.io.Closeable>	items The sub-observer registration holder.
protected java.util.concurrent.locks.Lock	lock The lock protecting the inner structures.

Constructor Summary

Constructors

Constructor and Description
TaggedCompositeCloseable() Construct a new instance with a fair reentrant lock.
TaggedCompositeCloseable(java.util.concurrent.locks.Lock lock) Constructs an instance with the given shared lock.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.Object token, java.io.Closeable c) Adds or replaces a new closeable by the given token.
void	close()
void	delete(java.lang.Object token) Removes but does not close the given token from this composite.
protected void	init() Initializes the items map.
boolean	isClosed()
void	remove(java.lang.Object token) Remove and close the closeable identified by the token.

Methods inherited from class java.lang.Object

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

Field Detail

lock

protected final java.util.concurrent.locks.Lock lock

The lock protecting the inner structures.

items

@Nonnull
protected java.util.Map<java.lang.Object,java.io.Closeable> items

The sub-observer registration holder. The key is a use-site created object.

done

protected boolean done

Flag to indicate this item container is closed.

Constructor Detail

TaggedCompositeCloseable

public TaggedCompositeCloseable()

Construct a new instance with a fair reentrant lock.

TaggedCompositeCloseable

public TaggedCompositeCloseable(java.util.concurrent.locks.Lock lock)

Constructs an instance with the given shared lock.

Parameters:

lock - the lock to use

Method Detail

init

protected void init()

Initializes the items map.

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

add

public void add(@Nonnull
                java.lang.Object token,
                @Nonnull
                java.io.Closeable c)

Adds or replaces a new closeable by the given token. If the container is already closed, the supplied closeable is closed silently immediately.

Parameters:

token - the token identifying the closeable

c - the closeable instance

remove

public void remove(@Nonnull
                   java.lang.Object token)

Remove and close the closeable identified by the token. If the token is not among the items, this method does nothing.

Parameters:

token - the token to remove

delete

public void delete(@Nonnull
                   java.lang.Object token)

Removes but does not close the given token from this composite.

Parameters:

token - the token identifying the closeable

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Cancelable

Returns:

true if the object has been closed.