no.digipost.util.ViewableAsOptional Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of digg Show documentation
Some stellar general purpose utils.
The newest version!
/*
 * Copyright (C) Posten Norge AS
 *
 * Licensed 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 no.digipost.util;

import java.util.List;
import java.util.Optional;
import java.util.function.Function;
import java.util.function.Supplier;

import static java.util.stream.Collectors.joining;

@FunctionalInterface
public interface ViewableAsOptional {

    /**
     * A {@link Supplier} which is also {@link ViewableAsOptional}.
     *
     * @param  The type of the supplied value
     */
    @FunctionalInterface
    interface Single extends Supplier, ViewableAsOptional {

        /**
         * Convert this object to an {@link java.util.Optional} by wrapping the
         * value returned from {@link #get()}.
         *
         * @return the value returned from {@link #get()}, wrapped in an {@link Optional}.
         *         If {@code get()} returns {@code null}, {@link Optional#empty()} is returned.
         */
        @Override
        default Optional toOptional() throws ViewableAsOptional.TooManyElements {
            return Optional.ofNullable(get());
        }
    }

    /**
     * An object which was attempted to be viewed as a {@link java.util.Optional}
     * representation of itself contained more than one element, and is thus
     * not applicable for such conversion.
     */
    class TooManyElements extends RuntimeException {

        private static final long serialVersionUID = 1L;

        public TooManyElements(List objects) {
            this(objects, (Throwable) null);
        }

        public TooManyElements(List objects, Throwable cause) {
            this(objects, Object::toString, cause);
        }

        public  TooManyElements(List objects, Function toString) {
            this(objects, toString, null);
        }

        public  TooManyElements(List objects, Function toString, Throwable cause) {
            this("Expected at most one element, but there were excess ones. All elements: [" + objects.stream().map(toString).collect(joining(", ")) + "]", cause);
        }

        public TooManyElements(Object allowed, Object firstExcess) {
            this(allowed, firstExcess, null);
        }

        public TooManyElements(Object allowed, Object firstExcess, Throwable cause) {
            this("Expected only the element '" + allowed + "', but there were at least one excess one: '" + firstExcess + "'", cause);
        }

        public TooManyElements() {
            this("Expected at most one element, but there were excess ones", null);
        }

        public TooManyElements(String message, Throwable cause) {
            super(message, cause);
        }
    }

    /**
     * Get an {@link java.util.Optional} representation of this object. If it contains
     * more elements than one, and thus cannot be viewed as an {@code Optional} without
     * loosing any information, a {@link TooManyElements} is thrown.
     *
     * @return the {@link java.util.Optional} representation of this object.
     * @throws TooManyElements if this object contains more than one element, and thus
     *                         is not applicable for lossless conversion to an Optional.
     */
    Optional toOptional() throws TooManyElements;
}