/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2017 Yegor Bugayenko
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package org.takes.misc;

import lombok.EqualsAndHashCode;

/**
 * Replacement a nullable T reference with a non-null value.
 *
 * <p>All implementations of this interface must be immutable and thread-safe.
 * @author Dmitry Zaytsev (dmitry.zaytsev@gmail.com)
 * @version $Id: 83d7bcf67448c9047850706e0204d913a86892ea $
 * @param <T> Type of item
 * @since 0.14
 */
public interface Opt<T> {
    /**
     * Returns the contained instance.
     * @return Instance
     */
    T get();

    /**
     * Returns true if contains instance.
     * @return True if present
     */
    boolean has();

    /**
     * Holder for a single element only.
     *
     * <p>The class is immutable and thread-safe.
     * @author Dmitry Zaytsev (dmitry.zaytsev@gmail.com)
     * @version $Id: 83d7bcf67448c9047850706e0204d913a86892ea $
     * @since 0.14
     * @param <T> Type of item
     */
    @EqualsAndHashCode
    final class Single<T> implements Opt<T> {
        /**
         * Origin.
         */
        private final T origin;
        /**
         * Ctor.
         * @param orgn Origin
         */
        public Single(final T orgn) {
            this.origin = orgn;
        }
        @Override
        public T get() {
            return this.origin;
        }
        @Override
        public boolean has() {
            return true;
        }
    }

    /**
     * Empty instance.
     *
     * <p>The class is immutable and thread-safe.
     * @author Dmitry Zaytsev (dmitry.zaytsev@gmail.com)
     * @version $Id: 83d7bcf67448c9047850706e0204d913a86892ea $
     * @param <T> Type of item
     * @since 0.14
     */
    final class Empty<T> implements Opt<T> {
        @Override
        public T get() {
            throw new UnsupportedOperationException(
                "there is nothing here, use has() first, to check"
            );
        }
        @Override
        public boolean has() {
            return false;
        }
    }
}