Style Guide Proposal: IntDef NUM_ENTRIES constant

[Trevor Perrier]

I ran into the WrongConstant and found Issue 1300585 but noticed that the style guide suggestion will still cause the lint error.

I have seen two proposals for fixing this:

1. Add the NUM_ENTRIES value to the @IntDef
   • Requires adding NUM_ENTRIES to switch statements which isn't desirable.
2. Add a public static final int <PREFIX>_NUM_ENTRIES below the interface.
   • Not quite as contained as including it in the interface but avoids the switch issue.

I've created https://crrev.com/c/4824407 to update the style guide with proposal two above. PLMK if this makes should be changed or can be submitted.

Thanks,

- Trevor

[Peter Wen]

For what it's worth, option 2 is what Google3 goes with when I last investigated this issue.

Peter

--
You received this message because you are subscribed to the Google Groups "java" group.
To unsubscribe from this group and stop receiving emails from it, send an email to java+uns...@chromium.org.
To view this discussion on the web visit https://groups.google.com/a/chromium.org/d/msgid/java/1a5cd720-4e4b-4c2c-b451-de3bde857ae7n%40chromium.org.

[Andrew Grieve]

Yeah, it doesn't read as nicely, but I think it's the only style that avoids having to suppress lint warnings, so +1 to 2).

To view this discussion on the web visit https://groups.google.com/a/chromium.org/d/msgid/java/CAKNWQC5652yLVygv4BQ1-7hA%2B7KhNvJHU9yx0FyNe_%3DMTP97XQ%40mail.gmail.com.

[Nate Fischer]

I'm a little confused by crbug/1300585. My understanding is that this is a bug in Android Lint: the @IntDef isn't really defined by which constants are defined inside the interface, it's defined by which constants are passed into the annotation. If I don't pass NUM_ENTRIES into the annotation, why does Android Lint expect our code to handle it as if it's a valid value of that particular IntDef?

This seems to me like it's just a regression in Android Lint. If that's the case, then I think we should file a bug against the Android Lint project rather than changing our style guide to workaround this.

Nate Fischer | Software Engineer | ntf...@google.com

To view this discussion on the web visit https://groups.google.com/a/chromium.org/d/msgid/java/CABiQX1Vpsr1yUuFL4e9c8iFRYt17_kYOZEFA87cN8uNh7pf0qg%40mail.gmail.com.

[Peter Wen]

Andrew filed http://b/298283135 (internal bug against Android Lint) so we'll see how that goes.

[Andrew Grieve]

Happy to report that the bug is fixed, lint has rolled, and our baselines have been update to remove the false-positives.

Great outcome!

[Nate Fischer]

This is awesome news! Thanks for collaborating with the Lint team to get this fixed!

Nate Fischer | Software Engineer | ntf...@google.com