Skip to content

Commit

Permalink
Update documentation for common location of Preconditions
Browse files Browse the repository at this point in the history
Follow up for eclipse-lsp4j#800
  • Loading branch information
jonahgraham committed Feb 13, 2024
1 parent 9bc4650 commit d09c4d1
Showing 1 changed file with 2 additions and 7 deletions.
9 changes: 2 additions & 7 deletions documentation/jsonrpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)).

0 comments on commit d09c4d1

Please sign in to comment.