// This Source Code is in the Public Domain per: http://litesoft.org/License.txt
package org.litesoft.core.simpletypes;

import java.io.*;

import org.litesoft.commonfoundation.typeutils.*;
import org.litesoft.core.simpletypes.nonpublic.*;

public class NumericFormatControl extends CompareSupport<NumericFormatControl> implements Serializable
{
    private static final long serialVersionUID = 1L;

    public static final NumericFormatControl JUST_DOT = new NumericFormatControl( '.' );
    public static final NumericFormatControl COMMA_DOT = new NumericFormatControl( ',', '.' );
    public static final NumericFormatControl SPACE_COMMA = new NumericFormatControl( ' ', ',' );
    public static final NumericFormatControl SPACE_COMMA_SPACE = new NumericFormatControl( ' ', ',', true );

    public static final NumericFormatControl US = COMMA_DOT;

    private /* final */ char mDecimalSeparator;
    private /* final */ char mThousandsSeparator;
    private /* final */ boolean mSeparateFractionalThousands;

    @SuppressWarnings({"deprecation", "UnusedDeclaration"}) @Deprecated /** for Serialization */
    protected NumericFormatControl()
    {
    }

    public NumericFormatControl( char pThousandsSeparator, char pDecimalSeparator, boolean pSeparateFractionalThousands )
    {
        mDecimalSeparator = pDecimalSeparator;
        if ( mDecimalSeparator == 0 )
        {
            throw new IllegalArgumentException( "No Decimal Separator provided" );
        }
        mThousandsSeparator = pThousandsSeparator;
        mSeparateFractionalThousands = pSeparateFractionalThousands;
        if ( mDecimalSeparator == mThousandsSeparator )
        {
            throw new IllegalArgumentException( "Thousands Separator '" + mThousandsSeparator + "' MUST be different than the Decimal Separator '" + mDecimalSeparator + "'" );
        }
    }

    public NumericFormatControl( char pThousandsSeparator, char pDecimalSeparator )
    {
        this( pThousandsSeparator, pDecimalSeparator, false );
    }

    public NumericFormatControl( char pDecimalSeparator )
    {
        this( (char) 0, pDecimalSeparator, false );
    }

    public char getDecimalSeparator()
    {
        return mDecimalSeparator;
    }

    public char getThousandsSeparator()
    {
        return mThousandsSeparator;
    }

    public boolean isSeparateFractionalThousands()
    {
        return mSeparateFractionalThousands;
    }

    public boolean equals( Object o )
    {
        return (o instanceof NumericFormatControl) && equals( (NumericFormatControl) o );
    }

    public boolean equals( NumericFormatControl them )
    {
        return (this == them) || //
               ((them != null) //
                && equal( this.mDecimalSeparator, them.mDecimalSeparator ) //
                && equal( this.mThousandsSeparator, them.mThousandsSeparator ) //
                && equal( this.mSeparateFractionalThousands, them.mSeparateFractionalThousands ) //
               );
    }

    public int hashCode()
    {
        return (31 * mDecimalSeparator) + mThousandsSeparator;
    }

    public int compareTo( NumericFormatControl them )
    {
        return compareEm( compare( this.mDecimalSeparator, them.mDecimalSeparator ), //
                          compare( this.mThousandsSeparator, them.mThousandsSeparator ), //
                          compare( this.mSeparateFractionalThousands, them.mSeparateFractionalThousands ) );
    }

    public String toString()
    {
        return "NumericFormatControl: " + desiccate();
    }

    public String desiccate()
    {
        String rv = "#" + mDecimalSeparator + "#";
        if ( mThousandsSeparator != 0 )
        {
            rv = "#" + mThousandsSeparator + "##" + rv;
            if ( mSeparateFractionalThousands )
            {
                rv += "##" + mThousandsSeparator + "#";
            }
        }
        return rv;
    }

    public static NumericFormatControl rehydrate( String pDesiccated )
            throws IllegalArgumentException
    {
        pDesiccated = Strings.deNull( pDesiccated );
        if ( pDesiccated.startsWith( "#" ) && pDesiccated.endsWith( "#" ) )
        {
            switch ( pDesiccated.length() )
            {
                case 3: // #.#
                    return new NumericFormatControl( pDesiccated.charAt( 1 ) );
                case 7: // #,###.#
                    // ....0123456
                    if ( pDesiccated.substring( 2, 5 ).equals( "###" ) )
                    {
                        return new NumericFormatControl( pDesiccated.charAt( 1 ), pDesiccated.charAt( 5 ) );
                    }
                    break;
                case 11: // #,###.###,#
                    // .....01234567890
                    if ( pDesiccated.substring( 2, 5 ).equals( "###" ) && pDesiccated.substring( 6, 9 ).equals( "###" ) )
                    {
                        if ( pDesiccated.charAt( 1 ) != pDesiccated.charAt( 9 ) )
                        {
                            throw new IllegalArgumentException( "Unable to NumericFormatControl.rehydrate( \"" + pDesiccated + "\" ), the Thousands Separator must be the same in the Whole and Fractional sections, e.g.: '#,###.###,#'" );
                        }
                        return new NumericFormatControl( pDesiccated.charAt( 1 ), pDesiccated.charAt( 5 ), true );
                    }
                    break;
                default:
                    break;
            }
        }
        throw new IllegalArgumentException( "Unable to NumericFormatControl.rehydrate( \"" + pDesiccated + "\" ) possible options are: '#.#', '#,###.#', '#,###.###,#'" );
    }
}