refactor: convert simple POJO classes to records for improved readability and simplify method usage

Author: brunoborges

src/main/java/com/github/copilot/sdk/json/Attachment.java

@@ -11,100 +11,24 @@
  * Represents a file attachment to include with a message.
  * <p>
  * Attachments provide additional context to the AI assistant, such as source
- * code files, documents, or other relevant content. All setter methods return
- * {@code this} for method chaining.
+ * code files, documents, or other relevant content.
  *
  * <h2>Example Usage</h2>
  *
  * <pre>{@code
- * var attachment = new Attachment().setType("file").setPath("/path/to/source.java").setDisplayName("Main Source File");
+ * var attachment = new Attachment("file", "/path/to/source.java", "Main Source File");
  * }</pre>
  *
+ * @param type
+ *            the attachment type (e.g., "file")
+ * @param path
+ *            the absolute path to the file on the filesystem
+ * @param displayName
+ *            a human-readable display name for the attachment
  * @see MessageOptions#setAttachments(java.util.List)
  * @since 1.0.0
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
-public class Attachment {
-
-    @JsonProperty("type")
-    private String type;
-
-    @JsonProperty("path")
-    private String path;
-
-    @JsonProperty("displayName")
-    private String displayName;
-
-    /**
-     * Gets the attachment type.
-     *
-     * @return the type (e.g., "file")
-     */
-    public String getType() {
-        return type;
-    }
-
-    /**
-     * Sets the attachment type.
-     * <p>
-     * Currently supported types:
-     * <ul>
-     * <li>"file" - A file from the filesystem</li>
-     * </ul>
-     *
-     * @param type
-     *            the attachment type
-     * @return this attachment for method chaining
-     */
-    public Attachment setType(String type) {
-        this.type = type;
-        return this;
-    }
-
-    /**
-     * Gets the file path.
-     *
-     * @return the absolute path to the file
-     */
-    public String getPath() {
-        return path;
-    }
-
-    /**
-     * Sets the file path.
-     * <p>
-     * This should be an absolute path to the file on the filesystem.
-     *
-     * @param path
-     *            the absolute file path
-     * @return this attachment for method chaining
-     */
-    public Attachment setPath(String path) {
-        this.path = path;
-        return this;
-    }
-
-    /**
-     * Gets the display name.
-     *
-     * @return the display name for the attachment
-     */
-    public String getDisplayName() {
-        return displayName;
-    }
-
-    /**
-     * Sets a human-readable display name for the attachment.
-     * <p>
-     * This name is shown to the assistant and may be used when referring to the
-     * file in responses.
-     *
-     * @param displayName
-     *            the display name
-     * @return this attachment for method chaining
-     */
-    public Attachment setDisplayName(String displayName) {
-        this.displayName = displayName;
-        return this;
-    }
+public record Attachment(@JsonProperty("type") String type, @JsonProperty("path") String path,
+        @JsonProperty("displayName") String displayName) {
 }

src/main/java/com/github/copilot/sdk/json/MessageOptions.java

@@ -19,7 +19,7 @@
  *
  * <pre>{@code
  * var options = new MessageOptions().setPrompt("Explain this code")
- * 		.setAttachments(List.of(new Attachment().setType("file").setPath("/path/to/file.java")));
+ * 		.setAttachments(List.of(new Attachment("file", "/path/to/file.java", null)));
  *
  * session.send(options).get();
  * }</pre>

src/main/java/com/github/copilot/sdk/json/PostToolUseHookOutput.java

@@ -11,80 +11,16 @@
 /**
  * Output for a post-tool-use hook.
  *
+ * @param modifiedResult
+ *            the modified tool result, or {@code null} to use original
+ * @param additionalContext
+ *            additional context to provide to the model
+ * @param suppressOutput
+ *            {@code true} to suppress output
  * @since 1.0.6
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
-public class PostToolUseHookOutput {
-
-    @JsonProperty("modifiedResult")
-    private JsonNode modifiedResult;
-
-    @JsonProperty("additionalContext")
-    private String additionalContext;
-
-    @JsonProperty("suppressOutput")
-    private Boolean suppressOutput;
-
-    /**
-     * Gets the modified tool result.
-     *
-     * @return the modified result, or {@code null} to use original
-     */
-    public JsonNode getModifiedResult() {
-        return modifiedResult;
-    }
-
-    /**
-     * Sets the modified tool result.
-     *
-     * @param modifiedResult
-     *            the modified result
-     * @return this instance for method chaining
-     */
-    public PostToolUseHookOutput setModifiedResult(JsonNode modifiedResult) {
-        this.modifiedResult = modifiedResult;
-        return this;
-    }
-
-    /**
-     * Gets additional context to provide to the model.
-     *
-     * @return the additional context
-     */
-    public String getAdditionalContext() {
-        return additionalContext;
-    }
-
-    /**
-     * Sets additional context to provide to the model.
-     *
-     * @param additionalContext
-     *            the additional context
-     * @return this instance for method chaining
-     */
-    public PostToolUseHookOutput setAdditionalContext(String additionalContext) {
-        this.additionalContext = additionalContext;
-        return this;
-    }
-
-    /**
-     * Returns whether to suppress output.
-     *
-     * @return {@code true} to suppress output
-     */
-    public Boolean getSuppressOutput() {
-        return suppressOutput;
-    }
-
-    /**
-     * Sets whether to suppress output.
-     *
-     * @param suppressOutput
-     *            {@code true} to suppress output
-     * @return this instance for method chaining
-     */
-    public PostToolUseHookOutput setSuppressOutput(Boolean suppressOutput) {
-        this.suppressOutput = suppressOutput;
-        return this;
-    }
+public record PostToolUseHookOutput(@JsonProperty("modifiedResult") JsonNode modifiedResult,
+        @JsonProperty("additionalContext") String additionalContext,
+        @JsonProperty("suppressOutput") Boolean suppressOutput) {
 }

src/main/java/com/github/copilot/sdk/json/SessionEndHandler.java

@@ -16,9 +16,8 @@
  *
  * <pre>{@code
  * SessionEndHandler handler = (input, invocation) -> {
- * 	System.out.println("Session ended: " + input.getReason());
- * 	return CompletableFuture
- * 			.completedFuture(new SessionEndHookOutput().setSessionSummary("Session completed successfully"));
+ * 	System.out.println("Session ended: " + input.reason());
+ * 	return CompletableFuture.completedFuture(new SessionEndHookOutput(null, null, "Session completed successfully"));
  * };
  * }</pre>
  *

src/main/java/com/github/copilot/sdk/json/SessionEndHookInput.java

@@ -13,129 +13,21 @@
  * This hook is invoked when a session ends, allowing you to perform cleanup or
  * logging.
  *
+ * @param timestamp
+ *            the timestamp in milliseconds since epoch when the session ended
+ * @param cwd
+ *            the current working directory
+ * @param reason
+ *            the reason: "complete", "error", "abort", "timeout", or
+ *            "user_exit"
+ * @param finalMessage
+ *            the final message, or {@code null}
+ * @param error
+ *            the error message, or {@code null}
  * @since 1.0.7
  */
 @JsonIgnoreProperties(ignoreUnknown = true)
-public class SessionEndHookInput {
-
-    @JsonProperty("timestamp")
-    private long timestamp;
-
-    @JsonProperty("cwd")
-    private String cwd;
-
-    @JsonProperty("reason")
-    private String reason;
-
-    @JsonProperty("finalMessage")
-    private String finalMessage;
-
-    @JsonProperty("error")
-    private String error;
-
-    /**
-     * Gets the timestamp when the session ended.
-     *
-     * @return the timestamp in milliseconds since epoch
-     */
-    public long getTimestamp() {
-        return timestamp;
-    }
-
-    /**
-     * Sets the timestamp when the session ended.
-     *
-     * @param timestamp
-     *            the timestamp in milliseconds since epoch
-     * @return this instance for method chaining
-     */
-    public SessionEndHookInput setTimestamp(long timestamp) {
-        this.timestamp = timestamp;
-        return this;
-    }
-
-    /**
-     * Gets the current working directory.
-     *
-     * @return the current working directory
-     */
-    public String getCwd() {
-        return cwd;
-    }
-
-    /**
-     * Sets the current working directory.
-     *
-     * @param cwd
-     *            the current working directory
-     * @return this instance for method chaining
-     */
-    public SessionEndHookInput setCwd(String cwd) {
-        this.cwd = cwd;
-        return this;
-    }
-
-    /**
-     * Gets the reason for session end.
-     *
-     * @return the reason: "complete", "error", "abort", "timeout", or "user_exit"
-     */
-    public String getReason() {
-        return reason;
-    }
-
-    /**
-     * Sets the reason for session end.
-     *
-     * @param reason
-     *            the reason: "complete", "error", "abort", "timeout", or
-     *            "user_exit"
-     * @return this instance for method chaining
-     */
-    public SessionEndHookInput setReason(String reason) {
-        this.reason = reason;
-        return this;
-    }
-
-    /**
-     * Gets the final message, if any.
-     *
-     * @return the final message, or {@code null}
-     */
-    public String getFinalMessage() {
-        return finalMessage;
-    }
-
-    /**
-     * Sets the final message.
-     *
-     * @param finalMessage
-     *            the final message
-     * @return this instance for method chaining
-     */
-    public SessionEndHookInput setFinalMessage(String finalMessage) {
-        this.finalMessage = finalMessage;
-        return this;
-    }
-
-    /**
-     * Gets the error message, if the session ended due to an error.
-     *
-     * @return the error message, or {@code null}
-     */
-    public String getError() {
-        return error;
-    }
-
-    /**
-     * Sets the error message.
-     *
-     * @param error
-     *            the error message
-     * @return this instance for method chaining
-     */
-    public SessionEndHookInput setError(String error) {
-        this.error = error;
-        return this;
-    }
+public record SessionEndHookInput(@JsonProperty("timestamp") long timestamp, @JsonProperty("cwd") String cwd,
+        @JsonProperty("reason") String reason, @JsonProperty("finalMessage") String finalMessage,
+        @JsonProperty("error") String error) {
 }