Module org.newsclub.net.unix

Package org.newsclub.net.unix

Class Closeables

java.lang.Object

org.newsclub.net.unix.Closeables

All Implemented Interfaces:

Closeable, AutoCloseable

public final class Closeables
extends Object
implements Closeable

A set of Closeables that can be closed at once.

Author:

Christian Kohlschütter

Constructor Summary

Constructors

Constructor	Description
Closeables()	Creates a new Closeables instance.
Closeables(Closeable... closeable)	Creates a new Closeables instance, populating it with the given Closeable objects.

Method Summary

Modifier and Type	Method	Description
boolean	add(Closeable closeable)	Adds the given closeable.
boolean	add(WeakReference<Closeable> closeable)	Adds the given closeable, but only using a weak reference.
void	close()
void	close(IOException superException)	Closes all registered closeables.
boolean	isClosed()	Checks if this instance has been closed already.
boolean	remove(Closeable closeable)	Removes the given closeable.

Methods inherited from class java.lang.Object

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

Constructor Details

Closeables

public Closeables()

Creates a new Closeables instance.

Closeables

public Closeables(Closeable... closeable)

Creates a new Closeables instance, populating it with the given Closeable objects.

Parameters:

closeable - The Closeables to add.

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

isClosed

public boolean isClosed()

Checks if this instance has been closed already.

Returns:

true if closed.

close

public void close(IOException superException)
           throws IOException

Closes all registered closeables.

Parameters:

superException - If set, any exceptions thrown in here will be chained to the given exception via addSuppressed, and then thrown.

Throws:

IOException - if an exception occurs.

add

public boolean add(WeakReference<Closeable> closeable)

Adds the given closeable, but only using a weak reference.

Parameters:

closeable - The closeable.

Returns:

true iff the closeable was added, false if it was null, already added before, or if the Closeables instance has been closed already.

add

public boolean add(Closeable closeable)

Adds the given closeable.

Parameters:

closeable - The closeable.

Returns:

true iff the closeable was added, false if it was null or already added before.

remove

public boolean remove(Closeable closeable)

Removes the given closeable.

Parameters:

closeable - The closeable.

Returns:

true iff the closeable was removed, fale if it was null or not previously added.