Use getters for max values in KeyedAppState [140519786]

Fixed

Bug

Status Update

No update yet.

Description

au...@google.com

created issue #1

Sep 4, 2019 09:54PM

KeyedAppState has the following constants.
/** The maximum length of the key. */
public static final int MAX_KEY_LENGTH = 100;
/** The maximum length of the message field. */
public static final int MAX_MESSAGE_LENGTH = 1000;
/** The maximum length of the data field. */
public static final int MAX_DATA_LENGTH = 1000;

API guidance

http://go/android-api-guidelines#min-max-constants suggests to not use constants when specifying max values if those could change in the future. It seems to be the case here. Should we move to getters for these values?

This was found when enabling this api lint rule in AndroidX

https://android-review.googlesource.com/c/platform/frameworks/support/+/1114511

Comments

al...@google.com <al...@google.com> #2Sep 5, 2019 09:46AM

Assigned to sc...@google.com.

Thanks Aurimas. Out of interest, is this a new API lint rule? Is there something we should run in the future to avoid problems like this?

au...@google.com <au...@google.com> #3Sep 9, 2019 11:26PM

New rule. We are slowly enabling more of these. That's how we caught it.

ap...@google.com <ap...@google.com> #4Jul 13, 2020 03:53PM

Marked as fixed.

Project: platform/frameworks/support
Branch: androidx-master-dev

commit d556b3cbdca2ddc8c64fe89a95b267964e03e02f
Author: Jonathan Scott <scottjonathan@google.com>
Date: Thu Jul 02 17:00:10 2020

Add getters for min/max constants in KeyedAppState.

Test: ./gradlew test
Fixes: 140519786
Relnote: Replaced constants for max field sizes with getters.
Change-Id: I2e351b47a2ed16adfc0545fb9b1d7a3343b8bb92

M enterprise/feedback/api/1.1.0-alpha01.txt
M enterprise/feedback/api/current.txt
M enterprise/feedback/api/public_plus_experimental_1.1.0-alpha01.txt
M enterprise/feedback/api/public_plus_experimental_current.txt
M enterprise/feedback/api/restricted_1.1.0-alpha01.txt
M enterprise/feedback/api/restricted_current.txt
M enterprise/feedback/src/main/java/androidx/enterprise/feedback/KeyedAppState.java

https://android-review.googlesource.com/1354563

Issue 140519786

Description

Issue summary

Comments

al...@google.com <al...@google.com> #2Sep 5, 2019 09:46AM

au...@google.com <au...@google.com> #3Sep 9, 2019 11:26PM

ap...@google.com <ap...@google.com> #4Jul 13, 2020 03:53PM

Add comment

Issue metadata