com.github.czyzby.kiwi.util.tuple.immutable.Triple Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gdx-kiwi Show documentation
Guava-inspired set of utilities for LibGDX.
There is a newer version: 1.9.1.9.6
package com.github.czyzby.kiwi.util.tuple.immutable;

import java.util.Iterator;

import com.github.czyzby.kiwi.util.common.Nullables;
import com.github.czyzby.kiwi.util.tuple.TripleTuple;
import com.github.czyzby.kiwi.util.tuple.Tuples;
import com.github.czyzby.kiwi.util.tuple.mutable.MutableTriple;

/** Triple tuple. Stores three variables. Immutable utility container for all these cases that three variables have to
 * be returned by a function or otherwise passed and stored together. Implements Map.Entry using first variable as key
 * and second as value for additional utility, although it obviously doesn't store just 2 values. Additionally, it
 * doesn't allow changing its value with setValue (throws AssertionError).
 *
 * @author MJ */
public class Triple implements TripleTuple {
    private static final long serialVersionUID = 1L;

    private final First first;
    private final Second second;
    private final Third third;

    public Triple(final First first, final Second second, final Third third) {
        this.first = first;
        this.second = second;
        this.third = third;
    }

    /** @param first can be null.
     * @param second can be null.
     * @param third can be null.
     * @return a new triplet with the passed variables. Accepts nulls.
     * @param  type of first value.
     * @param  type of second value.
     * @param  type of third value. */
    public static  Triple of(final First first, final Second second,
            final Third third) {
        return new Triple(first, second, third);
    }

    /** @param first cannot be null.
     * @param second cannot be null.
     * @param third cannot be null.
     * @return a new triplet with the passed variables.
     * @throws NullPointerException if any of the variables are null.
     * @param  type of first value.
     * @param  type of second value.
     * @param  type of third value. */
    public static  Triple ofNonNull(final First first, final Second second,
            final Third third) throws NullPointerException {
        if (first == null || second == null || third == null) {
            throw new NullPointerException("Tried to construct non-nullable triplet with null value.");
        }
        return new Triple(first, second, third);
    }

    /** @param triplet will be inverted.
     * @return a new triplet with inverted first and third values.
     * @param  type of first value.
     * @param  type of second value.
     * @param  type of third value. */
    public static  Triple invert(
            final Triple triplet) {
        return new Triple(triplet.getThird(), triplet.getSecond(), triplet.getFirst());
    }

    /** @param triplet will be shifted left.
     * @return a new triplet with values shifted left.
     * @param  type of first value.
     * @param  type of second value.
     * @param  type of third value. */
    public static  Triple shiftLeft(
            final Triple triplet) {
        return new Triple(triplet.getSecond(), triplet.getThird(), triplet.getFirst());
    }

    /** @param triplet will be shifted right.
     * @return a new triplet with values shifted right.
     * @param  type of first value.
     * @param  type of second value.
     * @param  type of third value. */
    public static  Triple shiftRight(
            final Triple triplet) {
        return new Triple(triplet.getThird(), triplet.getFirst(), triplet.getSecond());
    }

    @Override
    public First getFirst() {
        return first;
    }

    @Override
    public boolean isFirstPresent() {
        return first != null;
    }

    @Override
    public Second getSecond() {
        return second;
    }

    @Override
    public boolean isSecondPresent() {
        return second != null;
    }

    @Override
    public Third getThird() {
        return third;
    }

    @Override
    public boolean isThirdPresent() {
        return second != null;
    }

    @Override
    public First getKey() {
        return first;
    }

    @Override
    public Second getValue() {
        return second;
    }

    @Override
    @Deprecated
    public Second setValue(final Second value) {
        throw new UnsupportedOperationException("Triple cannot be modified.");
    }

    @Override
    public Object get(final int index) throws IndexOutOfBoundsException {
        // Generally a little bit faster than a switch.
        if (index == 0) {
            return first;
        }
        if (index == 1) {
            return second;
        }
        if (index == 2) {
            return third;
        }
        throw new IndexOutOfBoundsException("Invalid index passed to triplet: " + index + ".");
    }

    @Override
    @SuppressWarnings("unchecked")
    public  Type get(final int index, final Class asInstanceOf) throws IndexOutOfBoundsException {
        // Generally a little bit faster than switch.
        if (index == 0) {
            return (Type) first;
        }
        if (index == 1) {
            return (Type) second;
        }
        if (index == 2) {
            return (Type) third;
        }
        throw new IndexOutOfBoundsException("Invalid index passed to triplet: " + index + ".");
    }

    @Override
    public Triple invert() {
        return of(third, second, first);
    }

    @Override
    public Triple shiftLeft() {
        return of(second, third, first);
    }

    @Override
    public Triple shitfRight() {
        return of(third, first, second);
    }

    /** @return a new instance of MutableTriplet constructed with this triplet's values. */
    public MutableTriple toMutable() {
        return MutableTriple.of(first, second, third);
    }

    @Override
    public int getSize() {
        return SIZE;
    }

    @Override
    public int hashCode() {
        int hash = 0;
        if (first != null) {
            hash = first.hashCode();
        }
        if (second != null) {
            hash ^= second.hashCode();
        }
        if (third != null) {
            hash ^= third.hashCode();
        }
        return hash;
    }

    @Override
    public boolean equals(final Object object) {
        return object == this || object instanceof TripleTuple
                && Nullables.areEqual(first, ((TripleTuple) object).getFirst())
                && Nullables.areEqual(second, ((TripleTuple) object).getSecond())
                && Nullables.areEqual(third, ((TripleTuple) object).getThird());
    }

    @Override
    public String toString() {
        return first + COMMA_WITH_SPACE_SEPARATOR + second + COMMA_WITH_SPACE_SEPARATOR + third;
    }

    @Override
    public Iterator