Skip to content

Use JSR-305 annotations instead of Jetbrains annotations #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 30, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@ subprojects {
targetCompatibility = javaVersion
}

val implementation by configurations
val api by configurations
val testImplementation by configurations

dependencies {
implementation("org.jetbrains:annotations:17.0.0")
api("com.google.code.findbugs:jsr305:3.0.2")

testImplementation("com.google.guava:guava:28.1-jre")
testImplementation("org.testng:testng:7.0.0")
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
package ru.bozaro.gitlfs.client;

import org.jetbrains.annotations.NotNull;
import ru.bozaro.gitlfs.client.auth.AuthProvider;
import ru.bozaro.gitlfs.client.auth.BasicAuthProvider;
import ru.bozaro.gitlfs.client.auth.ExternalAuthProvider;

import javax.annotation.Nonnull;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
Expand Down Expand Up @@ -34,7 +34,8 @@ private AuthHelper() {
* @param gitURL URL to repository.
* @return Created auth provider.
*/
public static AuthProvider create(@NotNull String gitURL) throws MalformedURLException {
@Nonnull
public static AuthProvider create(@Nonnull String gitURL) throws MalformedURLException {
if (gitURL.contains("://")) {
final URI uri = URI.create(gitURL);
final String path = uri.getPath();
Expand All @@ -52,8 +53,8 @@ public static AuthProvider create(@NotNull String gitURL) throws MalformedURLExc
return new ExternalAuthProvider(gitURL);
}

@NotNull
public static URI join(@NotNull URI href, @NotNull String... path) {
@Nonnull
public static URI join(@Nonnull URI href, @Nonnull String... path) {
try {
URI uri = new URI(href.getScheme(), href.getAuthority(), href.getPath() + (href.getPath().endsWith("/") ? "" : "/"), null, null);
for (String fragment : path)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
package ru.bozaro.gitlfs.client;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import ru.bozaro.gitlfs.client.internal.BatchWorker;
import ru.bozaro.gitlfs.client.internal.Work;
import ru.bozaro.gitlfs.client.io.StreamHandler;
Expand All @@ -10,6 +8,8 @@
import ru.bozaro.gitlfs.common.data.Meta;
import ru.bozaro.gitlfs.common.data.Operation;

import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import java.io.IOException;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutorService;
Expand All @@ -20,22 +20,22 @@
* @author Artem V. Navrotskiy
*/
public class BatchDownloader extends BatchWorker<StreamHandler<?>, Object> {
public BatchDownloader(@NotNull Client client, @NotNull ExecutorService pool) {
public BatchDownloader(@Nonnull Client client, @Nonnull ExecutorService pool) {
this(client, pool, new BatchSettings());
}

public BatchDownloader(@NotNull Client client, @NotNull ExecutorService pool, @NotNull BatchSettings settings) {
public BatchDownloader(@Nonnull Client client, @Nonnull ExecutorService pool, @Nonnull BatchSettings settings) {
super(client, pool, settings, Operation.Download);
}

@SuppressWarnings("unchecked")
@NotNull
public <T> CompletableFuture<T> download(@NotNull final Meta meta, @NotNull StreamHandler<T> callback) {
@Nonnull
public <T> CompletableFuture<T> download(@Nonnull final Meta meta, @Nonnull StreamHandler<T> callback) {
return (CompletableFuture<T>) enqueue(meta, callback);
}

@Nullable
protected Work<Object> objectTask(@NotNull State<StreamHandler<?>, Object> state, @NotNull BatchItem item) {
@CheckForNull
protected Work<Object> objectTask(@Nonnull State<StreamHandler<?>, Object> state, @Nonnull BatchItem item) {
// Invalid links data
if (!item.getLinks().containsKey(LinkType.Download)) {
state.getFuture().completeExceptionally(new IOException("Download link not found"));
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package ru.bozaro.gitlfs.client;

import org.jetbrains.annotations.NotNull;
import javax.annotation.Nonnull;

import static ru.bozaro.gitlfs.common.Constants.BATCH_SIZE;

Expand Down Expand Up @@ -36,7 +36,7 @@ public int getLimit() {
return limit;
}

@NotNull
@Nonnull
public BatchSettings setLimit(int limit) {
this.limit = Math.min(limit, 1);
return this;
Expand All @@ -46,7 +46,7 @@ public int getThreshold() {
return threshold;
}

@NotNull
@Nonnull
public BatchSettings setThreshold(int threshold) {
this.threshold = Math.max(threshold, 0);
return this;
Expand All @@ -56,7 +56,7 @@ public int getRetryCount() {
return retryCount;
}

@NotNull
@Nonnull
public BatchSettings setRetryCount(int retryCount) {
this.retryCount = Math.max(retryCount, 1);
return this;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
package ru.bozaro.gitlfs.client;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import ru.bozaro.gitlfs.client.internal.BatchWorker;
import ru.bozaro.gitlfs.client.internal.Work;
import ru.bozaro.gitlfs.client.io.StreamProvider;
Expand All @@ -10,6 +8,8 @@
import ru.bozaro.gitlfs.common.data.Meta;
import ru.bozaro.gitlfs.common.data.Operation;

import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutorService;

Expand All @@ -19,11 +19,11 @@
* @author Artem V. Navrotskiy
*/
public class BatchUploader extends BatchWorker<StreamProvider, Meta> {
public BatchUploader(@NotNull Client client, @NotNull ExecutorService pool) {
public BatchUploader(@Nonnull Client client, @Nonnull ExecutorService pool) {
this(client, pool, new BatchSettings());
}

public BatchUploader(@NotNull Client client, @NotNull ExecutorService pool, @NotNull BatchSettings settings) {
public BatchUploader(@Nonnull Client client, @Nonnull ExecutorService pool, @Nonnull BatchSettings settings) {
super(client, pool, settings, Operation.Upload);
}

Expand All @@ -33,8 +33,8 @@ public BatchUploader(@NotNull Client client, @NotNull ExecutorService pool, @Not
* @param streamProvider Stream provider.
* @return Return future with upload result.
*/
@NotNull
public CompletableFuture<Meta> upload(@NotNull final StreamProvider streamProvider) {
@Nonnull
public CompletableFuture<Meta> upload(@Nonnull final StreamProvider streamProvider) {
final CompletableFuture<Meta> future = new CompletableFuture<>();
getPool().submit(() -> {
try {
Expand All @@ -53,13 +53,13 @@ public CompletableFuture<Meta> upload(@NotNull final StreamProvider streamProvid
* @param streamProvider Stream provider.
* @return Return future with upload result. For same objects can return same future.
*/
@NotNull
public CompletableFuture<Meta> upload(@NotNull final Meta meta, @NotNull final StreamProvider streamProvider) {
@Nonnull
public CompletableFuture<Meta> upload(@Nonnull final Meta meta, @Nonnull final StreamProvider streamProvider) {
return enqueue(meta, streamProvider);
}

@Nullable
protected Work<Meta> objectTask(@NotNull State<StreamProvider, Meta> state, @NotNull BatchItem item) {
@CheckForNull
protected Work<Meta> objectTask(@Nonnull State<StreamProvider, Meta> state, @Nonnull BatchItem item) {
if (item.getLinks().containsKey(LinkType.Upload)) {
// Wait for upload.
return auth -> {
Expand Down
Loading