From 57be1c7f8168219d193bf7af191bae8d947a8701 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Iv=C3=A1n=20Budnik?= <ivanbuper@google.com>
Date: Fri, 8 Jul 2022 15:36:09 +0000
Subject: [PATCH] Add javadoc to route fields in MediaRouter2.

Bug: 205124386
Test: N/A
Change-Id: Ia9855999d4c3eedd606694eac7a94977a8556ca1
---
 media/java/android/media/MediaRouter2.java | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/media/java/android/media/MediaRouter2.java b/media/java/android/media/MediaRouter2.java
index d8995b419f505..57f105671ed40 100644
--- a/media/java/android/media/MediaRouter2.java
+++ b/media/java/android/media/MediaRouter2.java
@@ -102,6 +102,12 @@ public final class MediaRouter2 {
 
     private final String mPackageName;
 
+    /**
+     * Stores the latest copy of all routes received from {@link MediaRouter2ServiceImpl}, without
+     * any filtering, sorting, or deduplication.
+     *
+     * <p>Uses {@link MediaRoute2Info#getId()} to set each entry's key.
+     */
     @GuardedBy("mLock")
     final Map<String, MediaRoute2Info> mRoutes = new ArrayMap<>();
 
@@ -121,7 +127,22 @@ public final class MediaRouter2 {
 
     final Handler mHandler;
 
+    /**
+     * Stores an auxiliary copy of {@link #mFilteredRoutes} at the time of the last route callback
+     * dispatch. This is only used to determine what callback a route should be assigned to (added,
+     * removed, changed) in {@link #dispatchFilteredRoutesChangedLocked(List)}.
+     */
     private volatile ArrayMap<String, MediaRoute2Info> mPreviousRoutes = new ArrayMap<>();
+
+    /**
+     * Stores the latest copy of exposed routes after filtering, sorting, and deduplication. Can be
+     * accessed through {@link #getRoutes()}.
+     *
+     * <p>This list is a copy of {@link #mRoutes} which has undergone filtering, sorting, and
+     * deduplication using criteria in {@link #mDiscoveryPreference}.
+     *
+     * @see #filterRoutesWithCompositePreferenceLocked(List)
+     */
     private volatile List<MediaRoute2Info> mFilteredRoutes = Collections.emptyList();
     private volatile OnGetControllerHintsListener mOnGetControllerHintsListener;