com.jongsoft.utils.core.Some Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lang Show documentation
The newest version!
/*
 * The MIT License
 *
 * Copyright 2016 Jong Soft.
 *
 * 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 NONINFRINGEMENT. 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 com.jongsoft.utils.core;

import java.util.Collections;
import java.util.Iterator;
import java.util.Objects;
import java.util.function.Consumer;
import java.util.function.Supplier;

public class Some implements Value {

    private static final long serialVersionUID = 1L;
    
    private final T value;

    protected Some(T value) {
        this.value = value;
    }

    @Override
    public T get() {
        return value;
    }

    @Override
    public Iterator iterator() {
        return Collections.singletonList(value).iterator();
    }

    @Override
    public boolean isPresent() {
        return true;
    }

    @Override
    public OrElse ifPresent(Consumer consumer) {
        Objects.requireNonNull(consumer, "Consumer cannot be null");
        consumer.accept(get());
        return OrElse.notEmpty();
    }

    @Override
    public  OrElse ifPresent(Supplier exceptionSupplier) throws X {
        Objects.requireNonNull(exceptionSupplier, "Supplier of exceptions cannot be null");
        throw exceptionSupplier.get();
    }

    @Override
    public String toString() {
        return Objects.toString(value);
    }

    //----------------------------------------------------------------------------------------------
    //-- All static helper methods to instantiate the Some class
    
    public static  Value some(T value) {
        return new Some<>(value);
    }
}