net.pwall.pipeline.AbstractAcceptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pipelines Show documentation
Pipelines Library for Java
The newest version!
/*
 * @(#) AbstractAcceptor.java
 *
 * pipelines   Pipeline conversion library for Java
 * Copyright (c) 2020, 2023 Peter Wall
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package net.pwall.pipeline;

/**
 * Abstract implementation of {@link Acceptor}.
 *
 * @author  Peter Wall
 * @param        the accepted (input) value type
 * @param        the result type
 */
abstract public class AbstractAcceptor extends BaseAbstractAcceptor implements Acceptor {

    /**
     * Accept an object.  Check for pipeline already closed, and handle end of data.  This assumes that {@code null} is
     * used to indicate end of data; if that is not the case this method must be overridden or an alternative
     * implementation of {@link Acceptor} used.
     *
     * @param   value       the input value
     */
    @Override
    public void accept(A value) {
        if (isClosed())
            throw new IllegalStateException("Acceptor is closed");
        if (value == null)
            safeClose();
        else
            acceptObject(value);
    }

    /**
     * Accept a value, after {@code closed} check and test for end of data.  Implementing classes must supply an
     * implementation of this method.
     *
     * @param   value       the input value
     */
    abstract public void acceptObject(A value);

    /**
     * Accept a sequence of values, supplied as {@code vararg} parameters.
     *
     * @param   values      the input values
     */
    @SafeVarargs
    public final void accept(A ... values) {
        for (A value : values)
            accept(value);
    }

}
Related Artifacts