/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * See LICENSE.txt included in this distribution for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at LICENSE.txt.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright (c) 2011 Trond Norbye
 * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved.
 */
package org.opensolaris.opengrok.util;

import java.io.Closeable;
import java.io.IOException;
import java.net.ServerSocket;
import java.net.Socket;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * A small utility class to provide common functionality related to
 * IO so that we don't need to duplicate the logic all over the place.
 * 
 * @author Trond Norbye <trond.norbye@gmail.com>
 */
public final class IOUtils {

    private static final Logger log = Logger.getLogger(IOUtils.class.getName());

    private IOUtils() {
        // singleton
    }

    /**
     * Try to close the given object if not {@code null} and log errors if an 
     * exception  occures.
     * @param c object to close.
     */
    public static final void close(Closeable c) {
        if (c != null) {
            try {
                c.close();
            } catch (IOException e) {
                log.warning("Failed to close resource: " + e.getMessage());
                log.log(Level.FINE, "close", e);
            } catch (NullPointerException e) {
                // Lucene's Analyzer tends to throw it sometimes, but not always
                if (log.isLoggable(Level.FINE)) {
                    log.log(Level.FINE, "NullPointerException when closing "
                        + c.getClass().getName(), e);
                }
            }
        }
    }

    /**
     * Try to close the given socket if not {@code null} and log errors if an 
     * exception  occures.
     * @param sock socket to close.
     */
    public static final void close(ServerSocket sock) {
        if (sock != null) {
            try {
                sock.close();
            } catch (IOException e) {
                log.warning("Failed to close socket: " + e.getMessage());
                log.log(Level.FINE, "close", e);
            }
        }
    }

    /**
     * Try to close the given socket if not {@code null} and log errors if an 
     * exception  occures.
     * @param sock socket to close.
     */
    public static final void close(Socket sock) {
        if (sock != null) {
            try {
                sock.close();
            } catch (IOException e) {
                log.warning("Failed to close socket: " + e.getMessage());
                log.log(Level.FINE, "close", e);
            }
        }
    }
}