Package studio.mevera.imperat.help

Class ConsoleStringHelpComponent

java.lang.Object
studio.mevera.imperat.command.tree.help.theme.HelpComponent<S,String>
studio.mevera.imperat.command.tree.help.theme.StringHelpComponent<ConsoleCommandSource>
studio.mevera.imperat.help.ConsoleStringHelpComponent
public class ConsoleStringHelpComponent extends studio.mevera.imperat.command.tree.help.theme.StringHelpComponent<ConsoleCommandSource>
RootCommand-line interface implementation of string-based help components. This class provides simple text-based help messages for CLI commands, designed for console applications and command-line tools.

Features:

  • Simple string-based help messages
  • Automatic integration with ConsoleCommandSource messaging
  • Console-friendly formatting
  • Lightweight design for CLI applications
  • No external dependencies

Usage Example:


 ConsoleStringHelpComponent help = ConsoleStringHelpComponent.of(
     "Use: myapp process <file> - Process the specified file"
 );
Since:
2.1.0
See Also:

  • Field Summary

    Fields inherited from class studio.mevera.imperat.command.tree.help.theme.HelpComponent

    componentValue

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    ConsoleStringHelpComponent(@NotNull String componentValue)
    Creates a new ConsoleStringHelpComponent with the specified string content.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ConsoleStringHelpComponent
    of(@NotNull String componentValue)
    Creates a new ConsoleStringHelpComponent with the specified string content.

    Methods inherited from class studio.mevera.imperat.command.tree.help.theme.StringHelpComponent

    append, appendText, repeat, send

    Methods inherited from class studio.mevera.imperat.command.tree.help.theme.HelpComponent

    append, appendParameterFormat, appendText, plainText

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ConsoleStringHelpComponent

      protected ConsoleStringHelpComponent(@NotNull @NotNull String componentValue)
      Creates a new ConsoleStringHelpComponent with the specified string content.
      Parameters:
      componentValue - the string content to display as help

  • Method Details

    • of

      public static ConsoleStringHelpComponent of(@NotNull @NotNull String componentValue)
      Creates a new ConsoleStringHelpComponent with the specified string content.
      Parameters:
      componentValue - the string content to display as help
      Returns:
      a new ConsoleStringHelpComponent instance