org.neo4j.helpers.Triplet Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) 2002-2013 "Neo Technology,"
 * Network Engine for Objects in Lund AB [http://neotechnology.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.helpers;

/**
 * Utility to handle triplets of objects.
 *
 * @param  the type of the {@link #first() first value} of the triplet.
 * @param  the type of the {@link #second() second value} of the triplet.
 * @param  the type of the {@link #third() third value} of the triplet.
 */
public class Triplet extends Pair>
{
    /**
     * Create a new triplet of objects.
     *
     * @param first the {@link #first() first value} of the triplet.
     * @param second the {@link #second() second value} of the triplet.
     * @param third the {@link #third() third value} of the triplet.
     * @return a new triplet of the supplied objects.
     */
    public static  Triplet of( T1 first, T2 second, T3 third )
    {
        return new Triplet( first, second, third );
    }

    private final T1 first;
    private final T2 second;
    private final T3 third;

    private Triplet( T1 first, T2 second, T3 third )
    {
        this.first = first;
        this.second = second;
        this.third = third;
    }

    @Override
    public T1 first()
    {
        return this.first;
    }

    /**
     * @return the second object in the triplet.
     */
    public T2 second()
    {
        return this.second;
    }

    /**
     * @return the third object in the triplet.
     */
    public T3 third()
    {
        return this.third;
    }

    @Override
    public Pair other()
    {
        return Pair.of( second, third );
    }

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

    @Override
    public int hashCode()
    {
        return ( ( 31 * hashCode( first ) ) | hashCode( second ) ) * 31 | hashCode( third );
    }

    @Override
    public boolean equals( Object obj )
    {
        if ( this == obj ) return true;
        if ( obj instanceof Triplet )
        {
            @SuppressWarnings( "rawtypes" ) Triplet that = (Triplet) obj;
            return equals( this.first, that.first ) && equals( this.second, that.second )
                   && equals( this.third, that.third );
        }
        if ( obj instanceof Pair )
        {
            @SuppressWarnings( "rawtypes" ) Pair that = (Pair) obj;
            Object other = that.other();
            if ( other instanceof Pair )
            {
                @SuppressWarnings( "rawtypes" ) Pair pair = (Pair) other;
                return equals( this.first, that.first() ) && equals( this.second, pair.first() )
                       && equals( this.third, pair.other() );
            }
        }
        return false;
    }
}