Skip to content

Commit 92e92a9

Browse files
authored
GH-10083 Add nullability docs and whats-new info
Fixes: #10083 * Update docs to be more concise * Remove reference to blog * Remove the words "Spring Integration" from the body and title * Remove the version from the link to SF's reference doc and verified that it works * Make sure only one sentence per line in asciidocs
1 parent be8165c commit 92e92a9

File tree

3 files changed

+14
-1
lines changed

3 files changed

+14
-1
lines changed

src/reference/antora/modules/ROOT/pages/index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,3 +75,4 @@ xref:testing.adoc[Testing support] :: Test utilities, Integration mocks and test
7575
xref:samples.adoc#samples-impl[Spring Integration Samples] :: The samples dedicated project
7676
xref:resources.adoc[Additional Resources] :: Other resources related to project
7777
xref:history.adoc[Change History] :: The changes made in the project over time
78+
xref:null-safety.adoc[Null Safety] :: Null safety build-time enforcement
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[[null-safety]]
2+
= Null Safety
3+
4+
The codebase is annotated with JSpecify annotations to declare the nullability of its APIs, fields, and related type usages, following Spring Framework's efforts to add null safety to the platform.
5+
Reading Spring Framework's https://docs.spring.io/spring-framework/reference/core/null-safety.html#null-safety-guidelines-nullaway[Null-safety reference documentation] is highly recommended to get familiar with these annotations and their semantics.
6+
7+
The primary goal of this null-safety arrangement is to prevent `NullPointerException` from being thrown at runtime through build-time checks and to use explicit nullability as a way to express the possible absence of a value.

src/reference/antora/modules/ROOT/pages/whats-new.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,9 @@ See xref:mqtt.adoc[] for more information.
6262

6363
The `AbstractInboundFileSynchronizer` now caches a filtered result of the `Session.list(remoteDirectory)` after slicing by the `maxFetchSize`.
6464
So, later synchronizations deal with the cache only by the `maxFetchSize` until the cache is exhausted.
65-
See xref:sftp/max-fetch.adoc[] for more information.
65+
See xref:sftp/max-fetch.adoc[] for more information.
66+
67+
[[x7.0-null-safety]]
68+
=== Null Safety
69+
Updated the codebase to use JSpecify and NullAway, adding a comprehensive null safety implementation that uses `@NullMarked` annotations to default all types to non-null at the package level and `@Nullable` annotations to explicitly mark types that can be null.
70+
See xref:null-safety.adoc[] for more information.

0 commit comments

Comments
 (0)