org.apache.commons.lang3.function.FailableLongUnaryOperator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commons-lang3 Show documentation

Apache Commons Lang, a package of Java utility classes for the classes that are in java.lang's hierarchy, or are considered to be so standard as to justify existence in java.lang. The code is tested using the latest revision of the JDK for supported LTS releases: 8, 11, 17 and 21 currently. See https://github.com/apache/commons-lang/blob/master/.github/workflows/maven.yml Please ensure your build environment is up-to-date and kindly report any build issues.

There is a newer version: 3.17.0

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.commons.lang3.function;

import java.util.Objects;
import java.util.function.LongUnaryOperator;

/**
 * A functional interface like {@link LongUnaryOperator} that declares a {@link Throwable}.
 *
 * @param  The kind of thrown exception or error.
 * @since 3.11
 */
public interface FailableLongUnaryOperator {

    /** NOP singleton */
    @SuppressWarnings("rawtypes")
    FailableLongUnaryOperator NOP = t -> 0L;

    /**
     * Returns a unary operator that always returns its input argument.
     *
     * @param  The kind of thrown exception or error.
     * @return a unary operator that always returns its input argument
     */
    static  FailableLongUnaryOperator identity() {
        return t -> t;
    }

    /**
     * Returns The NOP singleton.
     *
     * @param  The kind of thrown exception or error.
     * @return The NOP singleton.
     */
    @SuppressWarnings("unchecked")
    static  FailableLongUnaryOperator nop() {
        return NOP;
    }

    /**
     * Returns a composed {@link FailableDoubleUnaryOperator} like {@link LongUnaryOperator#andThen(LongUnaryOperator)}.
     *
     * @param after the operator to apply after this one.
     * @return a composed {@link FailableLongUnaryOperator} like {@link LongUnaryOperator#andThen(LongUnaryOperator)}.
     * @throws NullPointerException if after is null.
     * @see #compose(FailableLongUnaryOperator)
     */
    default FailableLongUnaryOperator andThen(final FailableLongUnaryOperator after) {
        Objects.requireNonNull(after);
        return (final long t) -> after.applyAsLong(applyAsLong(t));
    }

    /**
     * Applies this operator to the given operand.
     *
     * @param operand the operand
     * @return the operator result
     * @throws E Thrown when a consumer fails.
     */
    long applyAsLong(long operand) throws E;

    /**
     * Returns a composed {@link FailableLongUnaryOperator} like {@link LongUnaryOperator#compose(LongUnaryOperator)}.
     *
     * @param before the operator to apply before this one.
     * @return a composed {@link FailableLongUnaryOperator} like {@link LongUnaryOperator#compose(LongUnaryOperator)}.
     * @throws NullPointerException if before is null.
     * @see #andThen(FailableLongUnaryOperator)
     */
    default FailableLongUnaryOperator compose(final FailableLongUnaryOperator before) {
        Objects.requireNonNull(before);
        return (final long v) -> applyAsLong(before.applyAsLong(v));
    }
}