Package org.codehaus.plexus.tools.cli

Class AbstractCli

  • All Implemented Interfaces:
    Cli
    public abstract class AbstractCli
extends java.lang.Object
implements Cli
    Author:
    jason van zyl

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DEBUG  
      static java.lang.String ERRORS  
      static java.lang.String HELP  
      static java.lang.String QUIET  
      static java.lang.String SET_SYSTEM_PROPERTY  
      static java.lang.String VERSION  

    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractCli()  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract org.apache.commons.cli.Options buildCliOptions​(org.apache.commons.cli.Options options)  
      org.apache.commons.cli.Options buildDefaultCliOptions()  
      protected void customizeContainerConfiguration​(org.codehaus.plexus.ContainerConfiguration configuration, org.apache.commons.cli.CommandLine cli)  
      void displayHelp()  
      int execute​(java.lang.String[] args)  
      int execute​(java.lang.String[] args, org.codehaus.plexus.classworlds.ClassWorld classWorld)  
      java.lang.String getPomPropertiesPath()  
      abstract void invokePlexusComponent​(org.apache.commons.cli.CommandLine cli, org.codehaus.plexus.PlexusContainer container)  
      org.apache.commons.cli.CommandLine parse​(java.lang.String[] args)  
      protected void showError​(java.lang.String message, java.lang.Exception e, boolean show)  
      protected int showFatalError​(java.lang.String message, java.lang.Exception e, boolean show)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • AbstractCli

        public AbstractCli()

    • Method Detail

      • buildCliOptions

        public abstract org.apache.commons.cli.Options buildCliOptions​(org.apache.commons.cli.Options options)
        Specified by:
        buildCliOptions in interface Cli

      • invokePlexusComponent

        public abstract void invokePlexusComponent​(org.apache.commons.cli.CommandLine cli,
                                           org.codehaus.plexus.PlexusContainer container)
                                    throws java.lang.Exception
        Specified by:
        invokePlexusComponent in interface Cli
        Throws:
        java.lang.Exception

      • getPomPropertiesPath

        public java.lang.String getPomPropertiesPath()
        Specified by:
        getPomPropertiesPath in interface Cli

      • execute

        public int execute​(java.lang.String[] args)

      • execute

        public int execute​(java.lang.String[] args,
                   org.codehaus.plexus.classworlds.ClassWorld classWorld)

      • customizeContainerConfiguration

        protected void customizeContainerConfiguration​(org.codehaus.plexus.ContainerConfiguration configuration,
                                               org.apache.commons.cli.CommandLine cli)

      • showFatalError

        protected int showFatalError​(java.lang.String message,
                             java.lang.Exception e,
                             boolean show)

      • showError

        protected void showError​(java.lang.String message,
                         java.lang.Exception e,
                         boolean show)

      • buildDefaultCliOptions

        public org.apache.commons.cli.Options buildDefaultCliOptions()

      • parse

        public org.apache.commons.cli.CommandLine parse​(java.lang.String[] args)
                                         throws org.apache.commons.cli.ParseException
        Throws:
        org.apache.commons.cli.ParseException

      • displayHelp

        public void displayHelp()