Deprecate DeploymentOptions worker property

eclipse-vertx · Oct 25, 2023 · 604bc9b · 604bc9b
1 parent f150fb1
commit 604bc9b
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 2 deletions.
diff --git a/src/main/asciidoc/index.adoc b/src/main/asciidoc/index.adoc
@@ -259,7 +259,7 @@ Worker verticles are designed for calling blocking code, as they won't block any
 If you don't want to use a worker verticle to run blocking code, you can also run <<blocking_code, inline blocking code>>
 directly while on an event loop.
 
-If you want to deploy a verticle as a worker verticle you do that with {@link io.vertx.core.DeploymentOptions#setWorker}.
+If you want to deploy a verticle as a worker verticle you do that with {@link io.vertx.core.DeploymentOptions#setThreadingModel}.
 
 [source,$lang]
 ----

diff --git a/src/main/java/examples/CoreExamples.java b/src/main/java/examples/CoreExamples.java
@@ -220,7 +220,7 @@ public void exampleFutureJoin2(Future<?> future1, Future<?> future2, Future<?> f
   }
 
   public void example7_1(Vertx vertx) {
-    DeploymentOptions options = new DeploymentOptions().setWorker(true);
+    DeploymentOptions options = new DeploymentOptions().setThreadingModel(ThreadingModel.WORKER);
     vertx.deployVerticle("com.mycompany.MyOrderProcessorVerticle", options);
   }
 

diff --git a/src/main/java/io/vertx/core/DeploymentOptions.java b/src/main/java/io/vertx/core/DeploymentOptions.java
@@ -144,7 +144,9 @@ public DeploymentOptions setThreadingModel(ThreadingModel threadingModel) {
    * Should the verticle(s) be deployed as a worker verticle?
    *
    * @return {@code true} if will be deployed as worker, {@code false} otherwise
+   * @deprecated instead use {@link #getThreadingModel()}
    */
+  @Deprecated
   public boolean isWorker() {
     return threadingModel == ThreadingModel.WORKER;
   }
@@ -154,7 +156,9 @@ public boolean isWorker() {
    *
    * @param worker {@code true} for worker, {@code false} force event-loop
    * @return a reference to this, so the API can be used fluently
+   * @deprecated instead use {@link #setThreadingModel(ThreadingModel)}
    */
+  @Deprecated
   public DeploymentOptions setWorker(boolean worker) {
     this.threadingModel = worker ? ThreadingModel.WORKER : ThreadingModel.EVENT_LOOP;
     return this;

diff --git a/src/main/java11/io/vertx/core/DeploymentOptions.java b/src/main/java11/io/vertx/core/DeploymentOptions.java
@@ -119,7 +119,9 @@ public DeploymentOptions setConfig(JsonObject config) {
    * Which threading model the verticle(s) should use?
    *
    * @return the verticle threading model
+   * @deprecated instead use {@link #getThreadingModel()}
    */
+  @Deprecated
   public ThreadingModel getThreadingModel() {
     return threadingModel;
   }
@@ -129,7 +131,9 @@ public ThreadingModel getThreadingModel() {
    *
    * @param threadingModel the threading model
    * @return a reference to this, so the API can be used fluently
+   * @deprecated instead use {@link #setThreadingModel(ThreadingModel)}
    */
+  @Deprecated
   public DeploymentOptions setThreadingModel(ThreadingModel threadingModel) {
     this.threadingModel = threadingModel;
     return this;