gov.sandia.cognition.util.DefaultKeyValuePair Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cognitive-foundry Show documentation
A single jar with all the Cognitive Foundry components.
There is a newer version: 4.0.1
/*
 * File:                DefaultKeyValuePair.java
 * Authors:             Justin Basilico
 * Company:             Sandia National Laboratories
 * Project:             Cognitive Foundry
 * 
 * Copyright November 28, 2010, Sandia Corporation.
 * Under the terms of Contract DE-AC04-94AL85000, there is a non-exclusive
 * license for use of this work by or on behalf of the U.S. Government. Export
 * of this program may require a license from the United States Government.
 * See CopyrightHistory.txt for complete details.
 * 
 */

package gov.sandia.cognition.util;

/**
 * A default implementation of the {@code KeyValuePair} interface.
 *
 * @param   
 *      The type of the key.
 * @param   
 *      The type of the value.
 * @author  Justin Basilico
 * @since   3.1
 */
public class DefaultKeyValuePair
    extends AbstractCloneableSerializable
    implements KeyValuePair
{

    /** The key part in the pair, which is the first element. */
    protected KeyType key;

    /** The value part in the pair, which is the second element. */
    protected ValueType value;

    /**
     * Creates a new, empty {@code DefaultKeyValuePair}.
     */
    public DefaultKeyValuePair()
    {
        this(null, null);
    }

    /**
     * Creates a new {@code DefaultKeyValuePair} from the given key and value.
     *
     * @param   key
     *      The key.
     * @param   value
     *      The value.
     */
    public DefaultKeyValuePair(
        final KeyType key,
        final ValueType value)
    {
        super();

        this.setKey(key);
        this.setValue(value);
    }

    /**
     * Creates a new {@code DefaultKeyValuePair} as a shallow copy of the
     * given key-value pair.
     *
     * @param   other
     *      The key-value pair to copy.
     */
    public DefaultKeyValuePair(
        final KeyValuePair other)
    {
        this(other.getKey(), other.getValue());
    }

    @Override
    public String toString()
    {
        return "(key: " + this.getKey() + ", value: " + this.getValue() + ")";
    }

    @Override
    public KeyType getFirst()
    {
        return this.getKey();
    }

    @Override
    public ValueType getSecond()
    {
        return this.getValue();
    }

    @Override
    public KeyType getKey()
    {
        return this.key;
    }

    /**
     * Sets the key element of the pair.
     *
     * @param   key
     *      The key.
     */
    public void setKey(
        final KeyType key)
    {
        this.key = key;
    }

    @Override
    public ValueType getValue()
    {
        return this.value;
    }

    /**
     * Sets the value element of the pair.
     *
     * @param   value
     *      The value.
     */
    public void setValue(
        final ValueType value)
    {
        this.value = value;
    }

    /**
     * Convenience method to create a new, empty {@code DefaultKeyValuePair}.
     *
     * @param   
     *      The type of the key.
     * @param   
     *      The type of the value.
     * @return
     *      A new, empty key-value pair.
     */
    public static  DefaultKeyValuePair create()
    {
        return new DefaultKeyValuePair();
    }

    /**
     *
     * Convenience method to create a new {@code DefaultKeyValuePair} from the
     * given key and value.
     *
     * @param   
     *      The type of the key.
     * @param   
     *      The type of the value.
     * @param   key
     *      The key.
     * @param   value
     *      The value.
     * @return
     *      A new, empty key-value pair.
     */
    public static  DefaultKeyValuePair create(
        final KeyType key,
        final ValueType value)
    {
        return new DefaultKeyValuePair(key, value);
    }

}