/*
 *  jDTAUS Banking RI CurrencyDirectory
 *  Copyright (C) 2005 Christian Schulte
 *  <cs@schulte.it>
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or any later version.
 *
 *  This library 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
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */
package org.jdtaus.banking.ri.currencydir;

import java.io.Serializable;
import java.util.Date;

/**
 * Currency.
 *
 * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
 * @version $JDTAUS: JaxpCurrency.java 8865 2014-01-10 17:13:42Z schulte $
 */
public class JaxpCurrency implements Serializable, Cloneable
{

    /** Serial version UID for backwards compatibility with 1.0.x classes. */
    private static final long serialVersionUID = 3499875740280116856L;

    /**
     * ISO currency code.
     * @serial
     */
    private String isoCode;

    /**
     * DTAUS currency code.
     * @serial
     */
    private Character dtausCode;

    /**
     * Start date.
     * @serial
     */
    private Date startDate;

    /**
     * End date.
     * @serial
     */
    private Date endDate;

    /** Cached hash-code. */
    private transient int hashCode = NO_HASHCODE;

    /** Constant for field {@code hashCode} forcing hash code computation. */
    private static final int NO_HASHCODE = Integer.MIN_VALUE;

    /** Creates a new {@code JaxpCurrency} instance. */
    public JaxpCurrency()
    {
        super();
    }

    /**
     * Gets the ISO currency code.
     *
     * @return The ISO currency code.
     */
    public String getIsoCode()
    {
        return this.isoCode;
    }

    /**
     * Sets the ISO currency code.
     *
     * @param value The ISO currency code.
     */
    public void setIsoCode( final String value )
    {
        this.isoCode = value;
        this.hashCode = NO_HASHCODE;
    }

    /**
     * Gets the DTAUS currency code.
     *
     * @return The DTAUS currency code or {@code null}.
     */
    public Character getDtausCode()
    {
        return this.dtausCode;
    }

    /**
     * Sets the DTAUS currency code.
     *
     * @param value The DTAUS currency code or {@code null}.
     */
    public void setDtausCode( final Character value )
    {
        this.dtausCode = value;
        this.hashCode = NO_HASHCODE;
    }

    /**
     * Gets the start date.
     *
     * @return The start date..
     */
    public Date getStartDate()
    {
        return (Date) ( this.startDate == null ? null : this.startDate.clone() );
    }

    /**
     * Sets the start date.
     *
     * @param value The start date.
     */
    public void setStartDate( final Date value )
    {
        this.startDate = (Date) ( value == null ? null : value.clone() );
        this.hashCode = NO_HASHCODE;
    }

    /**
     * Gets the end date.
     *
     * @return The end date.
     */
    public Date getEndDate()
    {
        return (Date) ( this.endDate == null ? null : this.endDate.clone() );
    }

    /**
     * Sets the end date.
     *
     * @param value The end date.
     */
    public void setEndDate( final Date value )
    {
        this.endDate = (Date) ( value == null ? null : value.clone() );
        this.hashCode = NO_HASHCODE;
    }

    /**
     * Checks that the currency is valid at a given date.
     *
     * @param date The date with which to check.
     *
     * @return {@code true}, if the currency is valid at {@code date};
     * {@code false} if not.
     *
     * @throws NullPointerException if {@code date} is {@code null}.
     */
    public boolean isValidAt( final Date date )
    {
        if ( date == null )
        {
            throw new NullPointerException( "date" );
        }

        return ( date.equals( this.startDate )
                 || date.after( this.startDate ) )
               && ( this.endDate == null
                    || date.equals( this.endDate )
                    || date.before( this.endDate ) );

    }

    /**
     * Creates and returns a copy of this object.
     *
     * @return A clone of this instance.
     */
    public Object clone()
    {
        try
        {
            final JaxpCurrency ret = (JaxpCurrency) super.clone();
            if ( this.startDate != null )
            {
                ret.startDate = (Date) this.startDate.clone();
            }
            if ( this.endDate != null )
            {
                ret.endDate = (Date) this.endDate.clone();
            }

            return ret;
        }
        catch ( final CloneNotSupportedException e )
        {
            throw new AssertionError( e );
        }
    }

    /**
     * Indicates whether some other object is equal to this one by comparing the values of all properties.
     *
     * @param o The reference object with which to compare.
     *
     * @return {@code true} if this object is the same as {@code o}; {@code false} otherwise.
     */
    public boolean equals( final Object o )
    {
        boolean ret = o == this;

        if ( !ret && o instanceof JaxpCurrency )
        {
            final JaxpCurrency that = (JaxpCurrency) o;

            ret = ( this.isoCode == null
                    ? that.isoCode == null
                    : this.isoCode.equals( that.isoCode ) )
                  && ( this.dtausCode == null
                       ? that.dtausCode == null
                       : this.dtausCode.equals( that.dtausCode ) )
                  && ( this.startDate == null
                       ? that.startDate == null
                       : this.startDate.equals( that.startDate ) )
                  && ( this.endDate == null
                       ? that.endDate == null
                       : this.endDate.equals( that.endDate ) );

        }

        return ret;
    }

    /**
     * Returns a hash code value for this object.
     *
     * @return A hash code value for this object.
     */
    public int hashCode()
    {
        if ( this.hashCode == NO_HASHCODE )
        {
            int hc = 23;
            hc = 37 * hc + ( this.dtausCode == null
                             ? 0
                             : (int) this.dtausCode.charValue() );
            hc = 37 * hc + ( this.isoCode == null
                             ? 0
                             : this.isoCode.hashCode() );
            hc = 37 * hc + ( this.startDate == null
                             ? 0
                             : this.startDate.hashCode() );
            hc = 37 * hc + ( this.endDate == null
                             ? 0
                             : this.endDate.hashCode() );

            this.hashCode = hc;
        }

        return this.hashCode;
    }

    /**
     * Returns a string representation of the object.
     *
     * @return A string representation of the object.
     */
    public String toString()
    {
        return super.toString() + this.internalString();
    }

    /**
     * Creates a string representing the properties of the instance.
     *
     * @return A string representing the properties of the instance.
     */
    private String internalString()
    {
        return new StringBuffer( 200 ).append( '{' ).
            append( "isoCode=" ).append( this.isoCode ).
            append( ", dtausCode=" ).append( this.dtausCode ).
            append( ", startDate=" ).append( this.startDate ).
            append( ", endDate=" ).append( this.endDate ).
            append( '}' ).toString();

    }

}