Dave Jarvis' Repositories

/*
 * Copyright (c) 2015 Karl Tauber <karl at jformdesigner dot com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  o Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *  o Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.scrivenvar.util;

/**
 * Simple item for a ChoiceBox, ComboBox or ListView. Consists of a string name
 * and a value object. toString() returns the name. equals() compares the value
 * and hashCode() returns the hash code of the value.
 *
 * @author Karl Tauber
 * @param <V> The type of item value.
 */
public class Item<V> {

  public final String name;
  public final V value;

  public Item( final String name, final V value ) {
    this.name = name;
    this.value = value;
  }

  @Override
  public boolean equals( final Object obj ) {
    if( this == obj ) {
      return true;
    }
    if( !(obj instanceof Item) ) {
      return false;
    }
    return Utils.safeEquals( value, ((Item<?>)obj).value );
  }

  @Override
  public int hashCode() {
    return (value != null) ? value.hashCode() : 0;
  }

  @Override
  public String toString() {
    return name;
  }
}