org.apache.camel.util.function.Suppliers Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-util Show documentation
The Camel Utilities
The 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.camel.util.function;

import java.util.Objects;
import java.util.Optional;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.function.Supplier;

public final class Suppliers {
    private Suppliers() {
    }

    /**
     * Returns a supplier which caches the result of the first call to {@link Supplier#get()}and returns that value on
     * subsequent calls.
     *
     * @param  supplier the delegate {@link Supplier}.
     * @param        the type of results supplied by this supplier.
     * @return          the result fo the first call to the delegate's {@link Supplier#get()} method.
     */
    public static  Supplier memorize(Supplier supplier) {
        final AtomicReference valueHolder = new AtomicReference<>();
        return new Supplier<>() {
            @Override
            public T get() {
                T supplied = valueHolder.get();
                if (supplied == null) {
                    synchronized (valueHolder) {
                        supplied = valueHolder.get();
                        if (supplied == null) {
                            supplied = Objects.requireNonNull(supplier.get(), "Supplier should not return null");
                            valueHolder.lazySet(supplied);
                        }
                    }
                }
                return supplied;
            }
        };
    }

    /**
     * Returns a supplier which caches the result of the first call to {@link Supplier#get()} and returns that value on
     * subsequent calls.
     *
     * @param  supplier the delegate {@link Supplier}.
     * @param  consumer a consumer for any exception thrown by the {@link ThrowingSupplier#get()}.
     * @param        the type of results supplied by this supplier.
     * @return          the result fo the first call to the delegate's {@link Supplier#get()} method.
     */
    public static  Supplier memorize(ThrowingSupplier supplier, Consumer consumer) {
        final AtomicReference valueHolder = new AtomicReference<>();
        return new Supplier<>() {
            @Override
            public T get() {
                T supplied = valueHolder.get();
                if (supplied == null) {
                    synchronized (valueHolder) {
                        supplied = valueHolder.get();
                        if (supplied == null) {
                            try {
                                supplied = Objects.requireNonNull(supplier.get(), "Supplier should not return null");
                                valueHolder.lazySet(supplied);
                            } catch (Exception e) {
                                consumer.accept(e);
                            }
                        }
                    }
                }
                return supplied;
            }
        };
    }

    /**
     * Returns a supplier that return a constant value.
     *
     * @param  value the constant value to return.
     * @param     the type of results supplied by this supplier.
     * @return       the supplied {@code value}.
     */
    public static  Supplier constant(T value) {
        return new Supplier<>() {
            @Override
            public T get() {
                return value;
            }
        };
    }

    /**
     * Returns the first non null value provide by the given suppliers.
     *
     * @param  suppliers a list of supplier.
     * @param         the type of results supplied by this supplier.
     * @return           the optional computed value.
     */
    @SafeVarargs
    public static  Optional firstNotNull(ThrowingSupplier... suppliers) throws Exception {
        T answer = null;

        for (ThrowingSupplier supplier : suppliers) {
            answer = supplier.get();
            if (answer != null) {
                break;
            }
        }

        return Optional.ofNullable(answer);
    }

    /**
     * Returns the first value provide by the given suppliers that matches the given predicate.
     *
     * @param  predicate the predicate used to evaluate the computed values.
     * @param  suppliers a list fo supplier.
     * @param         the type of results supplied by this supplier.
     * @return           the optional matching value.
     */
    public static  Optional firstMatching(Predicate predicate, ThrowingSupplier... suppliers)
            throws Exception {
        T answer = null;

        for (ThrowingSupplier supplier : suppliers) {
            answer = supplier.get();
            if (predicate.test(answer)) {
                break;
            }
        }

        return Optional.ofNullable(answer);
    }
}