Skip to content

Commit 710bcec

Browse files
committed
include new param in javadoc
1 parent f5a0524 commit 710bcec

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

IntelliJ/src/main/java/com/nuix/enginebaseline/NuixEngine.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -548,6 +548,8 @@ public NuixVersion getNuixVersion() {
548548
* default to logging info messages.
549549
* @param errorOutputReceiver Consumer which will receive error output messages. If null is provided, will
550550
* default to logging error messages.
551+
* @param completedCallback Optional callback to be invoked upon script completion. Callback provided implicit value
552+
* of last script operation as well as map of variables.
551553
* @return A {@link RubyScriptRunner} instance. Call {@link RubyScriptRunner#join()} to wait for script to complete.
552554
* @throws Exception Exceptions are allowed to bubble up.
553555
*/
@@ -583,6 +585,8 @@ public RubyScriptRunner runRubyScriptAsync(String script, @Nullable Map<String,
583585
* @param script The Ruby script to execute. Cannot be null.
584586
* @param additionalVariables A map of any additional global/local variables you would like to set. Note that
585587
* constants cannot be set using this approach. Can be null.
588+
* @param completedCallback Optional callback to be invoked upon script completion. Callback provided implicit value
589+
* of last script operation as well as map of variables.
586590
* @return A {@link RubyScriptRunner} instance. Call {@link RubyScriptRunner#join()} to wait for script to complete.
587591
* @throws Exception Exceptions are allowed to bubble up.
588592
*/
@@ -600,6 +604,8 @@ public RubyScriptRunner runRubyScriptAsync(String script, @Nullable Map<String,
600604
* <li><code>NUIX_VERSION</code> - A String containing the current engine version</li>
601605
* </ul>
602606
* @param script The Ruby script to execute. Cannot be null.
607+
* @param completedCallback Optional callback to be invoked upon script completion. Callback provided implicit value
608+
* of last script operation as well as map of variables.
603609
* @return A {@link RubyScriptRunner} instance. Call {@link RubyScriptRunner#join()} to wait for script to complete.
604610
* @throws Exception Exceptions are allowed to bubble up.
605611
*/
@@ -625,6 +631,8 @@ public RubyScriptRunner runRubyScriptAsync(String script,
625631
* default to logging info messages.
626632
* @param errorOutputReceiver Consumer which will receive error output messages. If null is provided, will
627633
* default to logging error messages.
634+
* @param completedCallback Optional callback to be invoked upon script completion. Callback provided implicit value
635+
* of last script operation as well as map of variables.
628636
* @return A {@link RubyScriptRunner} instance. Call {@link RubyScriptRunner#join()} to wait for script to complete.
629637
* @throws Exception Exceptions are allowed to bubble up.
630638
*/
@@ -662,6 +670,8 @@ public RubyScriptRunner runRubyScriptFileAsync(File scriptFile, @Nullable Map<St
662670
* @param scriptFile The file containing the Ruby script to execute. Cannot be null.
663671
* @param additionalVariables A map of any additional global/local variables you would like to set. Note that
664672
* constants cannot be set using this approach. Can be null.
673+
* @param completedCallback Optional callback to be invoked upon script completion. Callback provided implicit value
674+
* of last script operation as well as map of variables.
665675
* @return A {@link RubyScriptRunner} instance. Call {@link RubyScriptRunner#join()} to wait for script to complete.
666676
* @throws Exception Exceptions are allowed to bubble up.
667677
*/
@@ -681,6 +691,8 @@ public RubyScriptRunner runRubyScriptFileAsync(File scriptFile, @Nullable Map<St
681691
* <li><code>NUIX_VERSION</code> - A String containing the current engine version</li>
682692
* </ul>
683693
* @param scriptFile The file containing the Ruby script to execute. Cannot be null.
694+
* @param completedCallback Optional callback to be invoked upon script completion. Callback provided implicit value
695+
* of last script operation as well as map of variables.
684696
* @return A {@link RubyScriptRunner} instance. Call {@link RubyScriptRunner#join()} to wait for script to complete.
685697
* @throws Exception Exceptions are allowed to bubble up.
686698
*/

0 commit comments

Comments
 (0)