Merge "Section filter isRepeat clarification."

This commit is contained in:
TreeHugger Robot
2021-12-17 01:12:34 +00:00
committed by Android (Google) Code Review

View File

@@ -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) {