tests/common/com/android/documentsui/testing/TestTimer.java

/*
 * Copyright (C) 2016 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.documentsui.testing;

import java.lang.IllegalStateException;
import java.util.Date;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.ListIterator;
import java.util.Timer;
import java.util.TimerTask;

/**
 * A {@link Timer} for testing that can dial its clock hands to any future time.
 */
public class TestTimer extends Timer {

    private boolean mIsCancelled;
    private long mNow = 0;

    private final LinkedList<Task> mTaskList = new LinkedList<>();

    public long getNow() {
        return mNow;
    }

    public void fastForwardTo(long time) {
        if (time < mNow) {
            throw new IllegalArgumentException("Can't fast forward to past.");
        }

        mNow = time;
        while (!mTaskList.isEmpty() && mTaskList.getFirst().mExecuteTime <= mNow) {
            Task task = mTaskList.getFirst();
            if (!task.isCancelled()) {
                task.run();
            }
            mTaskList.removeFirst();
        }
    }

    public boolean hasScheduledTask() {
        return !mTaskList.isEmpty();
    }

    public void fastForwardToNextTask() {
        if (!hasScheduledTask()) {
            throw new IllegalStateException("There is no scheduled task!");
        }
        fastForwardTo(mTaskList.getFirst().mExecuteTime);
    }

    @Override
    public void cancel() {
        mIsCancelled = true;
        mTaskList.clear();
    }

    @Override
    public int purge() {
        int count = 0;
        Iterator<Task> iter = mTaskList.iterator();
        while (iter.hasNext()) {
            Task task = iter.next();
            if (task.isCancelled()) {
                iter.remove();
                ++count;
            }
        }
        return count;
    }

    @Override
    public void schedule(TimerTask task, Date time) {
        long executeTime = time.getTime();
        scheduleAtTime(task, executeTime);
    }

    @Override
    public void schedule(TimerTask task, Date firstTime, long period) {
        throw new UnsupportedOperationException();
    }

    @Override
    public void schedule(TimerTask task, long delay) {
        long executeTime = mNow + delay;
        scheduleAtTime(task, executeTime);
    }

    @Override
    public void schedule(TimerTask task, long delay, long period) {
        throw new UnsupportedOperationException();
    }

    @Override
    public void scheduleAtFixedRate(TimerTask task, Date firstTime, long period) {
        throw new UnsupportedOperationException();
    }

    @Override
    public void scheduleAtFixedRate(TimerTask task, long delay, long period) {
        throw new UnsupportedOperationException();
    }

    public void scheduleAtTime(TimerTask task, long executeTime) {
        if (mIsCancelled) {
            throw new IllegalStateException("Timer already cancelled.");
        }
        Task testTimerTask = (Task) task;
        testTimerTask.mExecuteTime = executeTime;

        ListIterator<Task> iter = mTaskList.listIterator(0);
        while (iter.hasNext()) {
            if (iter.next().mExecuteTime >= executeTime) {
                break;
            }
        }
        iter.add(testTimerTask);
    }

    public static class Task extends TimerTask {
        private boolean mIsCancelled;
        private long mExecuteTime;

        private TimerTask mDelegate;

        public Task(TimerTask delegate) {
            mDelegate = delegate;
        }

        @Override
        public boolean cancel() {
            mIsCancelled = true;
            return mDelegate.cancel();
        }

        @Override
        public void run() {
            mDelegate.run();
        }

        boolean isCancelled() {
            return mIsCancelled;
        }
    }
}