Explain deprecations

bsideup · bsideup · commit 330e54d347df · 2020-05-27T12:22:00.000+02:00
diff --git a/docker-java-api/src/main/java/com/github/dockerjava/api/command/CreateContainerCmd.java b/docker-java-api/src/main/java/com/github/dockerjava/api/command/CreateContainerCmd.java
diff --git a/docker-java-core/src/main/java/com/github/dockerjava/core/DockerClientImpl.java b/docker-java-core/src/main/java/com/github/dockerjava/core/DockerClientImpl.java
@@ -215,7 +215,7 @@ public DockerHttpClient getHttpClient() {
     }
 
     /**
-     * @deprecated use {{@link #withHttpClient(DockerHttpClient)}}
+     * @deprecated use {@link #withHttpClient(DockerHttpClient)}
      */
     @Deprecated
     public DockerClientImpl withDockerCmdExecFactory(DockerCmdExecFactory dockerCmdExecFactory) {
diff --git a/docker-java-core/src/main/java/com/github/dockerjava/core/command/AttachContainerResultCallback.java b/docker-java-core/src/main/java/com/github/dockerjava/core/command/AttachContainerResultCallback.java
@@ -13,6 +13,7 @@
  *
  * @author Marcus Linke
  *
+ * @deprecated use {@link com.github.dockerjava.api.async.ResultCallback.Adapter}
  */
 @Deprecated
 public class AttachContainerResultCallback extends ResultCallbackTemplate<AttachContainerResultCallback, Frame> {
diff --git a/docker-java-core/src/main/java/com/github/dockerjava/core/command/BuildImageResultCallback.java b/docker-java-core/src/main/java/com/github/dockerjava/core/command/BuildImageResultCallback.java
@@ -3,19 +3,19 @@
  */
 package com.github.dockerjava.core.command;
 
-import java.util.concurrent.TimeUnit;
-
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 import com.github.dockerjava.api.exception.DockerClientException;
 import com.github.dockerjava.api.model.BuildResponseItem;
 import com.github.dockerjava.core.async.ResultCallbackTemplate;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.concurrent.TimeUnit;
 
 /**
  *
  * @author Marcus Linke
  *
+ * @deprecated use {@link com.github.dockerjava.api.command.BuildImageResultCallback}
  */
 @Deprecated
 public class BuildImageResultCallback extends ResultCallbackTemplate<BuildImageResultCallback, BuildResponseItem> {
diff --git a/docker-java-core/src/main/java/com/github/dockerjava/core/command/EventsResultCallback.java b/docker-java-core/src/main/java/com/github/dockerjava/core/command/EventsResultCallback.java
@@ -13,6 +13,7 @@
  *
  * @author Marcus Linke
  *
+ * @deprecated use {@link com.github.dockerjava.api.async.ResultCallback.Adapter}
  */
 @Deprecated
 public class EventsResultCallback extends ResultCallbackTemplate<EventsResultCallback, Event> {
diff --git a/docker-java-core/src/main/java/com/github/dockerjava/core/command/ExecStartResultCallback.java b/docker-java-core/src/main/java/com/github/dockerjava/core/command/ExecStartResultCallback.java
@@ -1,18 +1,18 @@
 package com.github.dockerjava.core.command;
 
-import java.io.IOException;
-import java.io.OutputStream;
-
+import com.github.dockerjava.api.model.Frame;
+import com.github.dockerjava.core.async.ResultCallbackTemplate;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.github.dockerjava.api.model.Frame;
-import com.github.dockerjava.core.async.ResultCallbackTemplate;
+import java.io.IOException;
+import java.io.OutputStream;
 
 /**
  *
  * @author Marcus Linke
  *
+ * @deprecated use {@link com.github.dockerjava.api.async.ResultCallback.Adapter}
  */
 @Deprecated
 public class ExecStartResultCallback extends ResultCallbackTemplate<ExecStartResultCallback, Frame> {
diff --git a/docker-java-core/src/main/java/com/github/dockerjava/core/command/LogContainerResultCallback.java b/docker-java-core/src/main/java/com/github/dockerjava/core/command/LogContainerResultCallback.java
@@ -13,6 +13,7 @@
  *
  * @author Marcus Linke
  *
+ * @deprecated use {@link com.github.dockerjava.api.async.ResultCallback.Adapter}
  */
 @Deprecated
 public class LogContainerResultCallback extends ResultCallbackTemplate<LogContainerResultCallback, Frame> {
diff --git a/docker-java-core/src/main/java/com/github/dockerjava/core/command/PullImageResultCallback.java b/docker-java-core/src/main/java/com/github/dockerjava/core/command/PullImageResultCallback.java
@@ -18,6 +18,7 @@
  *
  * @author Marcus Linke
  *
+ * @deprecated use {@link com.github.dockerjava.api.command.PullImageResultCallback}
  */
 @Deprecated
 public class PullImageResultCallback extends ResultCallbackTemplate<PullImageResultCallback, PullResponseItem> {
diff --git a/docker-java-core/src/main/java/com/github/dockerjava/core/command/PushImageResultCallback.java b/docker-java-core/src/main/java/com/github/dockerjava/core/command/PushImageResultCallback.java
@@ -16,6 +16,7 @@
  *
  * @author Marcus Linke
  *
+ * @deprecated use {@link com.github.dockerjava.api.async.ResultCallback.Adapter}
  */
 @Deprecated
 public class PushImageResultCallback extends ResultCallbackTemplate<PushImageResultCallback, PushResponseItem> {
diff --git a/docker-java-core/src/main/java/com/github/dockerjava/core/command/WaitContainerResultCallback.java b/docker-java-core/src/main/java/com/github/dockerjava/core/command/WaitContainerResultCallback.java
@@ -3,21 +3,20 @@
  */
 package com.github.dockerjava.core.command;
 
-import java.util.concurrent.TimeUnit;
-
-import javax.annotation.CheckForNull;
-
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 import com.github.dockerjava.api.exception.DockerClientException;
 import com.github.dockerjava.api.model.WaitResponse;
 import com.github.dockerjava.core.async.ResultCallbackTemplate;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.annotation.CheckForNull;
+import java.util.concurrent.TimeUnit;
 
 /**
  *
  * @author Marcus Linke
  *
+ * @deprecated use {@link com.github.dockerjava.api.command.WaitContainerResultCallback}
  */
 @Deprecated
 public class WaitContainerResultCallback extends ResultCallbackTemplate<WaitContainerResultCallback, WaitResponse> {

Original file line number	Diff line number	Diff line change
`@@ -215,7 +215,7 @@ public DockerHttpClient getHttpClient() {`
`215`	`215`	`}`
`216`	`216`
`217`	`217`	`/**`
`218`		`- * @deprecated use {{@link #withHttpClient(DockerHttpClient)}}`
	`218`	`+ * @deprecated use {@link #withHttpClient(DockerHttpClient)}`
`219`	`219`	`*/`
`220`	`220`	`@Deprecated`
`221`	`221`	`public DockerClientImpl withDockerCmdExecFactory(DockerCmdExecFactory dockerCmdExecFactory) {`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`	`*`
`14`	`14`	`* @author Marcus Linke`
`15`	`15`	`*`
	`16`	`+ * @deprecated use {@link com.github.dockerjava.api.async.ResultCallback.Adapter}`
`16`	`17`	`*/`
`17`	`18`	`@Deprecated`
`18`	`19`	`public class AttachContainerResultCallback extends ResultCallbackTemplate<AttachContainerResultCallback, Frame> {`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@`
`18`	`18`	`*`
`19`	`19`	`* @author Marcus Linke`
`20`	`20`	`*`
	`21`	`+ * @deprecated use {@link com.github.dockerjava.api.command.PullImageResultCallback}`
`21`	`22`	`*/`
`22`	`23`	`@Deprecated`
`23`	`24`	`public class PullImageResultCallback extends ResultCallbackTemplate<PullImageResultCallback, PullResponseItem> {`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@`
`16`	`16`	`*`
`17`	`17`	`* @author Marcus Linke`
`18`	`18`	`*`
	`19`	`+ * @deprecated use {@link com.github.dockerjava.api.async.ResultCallback.Adapter}`
`19`	`20`	`*/`
`20`	`21`	`@Deprecated`
`21`	`22`	`public class PushImageResultCallback extends ResultCallbackTemplate<PushImageResultCallback, PushResponseItem> {`