com.sk89q.worldguard.util.io

Class Closer

java.lang.Object

com.sk89q.worldguard.util.io.Closer

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class Closer
extends java.lang.Object
implements java.io.Closeable

Method Summary

Modifier and Type	Method and Description
void	close() Closes all Closeable instances that have been added to this Closer.
void	closeQuietly() Close quietly.
static Closer	create() Creates a new Closer.
<C extends java.io.Closeable> C	register(C closeable) Registers the given closeable to be closed when this Closer is closed.
<C extends java.sql.Connection> C	register(C connection) Registers the given connection to be closed when this Closer is closed.
<C extends java.sql.ResultSet> C	register(C resultSet) Registers the given resultSet to be closed when this Closer is closed.
<C extends java.sql.Statement> C	register(C statement) Registers the given statement to be closed when this Closer is closed.
java.lang.RuntimeException	rethrow(java.lang.Throwable e) Stores the given throwable and rethrows it.
<X extends java.lang.Exception> java.lang.RuntimeException	rethrow(java.lang.Throwable e, java.lang.Class<X> declaredType) Stores the given throwable and rethrows it.
<X1 extends java.lang.Exception,X2 extends java.lang.Exception> java.lang.RuntimeException	rethrow(java.lang.Throwable e, java.lang.Class<X1> declaredType1, java.lang.Class<X2> declaredType2) Stores the given throwable and rethrows it.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Closer create()

Creates a new Closer.

register

public <C extends java.io.Closeable> C register(C closeable)

Registers the given closeable to be closed when this Closer is closed.

Returns:

the given closeable

register

public <C extends java.sql.Connection> C register(C connection)

Registers the given connection to be closed when this Closer is closed.

Returns:

the given connection

register

public <C extends java.sql.Statement> C register(C statement)

Registers the given statement to be closed when this Closer is closed.

Returns:

the given statement

register

public <C extends java.sql.ResultSet> C register(C resultSet)

Registers the given resultSet to be closed when this Closer is closed.

Returns:

the given resultSet

rethrow

public java.lang.RuntimeException rethrow(java.lang.Throwable e)
                                   throws java.io.IOException

Stores the given throwable and rethrows it. It will be rethrown as is if it is an IOException, RuntimeException or Error. Otherwise, it will be rethrown wrapped in a RuntimeException. Note: Be sure to declare all of the checked exception types your try block can throw when calling an overload of this method so as to avoid losing the original exception type.

This method always throws, and as such should be called as throw closer.rethrow(e); to ensure the compiler knows that it will throw.

Returns:

this method does not return; it always throws

Throws:

java.io.IOException - when the given throwable is an IOException

rethrow

public <X extends java.lang.Exception> java.lang.RuntimeException rethrow(java.lang.Throwable e,
                                                                          java.lang.Class<X> declaredType)
                                                                   throws java.io.IOException,
                                                                          X extends java.lang.Exception

Stores the given throwable and rethrows it. It will be rethrown as is if it is an IOException, RuntimeException, Error or a checked exception of the given type. Otherwise, it will be rethrown wrapped in a RuntimeException. Note: Be sure to declare all of the checked exception types your try block can throw when calling an overload of this method so as to avoid losing the original exception type.

This method always throws, and as such should be called as throw closer.rethrow(e, ...); to ensure the compiler knows that it will throw.

Returns:

this method does not return; it always throws

Throws:

java.io.IOException - when the given throwable is an IOException

X - when the given throwable is of the declared type X

X extends java.lang.Exception

rethrow

public <X1 extends java.lang.Exception,X2 extends java.lang.Exception> java.lang.RuntimeException rethrow(java.lang.Throwable e,
                                                                                                          java.lang.Class<X1> declaredType1,
                                                                                                          java.lang.Class<X2> declaredType2)
                                                                                                   throws java.io.IOException,
                                                                                                          X1 extends java.lang.Exception,
                                                                                                          X2 extends java.lang.Exception

Stores the given throwable and rethrows it. It will be rethrown as is if it is an IOException, RuntimeException, Error or a checked exception of either of the given types. Otherwise, it will be rethrown wrapped in a RuntimeException. Note: Be sure to declare all of the checked exception types your try block can throw when calling an overload of this method so as to avoid losing the original exception type.

This method always throws, and as such should be called as throw closer.rethrow(e, ...); to ensure the compiler knows that it will throw.

Returns:

this method does not return; it always throws

Throws:

java.io.IOException - when the given throwable is an IOException

X1 - when the given throwable is of the declared type X1

X2 - when the given throwable is of the declared type X2

X1 extends java.lang.Exception

close

public void close()
           throws java.io.IOException

Closes all Closeable instances that have been added to this Closer. If an exception was thrown in the try block and passed to one of the exceptionThrown methods, any exceptions thrown when attempting to close a closeable will be suppressed. Otherwise, the first exception to be thrown from an attempt to close a closeable will be thrown and any additional exceptions that are thrown after that will be suppressed.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

closeQuietly

public void closeQuietly()

Close quietly.