de.unkrig.commons.lang.protocol.StoppableUtil Maven / Gradle / Ivy

Go to download

/*
 * de.unkrig.commons - A general-purpose Java class library
 *
 * Copyright (c) 2011, Arno Unkrig
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
 * following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright notice, this list of conditions and the
 *       following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
 *       following disclaimer in the documentation and/or other materials provided with the distribution.
 *    3. The name of the author may not be used to endorse or promote products derived from this software without
 *       specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package de.unkrig.commons.lang.protocol;

import java.io.Closeable;
import java.net.Socket;

/**
 * Various {@link Stoppable}-related utility methods.
 */
public final
class StoppableUtil {

    private
    StoppableUtil() {}

    /**
     * Creates a {@link Stoppable} that closes the given {@link Closeable} when {@link Stoppable#stop()} is called.
     */
    public static Stoppable
    toStoppable(final Closeable closeable) {
        return new Stoppable() {

            @Override public void
            stop() {
                try { closeable.close(); } catch (Exception e) {}
            }
        };
    }

    /**
     * Amazingly, a {@link Socket} is not a {@link Closeable}, hence we need this special version of "toStoppable()".
     *
     * @see #toStoppable(Closeable)
     */
    public static Stoppable
    toStoppable(final Socket socket) {
        return new Stoppable() {

            @Override public void
            stop() {
                try { socket.close(); } catch (Exception e) {}
            }
        };
    }
}