org.incava.ijdk.tuple.Triple Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ijdk Show documentation

Incava Java Development Kit

There is a newer version: 3.9.0

package org.incava.ijdk.tuple;

import org.incava.ijdk.collect.Array;
import org.incava.ijdk.lang.Comp;

/**
 * A set of three objects.
 * 
 * @param  the type of the first object
 * @param  the type of the second object
 * @param  the type of the third object
 */
public class Triple extends Pair {
    /**
     * Shorter syntax than the default constructor, allowing the compiler to discern the object types.
     * 
     * @param  the type of the first object
     * @param  the type of the second object
     * @param  the type of the third object
     * @param first the first object
     * @param second the second object
     * @param third the third object
     * @return the new triple
     */
    public static  Triple of(A first, B second, C third) {
        return new Triple(first, second, third);
    }

    private final C third;
    
    public Triple(A first, B second, C third) {
        super(first, second);
        this.third = third;
    }

    public C getThird() {
        return third;
    }

    public C third() {
        return third;
    }

    public String toString() {
        return "(" + first() + ", " + second() + ", " + third() + ")";
    }

    @SuppressWarnings({ "unchecked", "rawtypes" })
    public int compareTo(Triple other) {
        int cmp = super.compareTo(other);
        if (cmp == 0) {
            if (this.third instanceof Comparable) {
                Comparable ctt = (Comparable)this.third;
                Comparable cot = (Comparable)other.third;
                return Comp.compare(ctt, cot);
            }
            else {
                return -1;
            }
        }
        else {
            return cmp;
        }
    }

    /**
     * Returns the values that comprise this object in terms of equality and hash codes. This is the
     * key and the value.
     */
    public Array