001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.lang3.function;
019
020import java.util.Objects;
021import java.util.function.LongUnaryOperator;
022
023/**
024 * A functional interface like {@link LongUnaryOperator} that declares a {@link Throwable}.
025 *
026 * @param <E> The kind of thrown exception or error.
027 * @since 3.11
028 */
029public interface FailableLongUnaryOperator<E extends Throwable> {
030
031    /** NOP singleton */
032    @SuppressWarnings("rawtypes")
033    FailableLongUnaryOperator NOP = t -> 0L;
034
035    /**
036     * Returns a unary operator that always returns its input argument.
037     *
038     * @param <E> The kind of thrown exception or error.
039     * @return a unary operator that always returns its input argument
040     */
041    static <E extends Throwable> FailableLongUnaryOperator<E> identity() {
042        return t -> t;
043    }
044
045    /**
046     * Returns The NOP singleton.
047     *
048     * @param <E> The kind of thrown exception or error.
049     * @return The NOP singleton.
050     */
051    @SuppressWarnings("unchecked")
052    static <E extends Throwable> FailableLongUnaryOperator<E> nop() {
053        return NOP;
054    }
055
056    /**
057     * Returns a composed {@link FailableDoubleUnaryOperator} like {@link LongUnaryOperator#andThen(LongUnaryOperator)}.
058     *
059     * @param after the operator to apply after this one.
060     * @return a composed {@link FailableLongUnaryOperator} like {@link LongUnaryOperator#andThen(LongUnaryOperator)}.
061     * @throws NullPointerException if after is null.
062     * @see #compose(FailableLongUnaryOperator)
063     */
064    default FailableLongUnaryOperator<E> andThen(final FailableLongUnaryOperator<E> after) {
065        Objects.requireNonNull(after);
066        return (final long t) -> after.applyAsLong(applyAsLong(t));
067    }
068
069    /**
070     * Applies this operator to the given operand.
071     *
072     * @param operand the operand
073     * @return the operator result
074     * @throws E Thrown when a consumer fails.
075     */
076    long applyAsLong(long operand) throws E;
077
078    /**
079     * Returns a composed {@link FailableLongUnaryOperator} like {@link LongUnaryOperator#compose(LongUnaryOperator)}.
080     *
081     * @param before the operator to apply before this one.
082     * @return a composed {@link FailableLongUnaryOperator} like {@link LongUnaryOperator#compose(LongUnaryOperator)}.
083     * @throws NullPointerException if before is null.
084     * @see #andThen(FailableLongUnaryOperator)
085     */
086    default FailableLongUnaryOperator<E> compose(final FailableLongUnaryOperator<E> before) {
087        Objects.requireNonNull(before);
088        return (final long v) -> applyAsLong(before.applyAsLong(v));
089    }
090}