/*
 * Copyright (C) 2006 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 android.os;

/**
 * Handy class for starting a new thread that has a looper. The looper can then
 * be used to create handler classes. Note that start() must still be called.
 */
public class HandlerThread extends Thread {
    private int mPriority;
    private int mTid = -1;
    private Looper mLooper;

    public HandlerThread(String name) {
        super(name);
        mPriority = Process.THREAD_PRIORITY_DEFAULT;
        mLooper = new Looper();
    }

    /**
     * Constructs a HandlerThread.
     * 
     * @param name
     * @param priority The priority to run the thread at. The value supplied
     *            must be from {@link android.os.Process} and not from
     *            java.lang.Thread.
     */
    public HandlerThread(String name, int priority) {
        super(name);
        mPriority = priority;
        mLooper = new Looper();
    }

    /**
     * Call back method that can be explicitly over ridden if needed to execute
     * some setup before Looper loops.
     */
    protected void onLooperPrepared() {
    }

    public void run() {
        mTid = -1;
    }

    /**
     * This method returns the Looper associated with this thread. If this
     * thread not been started or for any reason is isAlive() returns false,
     * this method will return null. If this thread has been started, this
     * method will block until the looper has been initialized.
     * 
     * @return The looper.
     */
    public Looper getLooper() {
        return mLooper;
    }

    /**
     * Ask the currently running looper to quit. If the thread has not been
     * started or has finished (that is if {@link #getLooper} returns null),
     * then false is returned. Otherwise the looper is asked to quit and true is
     * returned.
     */
    public boolean quit() {
        if (mLooper != null) {
        	mLooper.quit();
            return true;
        }
        return false;
    }

    /**
     * Returns the identifier of this thread. See Process.myTid().
     */
    public int getThreadId() {
        return mTid;
    }
}