Merge "Move condition logic to shared lib so it can be reused in DockSetup... (8d46cbb3) · Commits · e / os / android_frameworks_base

packages/SystemUI/src/com/android/systemui/util/condition/CombinedCondition.kt→packages/SystemUI/shared/src/com/android/systemui/shared/condition/CombinedCondition.kt

+1 −1

Original line number	Original line	Diff line number	Diff line
	@@ -14,7 +14,7 @@
	* limitations under the License.		* limitations under the License.
	*/		*/

	package com.android.systemui.util.condition		package com.android.systemui.shared.condition

	/**		/**
	* A higher order [Condition] which combines multiple conditions with a specified		* A higher order [Condition] which combines multiple conditions with a specified

packages/SystemUI/src/com/android/systemui/util/condition/Condition.java→packages/SystemUI/shared/src/com/android/systemui/shared/condition/Condition.java

+36 −14

Original line number	Original line	Diff line number	Diff line
	/*		/*
	* Copyright (C) 2021 The Android Open Source Project		* Copyright (C) 2022 The Android Open Source Project
	*		*
	* Licensed under the Apache License, Version 2.0 (the "License");		* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.		* you may not use this file except in compliance with the License.
	@@ -14,13 +14,14 @@
	* limitations under the License.		* limitations under the License.
	*/		*/

	package com.android.systemui.util.condition;		package com.android.systemui.shared.condition;

	import android.util.Log;		import android.util.Log;

	import com.android.systemui.statusbar.policy.CallbackController;		import androidx.annotation.NonNull;
			import androidx.lifecycle.Lifecycle;
	import org.jetbrains.annotations.NotNull;		import androidx.lifecycle.LifecycleEventObserver;
			import androidx.lifecycle.LifecycleOwner;

	import java.lang.ref.WeakReference;		import java.lang.ref.WeakReference;
	import java.util.ArrayList;		import java.util.ArrayList;
	@@ -33,7 +34,7 @@ import java.util.List;
	* Base class for a condition that needs to be fulfilled in order for {@link Monitor} to inform		* Base class for a condition that needs to be fulfilled in order for {@link Monitor} to inform
	* its callbacks.		* its callbacks.
	*/		*/
	public abstract class Condition implements CallbackController<Condition.Callback> {		public abstract class Condition {
	private final String mTag = getClass().getSimpleName();		private final String mTag = getClass().getSimpleName();

	private final ArrayList<WeakReference<Callback>> mCallbacks = new ArrayList<>();		private final ArrayList<WeakReference<Callback>> mCallbacks = new ArrayList<>();
	@@ -79,8 +80,7 @@ public abstract class Condition implements CallbackController<Condition.Callback
	* Registers a callback to receive updates once started. This should be called before		* Registers a callback to receive updates once started. This should be called before
	* {@link #start()}. Also triggers the callback immediately if already started.		* {@link #start()}. Also triggers the callback immediately if already started.
	*/		*/
	@Override		public void addCallback(@NonNull Callback callback) {
	public void addCallback(@NotNull Callback callback) {
	if (shouldLog()) Log.d(mTag, "adding callback");		if (shouldLog()) Log.d(mTag, "adding callback");
	mCallbacks.add(new WeakReference<>(callback));		mCallbacks.add(new WeakReference<>(callback));

	@@ -96,8 +96,7 @@ public abstract class Condition implements CallbackController<Condition.Callback
	/**		/**
	* Removes the provided callback from further receiving updates.		* Removes the provided callback from further receiving updates.
	*/		*/
	@Override		public void removeCallback(@NonNull Callback callback) {
	public void removeCallback(@NotNull Callback callback) {
	if (shouldLog()) Log.d(mTag, "removing callback");		if (shouldLog()) Log.d(mTag, "removing callback");
	final Iterator<WeakReference<Callback>> iterator = mCallbacks.iterator();		final Iterator<WeakReference<Callback>> iterator = mCallbacks.iterator();
	while (iterator.hasNext()) {		while (iterator.hasNext()) {
	@@ -115,6 +114,29 @@ public abstract class Condition implements CallbackController<Condition.Callback
	mStarted = false;		mStarted = false;
	}		}

			/**
			* Wrapper to {@link #addCallback(Callback)} when a lifecycle is in the resumed state
			* and {@link #removeCallback(Callback)} when not resumed automatically.
			*/
			public Callback observe(LifecycleOwner owner, Callback listener) {
			return observe(owner.getLifecycle(), listener);
			}

			/**
			* Wrapper to {@link #addCallback(Callback)} when a lifecycle is in the resumed state
			* and {@link #removeCallback(Condition.Callback)} when not resumed automatically.
			*/
			public Callback observe(Lifecycle lifecycle, Callback listener) {
			lifecycle.addObserver((LifecycleEventObserver) (lifecycleOwner, event) -> {
			if (event == Lifecycle.Event.ON_RESUME) {
			addCallback(listener);
			} else if (event == Lifecycle.Event.ON_PAUSE) {
			removeCallback(listener);
			}
			});
			return listener;
			}

	/**		/**
	* Updates the value for whether the condition has been fulfilled, and sends an update if the		* Updates the value for whether the condition has been fulfilled, and sends an update if the
	* value changes and any callback is registered.		* value changes and any callback is registered.
	@@ -187,7 +209,7 @@ public abstract class Condition implements CallbackController<Condition.Callback
	* Creates a new condition which will only be true when both this condition and all the provided		* Creates a new condition which will only be true when both this condition and all the provided
	* conditions are true.		* conditions are true.
	*/		*/
	public Condition and(Collection<Condition> others) {		public Condition and(@NonNull Collection<Condition> others) {
	final List<Condition> conditions = new ArrayList<>(others);		final List<Condition> conditions = new ArrayList<>(others);
	conditions.add(this);		conditions.add(this);
	return new CombinedCondition(conditions, Evaluator.OP_AND);		return new CombinedCondition(conditions, Evaluator.OP_AND);
	@@ -197,7 +219,7 @@ public abstract class Condition implements CallbackController<Condition.Callback
	* Creates a new condition which will only be true when both this condition and the provided		* Creates a new condition which will only be true when both this condition and the provided
	* condition is true.		* condition is true.
	*/		*/
	public Condition and(Condition other) {		public Condition and(@NonNull Condition other) {
	return new CombinedCondition(Arrays.asList(this, other), Evaluator.OP_AND);		return new CombinedCondition(Arrays.asList(this, other), Evaluator.OP_AND);
	}		}

	@@ -205,7 +227,7 @@ public abstract class Condition implements CallbackController<Condition.Callback
	* Creates a new condition which will only be true when either this condition or any of the		* Creates a new condition which will only be true when either this condition or any of the
	* provided conditions are true.		* provided conditions are true.
	*/		*/
	public Condition or(Collection<Condition> others) {		public Condition or(@NonNull Collection<Condition> others) {
	final List<Condition> conditions = new ArrayList<>(others);		final List<Condition> conditions = new ArrayList<>(others);
	conditions.add(this);		conditions.add(this);
	return new CombinedCondition(conditions, Evaluator.OP_OR);		return new CombinedCondition(conditions, Evaluator.OP_OR);
	@@ -215,7 +237,7 @@ public abstract class Condition implements CallbackController<Condition.Callback
	* Creates a new condition which will only be true when either this condition or the provided		* Creates a new condition which will only be true when either this condition or the provided
	* condition is true.		* condition is true.
	*/		*/
	public Condition or(Condition other) {		public Condition or(@NonNull Condition other) {
	return new CombinedCondition(Arrays.asList(this, other), Evaluator.OP_OR);		return new CombinedCondition(Arrays.asList(this, other), Evaluator.OP_OR);
	}		}

packages/SystemUI/src/com/android/systemui/util/condition/Evaluator.kt→packages/SystemUI/shared/src/com/android/systemui/shared/condition/Evaluator.kt

+17 −1

Original line number	Original line	Diff line number	Diff line
	package com.android.systemui.util.condition		/*
			* Copyright (C) 2022 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.systemui.shared.condition

	import android.annotation.IntDef		import android.annotation.IntDef

packages/SystemUI/src/com/android/systemui/util/condition/Monitor.java→packages/SystemUI/shared/src/com/android/systemui/shared/condition/Monitor.java

+6 −6

Original line number	Original line	Diff line number	Diff line
	/*		/*
	* Copyright (C) 2021 The Android Open Source Project		* Copyright (C) 2022 The Android Open Source Project
	*		*
	* Licensed under the Apache License, Version 2.0 (the "License");		* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.		* you may not use this file except in compliance with the License.
	@@ -14,14 +14,14 @@
	* limitations under the License.		* limitations under the License.
	*/		*/

	package com.android.systemui.util.condition;		package com.android.systemui.shared.condition;

	import android.util.ArraySet;		import android.util.ArraySet;
	import android.util.Log;		import android.util.Log;

	import com.android.systemui.dagger.qualifiers.Main;		import androidx.annotation.NonNull;

	import org.jetbrains.annotations.NotNull;		import com.android.systemui.dagger.qualifiers.Main;

	import java.util.ArrayList;		import java.util.ArrayList;
	import java.util.Collections;		import java.util.Collections;
	@@ -100,7 +100,7 @@ public class Monitor {
	* @param subscription A {@link Subscription} detailing the desired conditions and callback.		* @param subscription A {@link Subscription} detailing the desired conditions and callback.
	* @return A {@link Subscription.Token} that can be used to remove the subscription.		* @return A {@link Subscription.Token} that can be used to remove the subscription.
	*/		*/
	public Subscription.Token addSubscription(@NotNull Subscription subscription) {		public Subscription.Token addSubscription(@NonNull Subscription subscription) {
	final Subscription.Token token = new Subscription.Token();		final Subscription.Token token = new Subscription.Token();
	final SubscriptionState state = new SubscriptionState(subscription);		final SubscriptionState state = new SubscriptionState(subscription);

	@@ -131,7 +131,7 @@ public class Monitor {
	* @param token The {@link Subscription.Token} returned when the {@link Subscription} was		* @param token The {@link Subscription.Token} returned when the {@link Subscription} was
	* originally added.		* originally added.
	*/		*/
	public void removeSubscription(@NotNull Subscription.Token token) {		public void removeSubscription(@NonNull Subscription.Token token) {
	mExecutor.execute(() -> {		mExecutor.execute(() -> {
	if (shouldLog()) Log.d(mTag, "removing subscription");		if (shouldLog()) Log.d(mTag, "removing subscription");
	if (!mSubscriptions.containsKey(token)) {		if (!mSubscriptions.containsKey(token)) {

packages/SystemUI/tests/src/com/android/systemui/util/condition/ConditionMonitorTest.java→packages/SystemUI/tests/src/com/android/systemui/shared/condition/ConditionMonitorTest.java

+32 −17

Original line number	Original line	Diff line number	Diff line
	/*		/*
	* Copyright (C) 2021 The Android Open Source Project		* Copyright (C) 2022 The Android Open Source Project
	*		*
	* Licensed under the Apache License, Version 2.0 (the "License");		* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.		* you may not use this file except in compliance with the License.
	@@ -14,7 +14,7 @@
	* limitations under the License.		* limitations under the License.
	*/		*/

	package com.android.systemui.util.condition;		package com.android.systemui.shared.condition;

	import static org.mockito.ArgumentMatchers.any;		import static org.mockito.ArgumentMatchers.any;
	import static org.mockito.ArgumentMatchers.eq;		import static org.mockito.ArgumentMatchers.eq;
	@@ -68,13 +68,15 @@ public class ConditionMonitorTest extends SysuiTestCase {
	mConditionMonitor = new Monitor(mExecutor);		mConditionMonitor = new Monitor(mExecutor);
	}		}

	public Monitor.Subscription.Builder getDefaultBuilder(Monitor.Callback callback) {		public Monitor.Subscription.Builder getDefaultBuilder(
			Monitor.Callback callback) {
	return new Monitor.Subscription.Builder(callback)		return new Monitor.Subscription.Builder(callback)
	.addConditions(mConditions);		.addConditions(mConditions);
	}		}

	private Condition createMockCondition() {		private Condition createMockCondition() {
	final Condition condition = Mockito.mock(Condition.class);		final Condition condition = Mockito.mock(
			Condition.class);
	when(condition.isConditionSet()).thenReturn(true);		when(condition.isConditionSet()).thenReturn(true);
	return condition;		return condition;
	}		}
	@@ -83,11 +85,14 @@ public class ConditionMonitorTest extends SysuiTestCase {
	public void testOverridingCondition() {		public void testOverridingCondition() {
	final Condition overridingCondition = createMockCondition();		final Condition overridingCondition = createMockCondition();
	final Condition regularCondition = createMockCondition();		final Condition regularCondition = createMockCondition();
	final Monitor.Callback callback = Mockito.mock(Monitor.Callback.class);		final Monitor.Callback callback = Mockito.mock(
			Monitor.Callback.class);

	final Monitor.Callback referenceCallback = Mockito.mock(Monitor.Callback.class);		final Monitor.Callback referenceCallback = Mockito.mock(
			Monitor.Callback.class);

	final Monitor monitor = new Monitor(mExecutor);		final Monitor
			monitor = new Monitor(mExecutor);

	monitor.addSubscription(getDefaultBuilder(callback)		monitor.addSubscription(getDefaultBuilder(callback)
	.addCondition(overridingCondition)		.addCondition(overridingCondition)
	@@ -136,9 +141,11 @@ public class ConditionMonitorTest extends SysuiTestCase {
	final Condition overridingCondition = createMockCondition();		final Condition overridingCondition = createMockCondition();
	final Condition overridingCondition2 = createMockCondition();		final Condition overridingCondition2 = createMockCondition();
	final Condition regularCondition = createMockCondition();		final Condition regularCondition = createMockCondition();
	final Monitor.Callback callback = Mockito.mock(Monitor.Callback.class);		final Monitor.Callback callback = Mockito.mock(
			Monitor.Callback.class);

	final Monitor monitor = new Monitor(mExecutor);		final Monitor
			monitor = new Monitor(mExecutor);

	monitor.addSubscription(getDefaultBuilder(callback)		monitor.addSubscription(getDefaultBuilder(callback)
	.addCondition(overridingCondition)		.addCondition(overridingCondition)
	@@ -211,9 +218,11 @@ public class ConditionMonitorTest extends SysuiTestCase {
	public void addCallback_addSecondCallback_reportWithExistingValue() {		public void addCallback_addSecondCallback_reportWithExistingValue() {
	final Monitor.Callback callback1 =		final Monitor.Callback callback1 =
	mock(Monitor.Callback.class);		mock(Monitor.Callback.class);
	final Condition condition = mock(Condition.class);		final Condition condition = mock(
			Condition.class);
	when(condition.isConditionMet()).thenReturn(true);		when(condition.isConditionMet()).thenReturn(true);
	final Monitor monitor = new Monitor(mExecutor);		final Monitor
			monitor = new Monitor(mExecutor);
	monitor.addSubscription(new Monitor.Subscription.Builder(callback1)		monitor.addSubscription(new Monitor.Subscription.Builder(callback1)
	.addCondition(condition)		.addCondition(condition)
	.build());		.build());
	@@ -229,8 +238,10 @@ public class ConditionMonitorTest extends SysuiTestCase {

	@Test		@Test
	public void addCallback_noConditions_reportAllConditionsMet() {		public void addCallback_noConditions_reportAllConditionsMet() {
	final Monitor monitor = new Monitor(mExecutor);		final Monitor
	final Monitor.Callback callback = mock(Monitor.Callback.class);		monitor = new Monitor(mExecutor);
			final Monitor.Callback callback = mock(
			Monitor.Callback.class);

	monitor.addSubscription(new Monitor.Subscription.Builder(callback).build());		monitor.addSubscription(new Monitor.Subscription.Builder(callback).build());
	mExecutor.runAllReady();		mExecutor.runAllReady();
	@@ -239,8 +250,10 @@ public class ConditionMonitorTest extends SysuiTestCase {

	@Test		@Test
	public void removeCallback_noFailureOnDoubleRemove() {		public void removeCallback_noFailureOnDoubleRemove() {
	final Condition condition = mock(Condition.class);		final Condition condition = mock(
	final Monitor monitor = new Monitor(mExecutor);		Condition.class);
			final Monitor
			monitor = new Monitor(mExecutor);
	final Monitor.Callback callback =		final Monitor.Callback callback =
	mock(Monitor.Callback.class);		mock(Monitor.Callback.class);
	final Monitor.Subscription.Token token = monitor.addSubscription(		final Monitor.Subscription.Token token = monitor.addSubscription(
	@@ -255,8 +268,10 @@ public class ConditionMonitorTest extends SysuiTestCase {

	@Test		@Test
	public void removeCallback_shouldNoLongerReceiveUpdate() {		public void removeCallback_shouldNoLongerReceiveUpdate() {
	final Condition condition = mock(Condition.class);		final Condition condition = mock(
	final Monitor monitor = new Monitor(mExecutor);		Condition.class);
			final Monitor
			monitor = new Monitor(mExecutor);
	final Monitor.Callback callback =		final Monitor.Callback callback =
	mock(Monitor.Callback.class);		mock(Monitor.Callback.class);
	final Monitor.Subscription.Token token = monitor.addSubscription(		final Monitor.Subscription.Token token = monitor.addSubscription(