From d77879415fc173620da9f0e3b3a6b7298fd7e89e Mon Sep 17 00:00:00 2001 From: Jonah Graham Date: Tue, 13 Feb 2024 11:45:43 -0500 Subject: [PATCH] Update documentation for common location of Preconditions (#804) Follow up for #800 --- documentation/jsonrpc.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/documentation/jsonrpc.md b/documentation/jsonrpc.md index b7e68cb6..374be45e 100644 --- a/documentation/jsonrpc.md +++ b/documentation/jsonrpc.md @@ -201,12 +201,7 @@ public class HelloParam { The generation may generate dependencies on some additional classes. Refer to the following sub-sections for details. -### `ToStringBuilder` and other dependent classes +### `ToStringBuilder`, `Preconditions` and other dependent classes -When using the generator the generated code may refer to `ToStringBuilder` and other classes in the `org.eclipse.lsp4j.jsonrpc` bundle. +When using the generator the generated code may refer to `ToStringBuilder`, `Preconditions` and other classes in the `org.eclipse.lsp4j.jsonrpc` bundle. Ensure that there is a runtime dependency on the `org.eclipse.lsp4j.jsonrpc` in your project. - -### `Preconditions` class - -When using LSP4J's `@NonNull` annotations a class called `Preconditions` is needed with the method `checkNotNull` in a sub-package called `util` to check null annotations at runtime. -For an example class refer to the versions provided in LSP4J ([link](https://github.com/eclipse-lsp4j/lsp4j/blob/main/org.eclipse.lsp4j/src/main/java/org/eclipse/lsp4j/util/Preconditions.java)).