CancelableThread.java

/*
 * Copyright (C) 2009 Josh Guilfoyle <jasta@devtcg.org>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2, or (at your option) any
 * later version.
 *
 * This program 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
 * General Public License for more details.
 */

package org.devtcg.util;

import org.devtcg.five.Constants;

import android.util.Log;

public abstract class CancelableThread extends Thread
{
	public static final String TAG = "CancelableThread";

	private volatile boolean mCanceled = false;

	public CancelableThread()
	{
		super();
	}

	public CancelableThread(Runnable runnable, String threadName)
	{
		super(runnable, threadName);
	}

	public CancelableThread(Runnable runnable)
	{
		super(runnable);
	}

	public CancelableThread(String threadName)
	{
		super(threadName);
	}

	public void requestCancel()
	{
		if (mCanceled == true)
			return;

		mCanceled = true;

		interrupt();
		onRequestCancel();
	}

	protected void onRequestCancel() {}

	public void requestCancelAndWait()
	{
		requestCancel();
		joinUninterruptibly();
	}

	public boolean hasCanceled()
	{
		return mCanceled;
	}

	public void joinUninterruptibly()
	{
		long startTime;
		if (Constants.DEBUG)
			startTime = System.currentTimeMillis();

		while (true)
		{
			try {
				join();
				break;
			} catch (InterruptedException e) {}
		}

		if (Constants.DEBUG)
		{
			long elapsed = System.currentTimeMillis() - startTime;
			Log.d(TAG, toString() + " took " + elapsed + "ms to join.");
		}
	}
}