package org.litesoft.core.simpletypes.temporal;

import org.litesoft.core.simpletypes.temporal.nonpublic.*;

/**
 * A Time resolution from the Hour thru the Millisecond.
 */
public final class TimeRes extends AbstractRes
{
    // Formatting Indicators
    public static final char INDICATOR_HOUR = 'H';
    public static final char INDICATOR_MIN = 'm';
    public static final char INDICATOR_SEC = 's';
    public static final char INDICATOR_MSEC = 'S';

    public static final int HOURindex = 0;
    public static final int MINindex = 1;
    public static final int SECindex = 2;
    public static final int MSECindex = 3;

    public static TimeRes ToHOUR = new TimeRes( "ToHOUR", "Hour", HOURindex, INDICATOR_HOUR );
    public static TimeRes ToMIN = new TimeRes( "ToMIN", "Min", MINindex, INDICATOR_MIN );
    public static TimeRes ToSEC = new TimeRes( "ToSEC", "Sec", SECindex, INDICATOR_SEC );
    public static TimeRes ToMSEC = new TimeRes( "ToMSEC", "MilliSec", MSECindex, INDICATOR_MSEC );

    /**
     * @deprecated - for Serialization
     */
    protected TimeRes()
    {
    }

    private TimeRes( String pName, String pFriendlyName, int pIndex, char pIndicator )
    {
        super( pName, pFriendlyName, pIndex, pIndicator );
    }

    private static AbstractRes[] OPTIONS = new AbstractRes[]{ToHOUR, ToMIN, ToSEC, ToMSEC,};

    public static TimeRes fromIndex( int pIndex )
    {
        return (TimeRes) LLfromIndex( OPTIONS, pIndex );
    }

    public static TimeRes rehydrate( String pDesiccated )
            throws IllegalArgumentException
    {
        return (TimeRes) LLrehydrate( "TimeRes", OPTIONS, pDesiccated );
    }

    public boolean isValidToMin()
    {
        return MINindex <= getIndex();
    }

    public boolean isValidToSec()
    {
        return SECindex <= getIndex();
    }

    public boolean isValidToMilliSec()
    {
        return MSECindex <= getIndex();
    }
}