File: AutoValueImmutableFields.md

package info (click to toggle)
error-prone-java 2.18.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 23,204 kB
  • sloc: java: 222,992; xml: 1,319; sh: 25; makefile: 7
file content (11 lines) | stat: -rw-r--r-- 588 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
[AutoValue](https://github.com/google/auto/tree/master/value) instances should
be deeply immutable. Therefore, we recommend using immutable types for fields.
E.g., use `ImmutableMap` instead of `Map`, `ImmutableSet` instead of `Set`, etc.

Read more at:

*   https://github.com/google/auto/blob/master/value/userguide/practices.md#avoid-mutable-property-types
*   https://github.com/google/auto/blob/master/value/userguide/builders-howto.md#-use-a-collection-valued-property

Suppress violations by using `@SuppressWarnings("AutoValueImmutableFields")` on
the relevant `abstract` getter.