From 7287489568b64915e887252ad98d88d4e7c1d8ce Mon Sep 17 00:00:00 2001
From: Hongguang <hgchen@google.com>
Date: Thu, 16 Dec 2021 12:57:31 -0800
Subject: [PATCH] Section filter isRepeat clarification.

Bug: 210999986
Fix: 210999986
Test: make
Change-Id: If3cfba3b8e170f9265547284569317f1426c0483
---
 .../tv/tuner/filter/SectionSettings.java      | 27 +++++++++++++++++--
 1 file changed, 25 insertions(+), 2 deletions(-)

diff --git a/media/java/android/media/tv/tuner/filter/SectionSettings.java b/media/java/android/media/tv/tuner/filter/SectionSettings.java
index 58e22c9076397..e7fc129122aec 100644
--- a/media/java/android/media/tv/tuner/filter/SectionSettings.java
+++ b/media/java/android/media/tv/tuner/filter/SectionSettings.java
@@ -45,8 +45,19 @@ public abstract class SectionSettings extends Settings {
     public boolean isCrcEnabled() {
         return mCrcEnabled;
     }
+
     /**
-     * Returns whether the filter repeats the data with the same version.
+     * Returns whether the filter repeats the data.
+     *
+     * If {@code false}, for {@link SectionSettingsWithTableInfo}, HAL filters out all sections
+     * based on {@link SectionSettingsWithTableInfo} TableId and Version, and stops filtering data.
+     * For {@linkSectionSettingsWithSectionBits}, HAL filters out the first section which matches
+     * the {@linkSectionSettingsWithSectionBits} configuration, and stops filtering data.
+     *
+     * If {@code true}, for {@link SectionSettingsWithTableInfo}, HAL filters out all sections based
+     * on {@link SectionSettingsWithTableInfo} TableId and Version, and repeats. For
+     * {@linkSectionSettingsWithSectionBits}, HAL filters out sections which match the
+     * {@linkSectionSettingsWithSectionBits} configuration, and repeats.
      */
     public boolean isRepeat() {
         return mIsRepeat;
@@ -83,8 +94,20 @@ public abstract class SectionSettings extends Settings {
             mCrcEnabled = crcEnabled;
             return self();
         }
+
         /**
-         * Sets whether the filter repeats the data with the same version.
+         * Sets whether the filter repeats the data.
+         *
+         * If {@code false}, for {@link SectionSettingsWithTableInfo}, HAL filters out all sections
+         * based on {@link SectionSettingsWithTableInfo} TableId and Version, and stops filtering
+         * data. For {@linkSectionSettingsWithSectionBits}, HAL filters out the first section which
+         * matches the {@linkSectionSettingsWithSectionBits} configuration, and stops filtering
+         * data.
+         *
+         * If {@code true}, for {@link SectionSettingsWithTableInfo}, HAL filters out all sections
+         * based on {@link SectionSettingsWithTableInfo} TableId and Version, and repeats. For
+         * {@linkSectionSettingsWithSectionBits}, HAL filters out sections which match the
+         * {@linkSectionSettingsWithSectionBits} configuration, and repeats.
          */
         @NonNull
         public T setRepeat(boolean isRepeat) {