[Maintenance] Handling Spotbugs internal representation (EI_EXPOSE_REP)

[simonhir]

Relevant template

No response

Problem description (optional)

The Spotbugs EI_EXPOSE_REP warning is often discovered while development. In most cases there isn't the need for immutability.

Desired solution

A decision how to handle these warnings should be found and implemented.
Following are possible approaches:

• Do nothing -> The user needs to suppress each one manually
• Suppress all Spotbugs warnings for Lombok lombok.extern.findbugs.addSuppressFBWarnings = true (See https://projectlombok.org/features/configuration)
• Suppress the EI_EXPOSE_REP Spotbugs warnings for the complete project

Considered alternatives (optional)

No response

Additional context (optional)

No response

No duplicate

• I confirm that this issue is not a duplicate

Code of Conduct

• I agree to follow this project's Code of Conduct

[simonhir]

Following the summary of a internal discussion between @devtobi @DanielOber @darenegade and me

Do nothing

Disadvantage: High overhead for developers
-> No real solution

Suppress all Spotbugs warnings for Lombok

Disadvantage: Other exceptions which could occur on Lombok code are still detected (Currently none known but settings this would also stop us from ever noticing any)
Advantage: EI_EXPOSE_REP warnings are still detected for custom code (i.e. NfcRequest)

Suppress EI_EXPOSE_REP globally

Disadvantage: Warning is also no longer detected for custom code
Advantage: Other warnings that could occur on Lombok code are still detected

Decision made: Suppress EI_EXPOSE_REP globally