org.opendaylight.yangtools.concepts.Either Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yangtools-docs Show documentation
YANG Tools documentation
There is a newer version: 14.0.4
/*
 * Copyright (c) 2018 Pantheon Technologies, s.r.o. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.yangtools.concepts;

import static com.google.common.base.Verify.verifyNotNull;
import static java.util.Objects.requireNonNull;

import com.google.common.annotations.Beta;
import com.google.common.base.MoreObjects;
import com.google.common.base.MoreObjects.ToStringHelper;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.util.Objects;
import java.util.Optional;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;

/**
 * Utility holder of a two-variant value. The class design treats both variants as equal.
 *
 * @param  First alternative type
 * @param  Second alternative type
 * @author Robert Varga
 */
@Beta
@NonNullByDefault
public class Either implements Immutable {
    private final @Nullable T first;
    private final @Nullable U second;

    @SuppressFBWarnings("NP_STORE_INTO_NONNULL_FIELD")
    protected Either(final T first) {
        this.first = requireNonNull(first);
        second = null;
    }

    @SuppressFBWarnings("NP_STORE_INTO_NONNULL_FIELD")
    protected Either(final U second, final @Nullable Void dummy) {
        first = null;
        this.second = requireNonNull(second);
    }

    protected final T first() {
        return verifyNotNull(first);
    }

    protected final U second() {
        return verifyNotNull(second);
    }

    /**
     * Create a new instance containing specified value.
     *
     * @param value Value
     * @param  First alternative type
     * @param  Second alternative type
     * @return A new instance
     * @throws NullPointerException if {@code value} is null
     */
    public static  Either ofFirst(final T value) {
        return new Either<>(value);
    }

    /**
     * Create a new instance containing specified value.
     *
     * @param value Value
     * @param  First alternative type
     * @param  Second alternative type
     * @return A new instance
     * @throws NullPointerException if {@code value} is null
     */
    public static  Either ofSecond(final U value) {
        return new Either<>(value, null);
    }

    public final boolean isFirst() {
        return first != null;
    }

    public final T getFirst() {
        return tryFirst().orElseThrow();
    }

    public final Optional tryFirst() {
        return Optional.ofNullable(first);
    }

    public final boolean isSecond() {
        return second != null;
    }

    public final U getSecond() {
        return trySecond().orElseThrow();
    }

    public final Optional trySecond() {
        return Optional.ofNullable(second);
    }

    @Override
    public final int hashCode() {
        return Objects.hash(first, second);
    }

    @Override
    public final boolean equals(final @Nullable Object obj) {
        if (obj == this) {
            return true;
        }
        if (obj == null || !getClass().equals(obj.getClass())) {
            return false;
        }
        final Either other = (Either) obj;
        return Objects.equals(first, other.first) && Objects.equals(second, other.second);
    }

    @Override
    public final String toString() {
        return addToString(MoreObjects.toStringHelper(this).omitNullValues()).toString();
    }

    protected ToStringHelper addToString(final ToStringHelper helper) {
        return helper.add("first", first).add("second", second);
    }
}