Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add information about configuring nullability analysis with IDE tools.
  • Loading branch information
kqarryzada committed Apr 25, 2024
1 parent 227b897 commit 2f6ec9b
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,19 @@ ListResponse<UserResource> searchResponse =

For detailed information about using the SCIM 2 SDK, including more examples, please see the [wiki](https://github.com/pingidentity/scim2/wiki).

# Nullability Annotations
As of version 3.1.0 (not released yet), the SCIM 2 SDK provides the `com.unboundid.scim2.common.annotations.Nullable`
and `com.unboundid.scim2.common.annotations.NotNull` annotations for all input parameters, member
variables, and method return values. This is designed to provide insight when invoking SCIM SDK
library methods, help interface with languages like Kotlin (which has built-in null types for
variables), and to help applications become less prone to nullability problems. These annotations
can be leveraged by IDE tools to help validate objects that are given to and received from the SCIM
SDK library. To configure/integrate this into your environment, view the documentation of your IDE
of choice. Some popular choices are linked below:
* [IntelliJ IDEA](https://www.jetbrains.com/help/idea/annotating-source-code.html#configure-nullability-annotations)
* [Eclipse](https://help.eclipse.org/latest/index.jsp?topic=%2Forg.eclipse.jdt.doc.user%2Ftasks%2Ftask-using_null_annotations.htm)


# Reporting issues

Please report bug reports and enhancement requests through this project's [issue tracker](https://github.com/pingidentity/scim2/issues). See the [contribution guidelines](CONTRIBUTING.md) for more information.
Expand Down

0 comments on commit 2f6ec9b

Please sign in to comment.