/******************************************************************************
 * Product: Adempiere ERP & CRM Smart Business Solution                       *
 * Copyright (C) 1999-2006 ComPiere, Inc. All Rights Reserved.                *
 * This program is free software; you can redistribute it and/or modify it    *
 * under the terms version 2 of the GNU General Public License as published   *
 * by the Free Software Foundation. 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, write to the Free Software Foundation, Inc.,    *
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.                     *
 * For the text or an alternative of this public license, you may reach us    *
 * ComPiere, Inc., 2620 Augustine Dr. #245, Santa Clara, CA 95054, USA        *
 * or via info@compiere.org or http://www.compiere.org/license.html           *
 *****************************************************************************/
package org.compiere.util;

/**
 *	Value Name Pair (String key and name)
 *
 *  @author     Jorg Janke
 *  @version    $Id: ValueNamePair.java,v 1.2 2006/07/30 00:52:23 jjanke Exp $
 */
public final class ValueNamePair extends NamePair
{
	/**
	 * generated serial id
	 */
	private static final long serialVersionUID = -8315081335749462163L;
	
	public static final ValueNamePair EMPTY = new ValueNamePair("", "");

	/**
	 *	Construct ValueNamePair Pair
	 *  @param value value
	 *  @param name string representation
	 */
	public ValueNamePair(String value, String name)
	{
		super(name);
		m_value = value;
		if (m_value == null)
			m_value = "";
	}   //  ValueNamePair

	/** The Key Value       */
	private String m_value = null;

	/**
	 *	Get Key Value
	 *  @return Key Value
	 */
	public String getValue()
	{
		return m_value;
	}	//	getValue

	/**
	 *	Get String ID
	 *  @return Value
	 */
	public String getID()
	{
		if("".equals(m_value))
			return null;
		return m_value;
	}	//	getID

	/**
	 *	Equals
	 *  @param obj Object
	 *  @return true, if equal
	 */
	@Override
	public boolean equals(Object obj)
	{
		if (obj instanceof ValueNamePair)
		{
			ValueNamePair pp = (ValueNamePair)obj;
			if (pp.getName() != null && pp.getValue() != null &&
				pp.getName().equals(getName()) && pp.getValue().equals(m_value))
				return true;
			return false;
		}
		return false;
	}	//	equals

	/**
	 * Get the Object representation of the value
	 * @return value
	 */
	public Object getValueObject()
	{
	    return m_value;
	}
	
	/**
	 *  Return Hashcode of value
	 *  @return hascode
	 */
	@Override
	public int hashCode()
	{
		return m_value.hashCode();
	}   //  hashCode

}