trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/Tuple.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *  
 *    http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License. 
 *  
 */
package org.apache.directory.api.ldap.model.cursor;


/**
 * A key/value tuple for simple two column persistent Tables with sorted keys.
 * 
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 * @param <K> The key type for the Tuple
 * @param <V> The associated Value type
 */
public class Tuple<K, V>
{
    /** the key for this Tuple */
    private K key;

    /** the value for this Tuple */
    private V value;


    /**
     * Do nothing default that has a null key and null value.
     */
    public Tuple()
    {
        // does nothing!
    }


    /**
     * Creates a Tuple using a key and a value.
     * 
     * @param key the key to set
     * @param value the value to set
     */
    public Tuple( K key, V value )
    {
        this.key = key;
        this.value = value;
    }


    /**
     * Gets the key for this Tuple.
     *
     * @return the Tuple's key
     */
    public K getKey()
    {
        return key;
    }


    /**
     * Sets the key for this Tuple.
     *
     * @param key the new key to set
     * @return this Tuple itself to set and return
     */
    public Tuple<K, V> setKey( K key )
    {
        this.key = key;

        return this;
    }


    /**
     * Gets the value for this Tuple.
     *
     * @return the Tuple's value
     */
    public V getValue()
    {
        return value;
    }


    /**
     * Sets the value for this Tuple.
     *
     * @param value the new value to set
     * @return this Tuple itself to set and return
     */
    public Tuple<K, V> setValue( V value )
    {
        this.value = value;

        return this;
    }


    /**
     * Sets both the key and the value for this Tuple in one call and returns
     * this Tuple object.  This is useful for setting the tuples key and value
     * then returning it.
     *
     * @param key the new key to set
     * @param value the new value to set
     * @return this Tuple itself to set and return
     */
    public Tuple<K, V> setBoth( K key, V value )
    {
        this.key = key;
        this.value = value;

        return this;
    }


    /**
     * Sets both the key and the value for this Tuple in one call and returns
     * this Tuple object.  This is useful for setting the tuples key and value
     * then returning it.
     *
     * @param tupleToCopy the tuple to copy
     * @return this Tuple itself to set and return
     */
    public Tuple<K, V> setBoth( Tuple<K, V> tupleToCopy )
    {
        this.key = tupleToCopy.key;
        this.value = tupleToCopy.value;

        return this;
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public int hashCode()
    {
        int prime = 31;
        int result = 1;

        if ( key == null )
        {
            result = prime * result;
        }
        else
        {
            result = prime * result + key.hashCode();
        }

        if ( value == null )
        {
            result = prime * result;
        }
        else
        {
            result = prime * result + value.hashCode();
        }

        return result;
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public boolean equals( Object obj )
    {
        if ( this == obj )
        {
            return true;
        }

        if ( obj == null )
        {
            return false;
        }

        if ( getClass() != obj.getClass() )
        {
            return false;
        }

        Tuple<?, ?> other = ( Tuple<?, ?> ) obj;

        if ( key == null )
        {
            if ( other.key != null )
            {
                return false;
            }
        }
        else if ( !key.equals( other.key ) )
        {
            return false;
        }

        if ( value == null )
        {
            if ( other.value != null )
            {
                return false;
            }
        }
        else if ( !value.equals( other.value ) )
        {
            return false;
        }

        return true;
    }


    /**
     * {@inheritDoc}
     */
    public String toString()
    {
        StringBuilder buf = new StringBuilder();

        buf.append( "Tuple( '" );
        buf.append( key );
        buf.append( "', '" );
        buf.append( value );
        buf.append( "' )" );

        return buf.toString();
    }
}