[SLING-7723] XSS API is using other JSR-305 annotations than the rest of Sling

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: XSS Protection API 2.0.6
• Fix Version/s: XSS Protection API 2.0.14
• Component/s: XSS Protection API
• Assignee: Stefan Seifert
• Reporter: Konrad Windszus
• Created: 11/Jun/18 15:44
• Updated: 19/Apr/19 10:13
• Resolved: 19/Apr/19 10:13

Description

According to https://sling.apache.org/documentation/development/jsr-305.html only two different annotations are supposed to be used:

javax.annotation.CheckForNull
javax.annotation.Nonnull

The XSSAPI uses though

javax.annotation.Nullable
javax.annotation.Nonnull

Since it is trickier to setup the IDE to support both Nullable and CheckForNull and also FindBugs is only supporting the latter, I would recommend to switch to CheckForNull for return values which might be null. Every method argument which is not explicitly marked as Nonnull is always considered Nullable by every tool!

Issue Links

• is superceded by: SLING-7798 Switch from JSR-305 annotations to JetBrains Nullable/NotNull annotations