| /* |
| * 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 {@code Throwable}. |
| * |
| * @param <E> Thrown exception. |
| * @since 3.11 |
| */ |
| public interface FailableLongUnaryOperator<E extends Throwable> { |
| |
| /** NOP singleton */ |
| @SuppressWarnings("rawtypes") |
| FailableLongUnaryOperator NOP = t -> 0L; |
| |
| /** |
| * Returns a unary operator that always returns its input argument. |
| * |
| * @param <E> Thrown exception. |
| * @return a unary operator that always returns its input argument |
| */ |
| static <E extends Throwable> FailableLongUnaryOperator<E> identity() { |
| return t -> t; |
| } |
| |
| /** |
| * Returns The NOP singleton. |
| * |
| * @param <E> Thrown exception. |
| * @return The NOP singleton. |
| */ |
| static <E extends Throwable> FailableLongUnaryOperator<E> nop() { |
| return NOP; |
| } |
| |
| /** |
| * Returns a composed {@code FailableDoubleUnaryOperator} like {@link LongUnaryOperator#andThen(LongUnaryOperator)}. |
| * |
| * @param after the operator to apply after this one. |
| * @return a composed {@code FailableLongUnaryOperator} like {@link LongUnaryOperator#andThen(LongUnaryOperator)}. |
| * @throws NullPointerException if after is null. |
| * @see #compose(FailableLongUnaryOperator) |
| */ |
| default FailableLongUnaryOperator<E> andThen(final FailableLongUnaryOperator<E> 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 {@code FailableLongUnaryOperator} like {@link LongUnaryOperator#compose(LongUnaryOperator)}. |
| * |
| * @param before the operator to apply before this one. |
| * @return a composed {@code FailableLongUnaryOperator} like {@link LongUnaryOperator#compose(LongUnaryOperator)}. |
| * @throws NullPointerException if before is null. |
| * @see #andThen(FailableLongUnaryOperator) |
| */ |
| default FailableLongUnaryOperator<E> compose(final FailableLongUnaryOperator<E> before) { |
| Objects.requireNonNull(before); |
| return (final long v) -> applyAsLong(before.applyAsLong(v)); |
| } |
| } |