hu.akarnokd.reactive4java.util

Class CompositeCloseable

java.lang.Object

hu.akarnokd.reactive4java.util.CompositeCloseable

All Implemented Interfaces:

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

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

A composite closeable which maintains a list of sub-closeables and has its own alive state. If the composite is closed, any maintained closeable is closed and any subsequently added closeable will be closed instantly.

The class is thread safe.

Since:

0.97

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	done The done indicator.
protected java.util.List<java.io.Closeable>	items The list of items.
protected java.util.concurrent.locks.Lock	lock The lock guarding the items and done.

Constructor Summary

Constructors

Constructor and Description
CompositeCloseable(java.io.Closeable... closeables) Constructs the composite closeable with the supplied initial elements.
CompositeCloseable(int capacity) Constructs a composite closeable where the backing list has the supplied capacity.
CompositeCloseable(java.lang.Iterable<? extends java.io.Closeable> closeables) Constructs the composite closeable with the supplied initial elements.

Method Summary

Modifier and Type	Method and Description
void	add(java.io.Closeable... closeables) Adds new closeables to this composite object.
void	add(java.lang.Iterable<? extends java.io.Closeable> closeables) Adds new closeables to this composite object.
void	clear() Closes the inner closeables but does not close this composite.
void	close()
void	closeSilently() Close this composite and ignore any IOExceptions.
boolean	contains(java.io.Closeable c) Returns true if the given closeable is in this composite.
boolean	delete(java.io.Closeable c) Removes the given closeable from this composite but does not close it.
boolean	isClosed()
boolean	isEmpty()
boolean	remove(java.io.Closeable c) Removes and closes the specified closeable instance if contained within this composite.
boolean	removeSilently(java.io.Closeable c) Removes and closes the specified closeable instance if contained within this composite.
int	size()

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 guarding the items and done.

items

protected final java.util.List<java.io.Closeable> items

The list of items.

done

protected boolean done

The done indicator.

Constructor Detail

CompositeCloseable

public CompositeCloseable(int capacity)

Constructs a composite closeable where the backing list has the supplied capacity.

Parameters:

capacity - the capacity value >= 1

CompositeCloseable

public CompositeCloseable(@Nonnull
                          java.io.Closeable... closeables)

Constructs the composite closeable with the supplied initial elements.

Parameters:

closeables - the closeable elements to start with

CompositeCloseable

public CompositeCloseable(@Nonnull
                          java.lang.Iterable<? extends java.io.Closeable> closeables)

Constructs the composite closeable with the supplied initial elements.

Parameters:

closeables - the closeable elements to start with

Method Detail

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(java.io.Closeable... closeables)

Adds new closeables to this composite object. If the composite is already closed, the closeables are immediately closed.

Parameters:

closeables - the array of closeables

add

public void add(java.lang.Iterable<? extends java.io.Closeable> closeables)

Adds new closeables to this composite object. If the composite is already closed, the closeables are immediately closed. Close exceptions are silently ignored.

Parameters:

closeables - the sequence of closeables

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Cancelable

Returns:

true if the object has been closed.

size

public int size()

Returns:

Returns the currently maintained number of closeables.

remove

public boolean remove(java.io.Closeable c)
               throws java.io.IOException

Removes and closes the specified closeable instance if contained within this composite.

Parameters:

c - the closeable

Returns:

true if the instance was removed

Throws:

java.io.IOException - if the close method threw it

removeSilently

public boolean removeSilently(java.io.Closeable c)

Removes and closes the specified closeable instance if contained within this composite.

Parameters:

c - the closeable

Returns:

true if the instance was removed

delete

public boolean delete(java.io.Closeable c)

Removes the given closeable from this composite but does not close it.

Parameters:

c - the closeable instance

Returns:

true if the closeable was in this container

clear

public void clear()
           throws java.io.IOException

Closes the inner closeables but does not close this composite.

Throws:

java.io.IOException - the exception(s) thrown by the close() calls

contains

public boolean contains(java.io.Closeable c)

Returns true if the given closeable is in this composite.

Parameters:

c - the closeable to test

Returns:

true if is in this closeable

closeSilently

public void closeSilently()

Close this composite and ignore any IOExceptions.

isEmpty

public boolean isEmpty()

Returns:

true if the closeable is empty.