All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.github.czyzby.kiwi.util.tuple.mutable.MutableTriple Maven / Gradle / Ivy

    There is a newer version: 1.9.1.9.6
    Show newest version
    package com.github.czyzby.kiwi.util.tuple.mutable;

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.immutable.Triple;

/** Triple tuple. Stores three variables. Mutable 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.
 *
 * @author MJ */
public class MutableTriple implements TripleTuple {
    private static final long serialVersionUID = 1L;

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

    public MutableTriple(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 triple with the passed variables. Accepts nulls.
     * @param  type of first value.
     * @param  type of second value.
     * @param  type of third value. */
    public static  MutableTriple of(final First first, final Second second,
            final Third third) {
        return new MutableTriple(first, second, third);
    }

    /** @param first cannot be null.
     * @param second cannot be null.
     * @param third cannot be null.
     * @return a new triple 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  MutableTriple 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 triple with null value.");
        }
        return new MutableTriple(first, second, third);
    }

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

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

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

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

    /** @param first will become first value in the triple. */
    public void setFirst(final First first) {
        this.first = first;
    }

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

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

    /** @param second will become second value in the triple. Equivalent of setValue. */
    public void setSecond(final Second second) {
        this.second = second;
    }

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

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

    /** @param third will become third value in the triple. */
    public void setThird(final Third third) {
        this.third = third;
    }

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

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

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

    @Override
    public Second setValue(final Second value) {
        second = value;
        return second;
    }

    @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 triple: " + index + ".");
    }

    @Override
    @SuppressWarnings("unchecked")
    public  Type get(final int index, final Class asInstanceOf) throws IndexOutOfBoundsException {
        // Generally 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 triple: " + index + ".");
    }

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

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

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

    /** @return a new instance of immutable Triple constructed this triple's values. */
    public Triple toImmutable() {
        return Triple.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 iterator() {
        return Tuples.getTupleIterator(this);
    }

    @Override
    public boolean contains(final Object value) {
        return Nullables.areEqual(value, first) || Nullables.areEqual(value, second)
                || Nullables.areEqual(value, third);
    }

    @Override
    public boolean containsAll(final Object... values) {
        for (final Object value : values) {
            if (!contains(value)) {
                return false;
            }
        }
        return true;
    }

    @Override
    public boolean containsAll(final Iterable values) {
        for (final Object value : values) {
            if (!contains(value)) {
                return false;
            }
        }
        return true;
    }

    @Override
    public boolean containsAny(final Object... values) {
        for (final Object value : values) {
            if (contains(value)) {
                return true;
            }
        }
        return false;
    }

    @Override
    public boolean containsAny(final Iterable values) {
        for (final Object value : values) {
            if (contains(value)) {
                return true;
            }
        }
        return false;
    }

    @Override
    public int indexOf(final Object value) {
        return Nullables.areEqual(value, first) ? 0
                : Nullables.areEqual(value, second) ? 1 : Nullables.areEqual(value, third) ? 2 : INVALID_INDEX;
    }

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

    @Override
    @SuppressWarnings("unchecked")
    public void set(final int index, final Object value) {
        if (index == 0) {
            first = (First) value;
        } else if (index == 1) {
            second = (Second) value;
        } else if (index == 2) {
            third = (Third) value;
        } else {
            throw new IndexOutOfBoundsException("Invalid index passed to triple: " + index + ".");
        }
    }

    @Override
    public Object[] toArray() {
        return new Object[] { first, second, third };
    }

    @Override
    @SuppressWarnings("unchecked")
    public  Type[] toArray(final Type[] array) {
        array[0] = (Type) first;
        array[1] = (Type) second;
        array[2] = (Type) third;
        return array;
    }

    @Override
    public  Iterator iterator(final Class forClass) {
        return Tuples.getTupleIterator(this);
    }
}    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy