(accumulo) branch main updated: Updates command group and KWE javadocs (#6127)

[kturner]

This is an automated email from the ASF dual-hosted git repository.

kturner pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/accumulo.git


The following commit(s) were added to refs/heads/main by this push:
     new 625584ce9b Updates command group and KWE javadocs (#6127)
625584ce9b is described below

commit 625584ce9b9be22b3475d050ae6084de9074a462
Author: Keith Turner <ktur...@apache.org>
AuthorDate: Fri Feb 13 14:49:08 2026 -0800

    Updates command group and KWE javadocs (#6127)
---
 .../apache/accumulo/start/spi/CommandGroup.java    | 19 +++++++++++++++++
 .../apache/accumulo/start/spi/CommandGroups.java   | 24 ++++++++++++++++++++++
 .../accumulo/start/spi/KeywordExecutable.java      |  2 ++
 3 files changed, 45 insertions(+)

diff --git 
a/start/src/main/java/org/apache/accumulo/start/spi/CommandGroup.java 
b/start/src/main/java/org/apache/accumulo/start/spi/CommandGroup.java
index d1f0313fe4..c5e34862ec 100644
--- a/start/src/main/java/org/apache/accumulo/start/spi/CommandGroup.java
+++ b/start/src/main/java/org/apache/accumulo/start/spi/CommandGroup.java
@@ -18,14 +18,33 @@
  */
 package org.apache.accumulo.start.spi;
 
+/**
+ * Used for grouping {@link KeywordExecutable} commands.
+ *
+ * @since 4.0.0
+ */
 public interface CommandGroup extends Comparable<CommandGroup> {
 
+  /**
+   * To execute a command in this group this key must be entered before the 
command. Should not
+   * contain spaces. Evaluation at runtime is case-insensitive. So if the 
keyword is {@code Foo} and
+   * the user types {@code foo} it will still work.
+   */
   String key();
 
+  /**
+   * The title is informational and is used when displaying all commands in 
this group.
+   */
   String title();
 
+  /**
+   * The description is informational and provides more details about a group.
+   */
   String description();
 
+  /**
+   * Compares on {@link #key()}, then {@link #title()}, and then {@link 
#description()}.
+   */
   @Override
   default int compareTo(CommandGroup o) {
     int result = this.key().compareTo(o.key());
diff --git 
a/start/src/main/java/org/apache/accumulo/start/spi/CommandGroups.java 
b/start/src/main/java/org/apache/accumulo/start/spi/CommandGroups.java
index e98d77ab5a..bac68eaec3 100644
--- a/start/src/main/java/org/apache/accumulo/start/spi/CommandGroups.java
+++ b/start/src/main/java/org/apache/accumulo/start/spi/CommandGroups.java
@@ -25,6 +25,9 @@ import java.util.TreeSet;
 
 import com.google.auto.service.AutoService;
 
+/**
+ * @since 4.0.0
+ */
 public class CommandGroups {
 
   public static final CommandGroup ADMIN = new AdminCommandGroup();
@@ -45,6 +48,9 @@ public class CommandGroups {
     return groups;
   }
 
+  /**
+   * @since 4.0.0
+   */
   public static abstract class BaseCommandGroup implements CommandGroup {
 
     @Override
@@ -68,6 +74,9 @@ public class CommandGroups {
 
   }
 
+  /**
+   * @since 4.0.0
+   */
   @AutoService(CommandGroup.class)
   public static class AdminCommandGroup extends BaseCommandGroup {
 
@@ -87,6 +96,9 @@ public class CommandGroups {
     }
   }
 
+  /**
+   * @since 4.0.0
+   */
   @AutoService(CommandGroup.class)
   public static class ClientCommandGroup extends BaseCommandGroup {
 
@@ -106,6 +118,9 @@ public class CommandGroups {
     }
   }
 
+  /**
+   * @since 4.0.0
+   */
   @AutoService(CommandGroup.class)
   public static class CompactionCommandGroup extends BaseCommandGroup {
 
@@ -125,6 +140,9 @@ public class CommandGroups {
     }
   }
 
+  /**
+   * @since 4.0.0
+   */
   @AutoService(CommandGroup.class)
   public static class CoreCommandGroup extends BaseCommandGroup {
 
@@ -144,6 +162,9 @@ public class CommandGroups {
     }
   }
 
+  /**
+   * @since 4.0.0
+   */
   @AutoService(CommandGroup.class)
   public static class ProcessCommandGroup extends BaseCommandGroup {
 
@@ -163,6 +184,9 @@ public class CommandGroups {
     }
   }
 
+  /**
+   * @since 4.0.0
+   */
   @AutoService(CommandGroup.class)
   public static class OtherCommandGroup extends BaseCommandGroup {
 
diff --git 
a/start/src/main/java/org/apache/accumulo/start/spi/KeywordExecutable.java 
b/start/src/main/java/org/apache/accumulo/start/spi/KeywordExecutable.java
index dfc96addfb..e4e87d0dc3 100644
--- a/start/src/main/java/org/apache/accumulo/start/spi/KeywordExecutable.java
+++ b/start/src/main/java/org/apache/accumulo/start/spi/KeywordExecutable.java
@@ -44,6 +44,7 @@ import java.util.ServiceLoader;
  */
 public interface KeywordExecutable {
 
+  @Deprecated(since = "4.0.0")
   enum UsageGroup {
     CORE, PROCESS, OTHER
   }
@@ -70,6 +71,7 @@ public interface KeywordExecutable {
 
   /**
    * @return CommandGroup for this command
+   * @since 4.0.0
    */
   CommandGroup commandGroup();