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

import org.litesoft.commonfoundation.base.*;

public interface TimedRunnable
{
    public static abstract class Again
    {
        private long mValue;

        protected Again( long pValue )
        {
            mValue = pValue;
        }

        public long getValue()
        {
            return mValue;
        }

        abstract public long getOnOrAfter( MillisecTimeSource pMillisecTimeSource );
    }

    public static class RunAgainOnOrAfter extends Again
    {
        public RunAgainOnOrAfter( long pValue )
        {
            super( pValue );
        }

        public long getOnOrAfter( MillisecTimeSource pMillisecTimeSource )
        {
            return getValue();
        }
    }

    public static class RunAgainIn extends Again
    {
        public RunAgainIn( long pValue )
        {
            super( pValue );
        }

        public long getOnOrAfter( MillisecTimeSource pMillisecTimeSource )
        {
            return pMillisecTimeSource.now() + getValue();
        }
    }

    /**
     * @return an 'Again' indicator to fire again (either an absolute time 'RunAgainOnOrAfter' or a duration 'RunAgainIn'),
     *         or <code>null</code> for never
     */
    public Again runOnce();

    public static final TimedRunnable NULL = new TimedRunnable()
    {
        public Again runOnce()
        {
            return null;
        }
    };
}