JSpecify #40

lbkulinski · 2026-01-02T17:04:02Z

No description provided.

Copilot

Pull request overview

This PR adds JSpecify nullability annotations to the public API of the CTA4J Java SDK to improve type safety and establish clearer nullability contracts. The version is bumped from 3.0.4 to 3.0.5 with the addition of the org.jspecify:jspecify:1.0.0 dependency.

Added @NonNull annotations to return types of public API methods in TrainClient, BusClient, and their implementations
Reorganized field declarations in implementation classes to group constants together
Updated version and changelog to reflect the changes

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 22 comments.

Show a summary per file

File	Description
pom.xml	Bumped version to 3.0.5 and added JSpecify dependency with provided scope
CHANGELOG.md	Added release notes for version 3.0.5 documenting the addition of JSpecify annotations
src/main/java/com/cta4j/train/client/TrainClient.java	Added `@NonNull` annotations to method return types and builder methods
src/main/java/com/cta4j/train/client/internal/TrainClientImpl.java	Added `@NonNull` annotations to match interface, reorganized fields to group constants
src/main/java/com/cta4j/bus/client/BusClient.java	Added `@NonNull` annotations to method return types and builder methods
src/main/java/com/cta4j/bus/client/internal/BusClientImpl.java	Added `@NonNull` annotations to match interface, reorganized fields to group constants

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-02T17:09:24Z

src/main/java/com/cta4j/bus/client/BusClient.java

         * @throws NullPointerException if {@code host} is {@code null}
         */
-        Builder host(String host);
+        @NonNull Builder host(String host);


The method parameter host should be annotated with @NonNull to establish a complete nullability contract. The method documentation states it throws NullPointerException if the parameter is null, and the implementation validates this with Objects.requireNonNull. JSpecify annotations should be applied to both return types and parameters for consistency and completeness.

Suggested change

@NonNull Builder host(String host);

@NonNull Builder host(@NonNull String host);

Copilot · 2026-01-02T17:09:24Z

src/main/java/com/cta4j/train/client/internal/TrainClientImpl.java


        @Override
-        public Builder apiKey(String apiKey) {
+        public @NonNull Builder apiKey(String apiKey) {


The method parameter apiKey should be annotated with @NonNull to match the interface contract and establish a complete nullability specification. This should be consistent with the interface definition in TrainClient.Builder.

Suggested change

public @NonNull Builder apiKey(String apiKey) {

public @NonNull Builder apiKey(@NonNull String apiKey) {

Copilot · 2026-01-02T17:09:25Z

src/main/java/com/cta4j/bus/client/internal/BusClientImpl.java


    @Override
-    public List<StopArrival> getStopArrivals(String routeId, String stopId) {
+    public @NonNull List<StopArrival> getStopArrivals(String routeId, String stopId) {


The method parameters routeId and stopId should be annotated with @NonNull to match the interface contract and establish a complete nullability specification. This should be consistent with the interface definition in BusClient.

Suggested change

public @NonNull List<StopArrival> getStopArrivals(String routeId, String stopId) {

public @NonNull List<StopArrival> getStopArrivals(@NonNull String routeId, @NonNull String stopId) {

Copilot · 2026-01-02T17:09:25Z

src/main/java/com/cta4j/bus/client/internal/BusClientImpl.java


        @Override
-        public Builder host(String host) {
+        public @NonNull Builder host(String host) {


The method parameter host should be annotated with @NonNull to match the interface contract and establish a complete nullability specification. This should be consistent with the interface definition in BusClient.Builder.

Suggested change

public @NonNull Builder host(String host) {

public @NonNull Builder host(@NonNull String host) {

Copilot · 2026-01-02T17:09:25Z

src/main/java/com/cta4j/bus/client/BusClient.java

     * @throws Cta4jException if an error occurs while fetching the data
     */
-    List<String> getDirections(String routeId);
+    @NonNull List<String> getDirections(String routeId);


The method parameter routeId should be annotated with @NonNull to establish a complete nullability contract. The method documentation states it throws NullPointerException if the parameter is null, and the implementation validates this with Objects.requireNonNull. JSpecify annotations should be applied to both return types and parameters for consistency and completeness.

Copilot · 2026-01-02T17:09:28Z

src/main/java/com/cta4j/bus/client/BusClient.java

     * @throws Cta4jException if an error occurs while fetching the data
     */
-    List<Stop> getStops(String routeId, String direction);
+    @NonNull List<Stop> getStops(String routeId, String direction);


The method parameters routeId and direction should be annotated with @NonNull to establish a complete nullability contract. The method documentation states it throws NullPointerException if these parameters are null, and the implementation validates this with Objects.requireNonNull. JSpecify annotations should be applied to both return types and parameters for consistency and completeness.

Copilot · 2026-01-02T17:09:29Z

src/main/java/com/cta4j/train/client/internal/TrainClientImpl.java


        @Override
-        public Builder host(String host) {
+        public @NonNull Builder host(String host) {


The method parameter host should be annotated with @NonNull to match the interface contract and establish a complete nullability specification. This should be consistent with the interface definition in TrainClient.Builder.

Suggested change

public @NonNull Builder host(String host) {

public @NonNull Builder host(@NonNull String host) {

Copilot · 2026-01-02T17:09:29Z

src/main/java/com/cta4j/bus/client/internal/BusClientImpl.java


    @Override
-    public List<Stop> getStops(String routeId, String direction) {
+    public @NonNull List<Stop> getStops(String routeId, String direction) {


The method parameters routeId and direction should be annotated with @NonNull to match the interface contract and establish a complete nullability specification. This should be consistent with the interface definition in BusClient.

Copilot · 2026-01-02T17:09:29Z

src/main/java/com/cta4j/bus/client/internal/BusClientImpl.java


    @Override
-    public Optional<Bus> getBus(String id) {
+    public @NonNull Optional<Bus> getBus(String id) {


The method parameter id should be annotated with @NonNull to match the interface contract and establish a complete nullability specification. This should be consistent with the interface definition in BusClient.

Suggested change

public @NonNull Optional<Bus> getBus(String id) {

public @NonNull Optional<Bus> getBus(@NonNull String id) {

Copilot · 2026-01-02T17:09:29Z

src/main/java/com/cta4j/bus/client/BusClient.java

     * @throws Cta4jException if an error occurs while fetching the data
     */
-    Optional<Bus> getBus(String id);
+    @NonNull Optional<Bus> getBus(String id);


The method parameter id should be annotated with @NonNull to establish a complete nullability contract. The method documentation states it throws NullPointerException if the parameter is null, and the implementation validates this with Objects.requireNonNull. JSpecify annotations should be applied to both return types and parameters for consistency and completeness.

lbkulinski added 3 commits January 2, 2026 11:00

JSpecify

293beae

JSpecify

eb5e3dc

JSpecify

fdbba52

Copilot AI review requested due to automatic review settings January 2, 2026 17:04

Copilot started reviewing on behalf of lbkulinski January 2, 2026 17:04 View session

Copilot AI reviewed Jan 2, 2026

View reviewed changes

lbkulinski added 24 commits January 2, 2026 11:19

JSpecify

73c57a7

JSpecify + Model updates

90314fc

JSpecify + Model updates

a5c1da0

JSpecify + Model updates

521574f

JSpecify + Model updates

b797ec7

JSpecify + Model updates

efe4365

JSpecify + Model updates

369c1c0

JSpecify + Model updates

bb4c27b

JSpecify + Model updates

47b0466

JSpecify + Model updates

8d5dd4c

JSpecify + Model updates

14ecfcd

JSpecify + Model updates

e77f2ed

JSpecify + Model updates

5b75b99

JSpecify + Model updates

08dc1c5

JSpecify + Model updates

c0192ec

JSpecify + Model updates

b59ca4f

JSpecify + Model updates

6d519d0

JSpecify + Model updates

2a02d9d

JSpecify + Model updates

2cad808

JSpecify + Model updates

5f7c604

JSpecify + Model updates

01dfa64

JSpecify + Model updates

70a4af3

JSpecify + Model updates

88c2db1

JSpecify + Model updates

4fc335d

lbkulinski added 26 commits January 11, 2026 15:13

JSpecify + Model updates

6fdb075

JSpecify + Model updates

afdd10b

Added pattern endpoints

2300f80

Added pattern endpoints

66739a3

API refactor

08149ed

API refactor

b9c4ad6

API refactor

a91ff6f

API refactor

799520c

API refactor

cf3e956

API refactor

828fb46

Patterns API

c21bc72

Patterns API

73c1d1d

API refactor

ab595ba

API refactor

9baa1bc

API refactor

603b793

API refactor

3852a9b

API refactor

d2e553c

API refactor

ad2b747

API refactor

b7198c6

API refactor

54e3995

API refactor

0bf1905

API refactor

d697a8c

API refactor

ec8c831

API refactor

f71c35c

API refactor

c54bfc8

JavaDoc comments

83b3cdc

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

JSpecify #40

JSpecify #40

Uh oh!

lbkulinski commented Jan 2, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 2, 2026

Uh oh!

Copilot AI Jan 2, 2026

Uh oh!

Copilot AI Jan 2, 2026

Uh oh!

Copilot AI Jan 2, 2026

Uh oh!

Copilot AI Jan 2, 2026

Uh oh!

Copilot AI Jan 2, 2026

Uh oh!

Copilot AI Jan 2, 2026

Uh oh!

Copilot AI Jan 2, 2026

Uh oh!

Copilot AI Jan 2, 2026

Uh oh!

Copilot AI Jan 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	@NonNull Builder host(String host);
	@NonNull Builder host(@NonNull String host);

	public @NonNull Builder apiKey(String apiKey) {
	public @NonNull Builder apiKey(@NonNull String apiKey) {

	public @NonNull List<StopArrival> getStopArrivals(String routeId, String stopId) {
	public @NonNull List<StopArrival> getStopArrivals(@NonNull String routeId, @NonNull String stopId) {

	public @NonNull Builder host(String host) {
	public @NonNull Builder host(@NonNull String host) {

	public @NonNull Optional<Bus> getBus(String id) {
	public @NonNull Optional<Bus> getBus(@NonNull String id) {

JSpecify #40

Are you sure you want to change the base?

JSpecify #40

Uh oh!

Conversation

lbkulinski commented Jan 2, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants