dropbox / dropbox/dropbox-sdk-java

Use JSR 305 Nullable/Nonnull annotations?

Open
#17 2 comments 0 reactions 0 assignees Claimed by @joshafeinberg View on GitHub
dropbox enhancement
Dominant language
Java
Stars
627
Forks
463
Avg merge
5m
Merged PRs (30d)
10

Description

Such annotations can help immensely when programming with the API, as it tells the API user what to expect.

Two examples from `DbxClient`:
- `.startGetFile()` can have null as its second argument; it will also never return null; therefore:

``` java
@Nonnull
DbxClient.Downloader startGetFile(String path, @Nullable String rev)
```
- `.getMetadata()` can return null:

``` java
@Nullable
DbxEntry getMetadata(String path)
```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.