de.unkrig.commons.lang.protocol.ConsumerWhichThrows 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. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
 *       products derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER OR CONTRIBUTORS 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;

/**
 * Like {@link Consumer}, but the {@link #consume(Object)} method is permitted to throw a given exception.
 *
 * IMPORTANT NOTICE:
 * 
 *   When using this type in a variable, parameter or field declaration, never write:
 * 
 * ConsumerWhichThrows<consumed-type, thrown-exception>
 * 
 *   , but always:
 * 
 * ConsumerWhichThrows<? super consumed-type, ? extends thrown-exception>
 *
 * @param   The type of the consumed subjects
 * @param  The throwable type that {@link #consume(Object)} may throw
 */
public
interface ConsumerWhichThrows {

    /**
     * Consumes one subject of type {@code T}.
     * 
     *   Generally subjects should either be immutable, or the 'ownership' of the product should pass from the caller
     *   to the consumer. Particularly, the consumer should not be called with one (mutable) instance more than once.
     * 
     */
    void
    consume(T subject) throws EX;
}