Package org.jboss.galleon.cli

Class HelpSupport

  • public class HelpSupport
extends java.lang.Object
    Author:
    jdenise@redhat.com

    • Constructor Summary

      Constructors 
      Constructor Description
      HelpSupport()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String buildHelp​(org.aesh.command.registry.CommandRegistry<? extends org.aesh.command.invocation.CommandInvocation> registry, java.util.Set<java.lang.String> commands)  
      static java.util.List<java.lang.String> getAvailableCommands​(org.aesh.command.registry.CommandRegistry<? extends org.aesh.command.invocation.CommandInvocation> registry, boolean includeChilds, boolean onlyEnabled)  
      static java.lang.String getToolHelp​(PmSession session, org.aesh.command.registry.CommandRegistry<? extends org.aesh.command.invocation.CommandInvocation> registry)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • HelpSupport

        public HelpSupport()

    • Method Detail

      • getToolHelp

        public static java.lang.String getToolHelp​(PmSession session,
                                           org.aesh.command.registry.CommandRegistry<? extends org.aesh.command.invocation.CommandInvocation> registry)
                                    throws org.aesh.command.CommandNotFoundException
        Throws:
        org.aesh.command.CommandNotFoundException

      • getAvailableCommands

        public static java.util.List<java.lang.String> getAvailableCommands​(org.aesh.command.registry.CommandRegistry<? extends org.aesh.command.invocation.CommandInvocation> registry,
                                                                    boolean includeChilds,
                                                                    boolean onlyEnabled)

      • buildHelp

        public static java.lang.String buildHelp​(org.aesh.command.registry.CommandRegistry<? extends org.aesh.command.invocation.CommandInvocation> registry,
                                         java.util.Set<java.lang.String> commands)
                                  throws org.aesh.command.CommandNotFoundException
        Throws:
        org.aesh.command.CommandNotFoundException