PlayerUIList: rename get to getOpt and make get nullable

In Kotlin, dealing with nulls works better so we don’t need optional.

app/src/main/java/org/schabi/newpipe/fragments/detail/VideoDetailFragment.java

@@ -246,7 +246,7 @@ public final class VideoDetailFragment
         // It will do nothing if the player is not in fullscreen mode
         hideSystemUiIfNeeded();
 
-        final Optional<MainPlayerUi> playerUi = player.UIs().get(MainPlayerUi.class);
+        final Optional<MainPlayerUi> playerUi = player.UIs().getOpt(MainPlayerUi.class);
         if (!player.videoPlayerSelected() && !playAfterConnect) {
             return;
         }
@@ -529,7 +529,7 @@ public final class VideoDetailFragment
         binding.overlayPlayPauseButton.setOnClickListener(v -> {
             if (playerIsNotStopped()) {
                 player.playPause();
-                player.UIs().get(VideoPlayerUi.class).ifPresent(ui -> ui.hideControls(0, 0));
+                player.UIs().getOpt(VideoPlayerUi.class).ifPresent(ui -> ui.hideControls(0, 0));
                 showSystemUi();
             } else {
                 autoPlayEnabled = true; // forcefully start playing
@@ -688,7 +688,7 @@ public final class VideoDetailFragment
     @Override
     public boolean onKeyDown(final int keyCode) {
         return isPlayerAvailable()
-                && player.UIs().get(VideoPlayerUi.class)
+                && player.UIs().getOpt(VideoPlayerUi.class)
                 .map(playerUi -> playerUi.onKeyDown(keyCode)).orElse(false);
     }
 
@@ -1028,7 +1028,7 @@ public final class VideoDetailFragment
         // If a user watched video inside fullscreen mode and than chose another player
         // return to non-fullscreen mode
         if (isPlayerAvailable()) {
-            player.UIs().get(MainPlayerUi.class).ifPresent(playerUi -> {
+            player.UIs().getOpt(MainPlayerUi.class).ifPresent(playerUi -> {
                 if (playerUi.isFullscreen()) {
                     playerUi.toggleFullscreen();
                 }
@@ -1244,7 +1244,7 @@ public final class VideoDetailFragment
             // setup the surface view height, so that it fits the video correctly
             setHeightThumbnail();
 
-            player.UIs().get(MainPlayerUi.class).ifPresent(playerUi -> {
+            player.UIs().getOpt(MainPlayerUi.class).ifPresent(playerUi -> {
                 // sometimes binding would be null here, even though getView() != null above u.u
                 if (binding != null) {
                     // prevent from re-adding a view multiple times
@@ -1260,7 +1260,7 @@ public final class VideoDetailFragment
         makeDefaultHeightForVideoPlaceholder();
 
         if (player != null) {
-            player.UIs().get(VideoPlayerUi.class).ifPresent(VideoPlayerUi::removeViewFromParent);
+            player.UIs().getOpt(VideoPlayerUi.class).ifPresent(VideoPlayerUi::removeViewFromParent);
         }
     }
 
@@ -1327,7 +1327,7 @@ public final class VideoDetailFragment
         binding.detailThumbnailImageView.setMinimumHeight(newHeight);
         if (isPlayerAvailable()) {
             final int maxHeight = (int) (metrics.heightPixels * MAX_PLAYER_HEIGHT);
-            player.UIs().get(VideoPlayerUi.class).ifPresent(ui ->
+            player.UIs().getOpt(VideoPlayerUi.class).ifPresent(ui ->
                     ui.getBinding().surfaceView.setHeights(newHeight,
                             ui.isFullscreen() ? newHeight : maxHeight));
         }
@@ -1861,7 +1861,7 @@ public final class VideoDetailFragment
     public void onFullscreenStateChanged(final boolean fullscreen) {
         setupBrightness();
         if (!isPlayerAndPlayerServiceAvailable()
-                || player.UIs().get(MainPlayerUi.class).isEmpty()
+                || player.UIs().getOpt(MainPlayerUi.class).isEmpty()
                 || getRoot().map(View::getParent).isEmpty()) {
             return;
         }
@@ -1890,7 +1890,7 @@ public final class VideoDetailFragment
         final boolean isLandscape = DeviceUtils.isLandscape(requireContext());
         if (DeviceUtils.isTablet(activity)
                 && (!globalScreenOrientationLocked(activity) || isLandscape)) {
-            player.UIs().get(MainPlayerUi.class).ifPresent(MainPlayerUi::toggleFullscreen);
+            player.UIs().getOpt(MainPlayerUi.class).ifPresent(MainPlayerUi::toggleFullscreen);
             return;
         }
 
@@ -1990,7 +1990,7 @@ public final class VideoDetailFragment
     }
 
     private boolean isFullscreen() {
-        return isPlayerAvailable() && player.UIs().get(VideoPlayerUi.class)
+        return isPlayerAvailable() && player.UIs().getOpt(VideoPlayerUi.class)
                 .map(VideoPlayerUi::isFullscreen).orElse(false);
     }
 
@@ -2067,7 +2067,7 @@ public final class VideoDetailFragment
             setAutoPlay(true);
         }
 
-        player.UIs().get(MainPlayerUi.class).ifPresent(MainPlayerUi::checkLandscape);
+        player.UIs().getOpt(MainPlayerUi.class).ifPresent(MainPlayerUi::checkLandscape);
         // Let's give a user time to look at video information page if video is not playing
         if (globalScreenOrientationLocked(activity) && !player.isPlaying()) {
             player.play();
@@ -2332,7 +2332,7 @@ public final class VideoDetailFragment
                                 && player.isPlaying()
                                 && !isFullscreen()
                                 && !DeviceUtils.isTablet(activity)) {
-                            player.UIs().get(MainPlayerUi.class)
+                            player.UIs().getOpt(MainPlayerUi.class)
                                     .ifPresent(MainPlayerUi::toggleFullscreen);
                         }
                         setOverlayLook(binding.appBarLayout, behavior, 1);
@@ -2346,7 +2346,7 @@ public final class VideoDetailFragment
                         // Re-enable clicks
                         setOverlayElementsClickable(true);
                         if (isPlayerAvailable()) {
-                            player.UIs().get(MainPlayerUi.class)
+                            player.UIs().getOpt(MainPlayerUi.class)
                                     .ifPresent(MainPlayerUi::closeItemsList);
                         }
                         setOverlayLook(binding.appBarLayout, behavior, 0);
@@ -2357,7 +2357,7 @@ public final class VideoDetailFragment
                             showSystemUi();
                         }
                         if (isPlayerAvailable()) {
-                            player.UIs().get(MainPlayerUi.class).ifPresent(ui -> {
+                            player.UIs().getOpt(MainPlayerUi.class).ifPresent(ui -> {
                                 if (ui.isControlsVisible()) {
                                     ui.hideControls(0, 0);
                                 }
@@ -2454,7 +2454,7 @@ public final class VideoDetailFragment
 
     public Optional<View> getRoot() {
         return Optional.ofNullable(player)
-                .flatMap(player1 -> player1.UIs().get(VideoPlayerUi.class))
+                .flatMap(player1 -> player1.UIs().getOpt(VideoPlayerUi.class))
                 .map(playerUi -> playerUi.getBinding().getRoot());
     }
 

app/src/main/java/org/schabi/newpipe/player/Player.java

@@ -473,14 +473,15 @@ public final class Player implements PlaybackListener, Listener {
     }
 
     private void initUIsForCurrentPlayerType() {
-        if ((UIs.get(MainPlayerUi.class).isPresent() && playerType == PlayerType.MAIN)
+        if ((UIs.getOpt(MainPlayerUi.class).isPresent() && playerType == PlayerType.MAIN)
-                || (UIs.get(PopupPlayerUi.class).isPresent() && playerType == PlayerType.POPUP)) {
+                || (UIs.getOpt(PopupPlayerUi.class).isPresent()
+                    && playerType == PlayerType.POPUP)) {
             // correct UI already in place
             return;
         }
 
         // try to reuse binding if possible
-        final PlayerBinding binding = UIs.get(VideoPlayerUi.class).map(VideoPlayerUi::getBinding)
+        final PlayerBinding binding = UIs.getOpt(VideoPlayerUi.class).map(VideoPlayerUi::getBinding)
                 .orElseGet(() -> {
                     if (playerType == PlayerType.AUDIO) {
                         return null;

app/src/main/java/org/schabi/newpipe/player/PlayerService.java

@@ -148,7 +148,7 @@ public final class PlayerService extends MediaBrowserServiceCompat {
             // no one already and starting the service in foreground should not create any issues.
             // If the service is already started in foreground, requesting it to be started
             // shouldn't do anything.
-            player.UIs().get(NotificationPlayerUi.class)
+            player.UIs().getOpt(NotificationPlayerUi.class)
                     .ifPresent(NotificationPlayerUi::createNotificationAndStartForeground);
 
             if (playerWasNull && onPlayerStartedOrStopped != null) {
@@ -173,7 +173,7 @@ public final class PlayerService extends MediaBrowserServiceCompat {
 
         if (player != null) {
             player.handleIntent(intent);
-            player.UIs().get(MediaSessionPlayerUi.class)
+            player.UIs().getOpt(MediaSessionPlayerUi.class)
                     .ifPresent(ui -> ui.handleMediaButtonIntent(intent));
         }
 

app/src/main/java/org/schabi/newpipe/player/mediasession/MediaSessionPlayerUi.java

@@ -138,7 +138,7 @@ public class MediaSessionPlayerUi extends PlayerUi
             public void play() {
                 player.play();
                 // hide the player controls even if the play command came from the media session
-                player.UIs().get(VideoPlayerUi.class).ifPresent(ui -> ui.hideControls(0, 0));
+                player.UIs().getOpt(VideoPlayerUi.class).ifPresent(ui -> ui.hideControls(0, 0));
             }
 
             @Override

app/src/main/java/org/schabi/newpipe/player/notification/NotificationUtil.java

@@ -102,7 +102,7 @@ public final class NotificationUtil {
             mediaStyle.setShowActionsInCompactView(compactSlots);
         }
         player.UIs()
-                .get(MediaSessionPlayerUi.class)
+                .getOpt(MediaSessionPlayerUi.class)
                 .flatMap(MediaSessionPlayerUi::getSessionToken)
                 .ifPresent(mediaStyle::setMediaSession);
 

app/src/main/java/org/schabi/newpipe/player/ui/PlayerUiList.kt

@@ -65,21 +65,32 @@ class PlayerUiList(vararg initialPlayerUis: PlayerUi) {
      * @param playerUiType the class of the player UI to return;
      * the [Class.isInstance] method will be used, so even subclasses could be returned
      * @param T the class type parameter
-     * @return the first player UI of the required type found in the list, or an empty
+     * @return the first player UI of the required type found in the list, or null
-     * [         ] otherwise
      </T> */
-    fun <T> get(playerUiType: Class<T>): Optional<T & Any> {
+    fun <T> get(playerUiType: Class<T>): T? {
         for (ui in playerUis) {
             if (playerUiType.isInstance(ui)) {
                 when (val r = playerUiType.cast(ui)) {
+                    // try all UIs before returning null
                     null -> continue
-                    else -> return Optional.of(r)
+                    else -> return r
                 }
             }
         }
-        return Optional.empty()
+        return null
     }
 
+    /**
+     * @param playerUiType the class of the player UI to return;
+     * the [Class.isInstance] method will be used, so even subclasses could be returned
+     * @param T the class type parameter
+     * @return the first player UI of the required type found in the list, or an empty
+     * [Optional] otherwise
+     </T> */
+    @Deprecated("use get", ReplaceWith("get(playerUiType)"))
+    fun <T> getOpt(playerUiType: Class<T>): Optional<T & Any> =
+        Optional.ofNullable(get(playerUiType))
+
     /**
      * Calls the provided consumer on all player UIs in the list, in order of addition.
      * @param consumer the consumer to call with player UIs