Expose some useful methods on Looper and clean up docs. (803c2aff) · Commits · e / os / android_frameworks_base

api/current.txt

+2 −0

Original line number	Diff line number	Diff line
		@@ -22311,7 +22311,9 @@ package android.os {
		public final class Looper {
		method public void dump(android.util.Printer, java.lang.String);
		method public static android.os.Looper getMainLooper();
		method public android.os.MessageQueue getQueue();
		method public java.lang.Thread getThread();
		method public boolean isCurrentThread();
		method public static void loop();
		method public static android.os.Looper myLooper();
		method public static android.os.MessageQueue myQueue();

api/system-current.txt

+2 −0

Original line number	Diff line number	Diff line
		@@ -23906,7 +23906,9 @@ package android.os {
		public final class Looper {
		method public void dump(android.util.Printer, java.lang.String);
		method public static android.os.Looper getMainLooper();
		method public android.os.MessageQueue getQueue();
		method public java.lang.Thread getThread();
		method public boolean isCurrentThread();
		method public static void loop();
		method public static android.os.Looper myLooper();
		method public static android.os.MessageQueue myQueue();

core/java/android/os/Looper.java

+39 −25

Original line number	Diff line number	Diff line
		@@ -16,6 +16,8 @@

		package android.os;

		import android.annotation.NonNull;
		import android.annotation.Nullable;
		import android.util.Log;
		import android.util.Printer;

		@@ -57,7 +59,7 @@ public final class Looper {
		* based on MessageQueue. APIs that affect the state of the queue should be
		* defined on MessageQueue or Handler rather than on Looper itself. For example,
		* idle handlers and sync barriers are defined on the queue whereas preparing the
		* thread, looping and quitting are defined on the looper.
		* thread, looping, and quitting are defined on the looper.
		*/

		private static final String TAG = "Looper";
		@@ -104,7 +106,8 @@ public final class Looper {
		}
		}

		/** Returns the application's main looper, which lives in the main thread of the application.
		/**
		* Returns the application's main looper, which lives in the main thread of the application.
		*/
		public static Looper getMainLooper() {
		synchronized (Looper.class) {
		@@ -167,29 +170,16 @@ public final class Looper {
		* Return the Looper object associated with the current thread. Returns
		* null if the calling thread is not associated with a Looper.
		*/
		public static Looper myLooper() {
		public static @Nullable Looper myLooper() {
		return sThreadLocal.get();
		}

		/**
		* Control logging of messages as they are processed by this Looper. If
		* enabled, a log message will be written to <var>printer</var>
		* at the beginning and ending of each message dispatch, identifying the
		* target Handler and message contents.
		*
		* @param printer A Printer object that will receive log messages, or
		* null to disable message logging.
		*/
		public void setMessageLogging(Printer printer) {
		mLogging = printer;
		}

		/**
		* Return the {@link MessageQueue} object associated with the current
		* thread. This must be called from a thread running a Looper, or a
		* NullPointerException will be thrown.
		*/
		public static MessageQueue myQueue() {
		public static @NonNull MessageQueue myQueue() {
		return myLooper().mQueue;
		}

		@@ -200,12 +190,24 @@ public final class Looper {

		/**
		* Returns true if the current thread is this looper's thread.
		* @hide
		*/
		public boolean isCurrentThread() {
		return Thread.currentThread() == mThread;
		}

		/**
		* Control logging of messages as they are processed by this Looper. If
		* enabled, a log message will be written to <var>printer</var>
		* at the beginning and ending of each message dispatch, identifying the
		* target Handler and message contents.
		*
		* @param printer A Printer object that will receive log messages, or
		* null to disable message logging.
		*/
		public void setMessageLogging(@Nullable Printer printer) {
		mLogging = printer;
		}

		/**
		* Quits the looper.
		* <p>
		@@ -243,18 +245,30 @@ public final class Looper {
		}

		/**
		* Return the Thread associated with this Looper.
		* Gets the Thread associated with this Looper.
		*
		* @return The looper's thread.
		*/
		public Thread getThread() {
		public @NonNull Thread getThread() {
		return mThread;
		}

		/** @hide */
		public MessageQueue getQueue() {
		/**
		* Gets this looper's message queue.
		*
		* @return The looper's message queue.
		*/
		public @NonNull MessageQueue getQueue() {
		return mQueue;
		}

		public void dump(Printer pw, String prefix) {
		/**
		* Dumps the state of the looper for debugging purposes.
		*
		* @param pw A printer to receive the contents of the dump.
		* @param prefix A prefix to prepend to each line which is printed.
		*/
		public void dump(@NonNull Printer pw, @NonNull String prefix) {
		pw.println(prefix + toString());
		mQueue.dump(pw, prefix + " ");
		}