org.dice_research.squirrel.utils

Class Closer

java.lang.Object

org.dice_research.squirrel.utils.Closer

public class Closer
extends Object

A simple class offering methods to close other classes either quitely or with logging errors.

Author:

Michael Röder (michael.roeder@uni-paderborn.de)

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOGGER

Constructor Summary

Constructors

Constructor and Description
Closer()

Method Summary

Modifier and Type	Method and Description
static void	close(Closeable closeable) Closes the given Closeable and logs occuring exceptions with the Logger of this utility class.
static void	close(Closeable closeable, org.slf4j.Logger logger) Closes the given Closeable and logs occuring exceptions with the given Logger.
static void	close(Closeable closeable, org.slf4j.Logger logger, boolean withStackTrace) Closes the given Closeable and logs occuring exceptions with the given Logger.
static void	closeQuietly(Closeable closeable) Closes the given Closeable while ignoring all exception that may occur.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

Constructor Detail

Closer

public Closer()

Method Detail

closeQuietly

public static void closeQuietly(Closeable closeable)

Closes the given Closeable while ignoring all exception that may occur.

Parameters:

closeable - the object which should be closed.

close

public static void close(Closeable closeable)

Closes the given Closeable and logs occuring exceptions with the Logger of this utility class. Note that it is recommended to use close(Closeable, Logger) instead.

Parameters:

closeable - the object which should be closed.

close

public static void close(Closeable closeable,
                         org.slf4j.Logger logger)

Closes the given Closeable and logs occuring exceptions with the given Logger. Note that exceptions are logged without their stack trace (i.e., like you would call close(Closeable, Logger, boolean) with false for the stack trace flag.

Parameters:

closeable - the object which should be closed.

logger - the logger used for logging occurring exceptions

close

public static void close(Closeable closeable,
                         org.slf4j.Logger logger,
                         boolean withStackTrace)

Closes the given Closeable and logs occuring exceptions with the given Logger. Depending on the given flag, exceptions are logged with their stack trace or not.

Parameters:

closeable - the object which should be closed.

logger - the logger used for logging occurring exceptions

withStackTrace - if this flag is true the exception will be logged together with its stack trace. Otherwise, only the exception message will be logged.