diff --git a/README.md b/README.md index 2710b2dab..8d60b3a74 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,8 @@ interactively showing users what options and subcommands are available. ![Picocli Demo help message with ANSI colors](docs/images/picocli.Demo.png?raw=true) #### Releases -* [Releases](https://github.com/remkop/picocli/releases) - latest: 3.0.0-alpha-1 +* [Releases](https://github.com/remkop/picocli/releases) - latest: 3.0.0-alpha-2 +* [Picocli 3.0.0-alpha-1 Release Notes](https://github.com/remkop/picocli/releases/tag/v3.0.0-alpha-1) - note there are some [potential breaking changes](https://github.com/remkop/picocli/releases/tag/v3.0.0-alpha-1#3.0.0-alpha-1-breaking-changes) from prior versions * [Picocli 2.0 Release Notes](https://github.com/remkop/picocli/releases/tag/v2.0.0) - note there are some [potential breaking changes](https://github.com/remkop/picocli/releases/tag/v2.0.0#2.0-breaking-changes) from prior versions #### Documentation @@ -138,35 +139,35 @@ See the [source code](https://github.com/remkop/picocli/blob/master/src/main/jav ### Gradle ``` -compile 'info.picocli:picocli:3.0.0-alpha-1' +compile 'info.picocli:picocli:3.0.0-alpha-2' ``` ### Maven ``` info.picocli picocli - 3.0.0-alpha-1 + 3.0.0-alpha-2 ``` ### Scala SBT ``` -libraryDependencies += "info.picocli" % "picocli" % "3.0.0-alpha-1" +libraryDependencies += "info.picocli" % "picocli" % "3.0.0-alpha-2" ``` ### Ivy ``` - + ``` ### Grape ```groovy @Grapes( - @Grab(group='info.picocli', module='picocli', version='3.0.0-alpha-1') + @Grab(group='info.picocli', module='picocli', version='3.0.0-alpha-2') ) ``` ### Leiningen ``` -[info.picocli/picocli "3.0.0-alpha-1"] +[info.picocli/picocli "3.0.0-alpha-2"] ``` ### Buildr ``` -'info.picocli:picocli:jar:3.0.0-alpha-1' +'info.picocli:picocli:jar:3.0.0-alpha-2' ``` diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md index a2d798a72..36c3daea2 100644 --- a/RELEASE-NOTES.md +++ b/RELEASE-NOTES.md @@ -1,6 +1,6 @@ # picocli Release Notes -# Picocli 3.0.0-alpha-2 (UNRELEASED) +# Picocli 3.0.0-alpha-2 The picocli community is pleased to announce picocli 3.0.0-alpha-2. This release includes some bug fixes and small enhancements. See [3.0.0-alpha-1](#3.0.0-alpha-1) for recent functional changes. diff --git a/build.gradle b/build.gradle index cff9d17ed..d98966f9a 100644 --- a/build.gradle +++ b/build.gradle @@ -1,11 +1,11 @@ group 'info.picocli' description 'Annotation-based Java command line parser. Usage help with ANSI styles and colors. Autocomplete. Nested subcommands. Easily included as source to avoid adding a dependency.' -version '3.0.0-alpha-2-SNAPSHOT' +version '3.0.0-alpha-2' // for bumpVersion task -def oldVersion = '3\\.0\\.0-alpha-1' +def oldVersion = '3\\.0\\.0-alpha-2-SNAPSHOT' def oldRevdate = '2018\\-03\\-21' -def revDate = '2018-03-21' +def revDate = '2018-03-27' // for bumpReadmeVersion task def previousReleaseVersion = '3.0.0-alpha-1' diff --git a/docs/announcing-picocli-1.0.html b/docs/announcing-picocli-1.0.html index 6f2f32df1..f8e8b6871 100644 --- a/docs/announcing-picocli-1.0.html +++ b/docs/announcing-picocli-1.0.html @@ -638,7 +638,7 @@

Feedback Welcome

diff --git a/docs/apidocs/allclasses-frame.html b/docs/apidocs/allclasses-frame.html index 8299b69cf..2c2910eae 100644 --- a/docs/apidocs/allclasses-frame.html +++ b/docs/apidocs/allclasses-frame.html @@ -2,49 +2,47 @@ - -All Classes (picocli 3.0.0-alpha-1 API) - + +All Classes (picocli 3.0.0-alpha-2 API) + - -

All Classes

+

All Classes

  • AutoComplete
  • CommandLine
  • CommandLine.AbstractHandler
  • CommandLine.AbstractParseResultHandler
    • -
  • CommandLine.AbstractSimpleParseResultHandler
  • CommandLine.Command
  • CommandLine.DefaultExceptionHandler
  • CommandLine.DuplicateOptionAnnotationsException
  • CommandLine.ExecutionException
  • CommandLine.Help
  • CommandLine.Help.Ansi
    • -
  • CommandLine.Help.Ansi.IStyle
    • +
  • CommandLine.Help.Ansi.IStyle
  • CommandLine.Help.Ansi.Style
  • CommandLine.Help.ColorScheme
  • CommandLine.Help.Column
  • CommandLine.Help.Column.Overflow
    • -
  • CommandLine.Help.IOptionRenderer
    • -
  • CommandLine.Help.IParameterRenderer
    • -
  • CommandLine.Help.IParamLabelRenderer
    • +
  • CommandLine.Help.IOptionRenderer
    • +
  • CommandLine.Help.IParameterRenderer
    • +
  • CommandLine.Help.IParamLabelRenderer
  • CommandLine.Help.Layout
  • CommandLine.Help.TextTable
  • CommandLine.Help.TextTable.Cell
  • CommandLine.Help.Visibility
  • CommandLine.HelpCommand
    • -
  • CommandLine.IExceptionHandler
    • -
  • CommandLine.IExceptionHandler2
    • -
  • CommandLine.IFactory
    • -
  • CommandLine.IHelpCommandInitializable
    • +
  • CommandLine.IExceptionHandler
    • +
  • CommandLine.IExceptionHandler2
    • +
  • CommandLine.IFactory
    • +
  • CommandLine.IHelpCommandInitializable
  • CommandLine.InitializationException
    • -
  • CommandLine.IParseResultHandler
    • -
  • CommandLine.IParseResultHandler2
    • -
  • CommandLine.ITypeConverter
    • -
  • CommandLine.IVersionProvider
    • +
  • CommandLine.IParseResultHandler
    • +
  • CommandLine.IParseResultHandler2
    • +
  • CommandLine.ITypeConverter
    • +
  • CommandLine.IVersionProvider
  • CommandLine.MaxValuesforFieldExceededException
  • CommandLine.MissingParameterException
  • CommandLine.MissingTypeConverterException
    • @@ -52,7 +50,7 @@

    All Classes

  • CommandLine.Model
  • CommandLine.Model.ArgSpec
  • CommandLine.Model.CommandSpec
    • -
  • CommandLine.Model.IBinding
    • +
  • CommandLine.Model.IBinding
  • CommandLine.Model.OptionSpec
  • CommandLine.Model.OptionSpec.Builder
  • CommandLine.Model.ParserSpec
    • diff --git a/docs/apidocs/allclasses-noframe.html b/docs/apidocs/allclasses-noframe.html index d414a0519..04afb8b9b 100644 --- a/docs/apidocs/allclasses-noframe.html +++ b/docs/apidocs/allclasses-noframe.html @@ -2,49 +2,47 @@ - -All Classes (picocli 3.0.0-alpha-1 API) - + +All Classes (picocli 3.0.0-alpha-2 API) + - -

    All Classes

    +

    All Classes

    • AutoComplete
    • CommandLine
    • CommandLine.AbstractHandler
    • CommandLine.AbstractParseResultHandler
      • -
    • CommandLine.AbstractSimpleParseResultHandler
    • CommandLine.Command
    • CommandLine.DefaultExceptionHandler
    • CommandLine.DuplicateOptionAnnotationsException
    • CommandLine.ExecutionException
    • CommandLine.Help
    • CommandLine.Help.Ansi
      • -
    • CommandLine.Help.Ansi.IStyle
      • +
    • CommandLine.Help.Ansi.IStyle
    • CommandLine.Help.Ansi.Style
    • CommandLine.Help.ColorScheme
    • CommandLine.Help.Column
    • CommandLine.Help.Column.Overflow
      • -
    • CommandLine.Help.IOptionRenderer
      • -
    • CommandLine.Help.IParameterRenderer
      • -
    • CommandLine.Help.IParamLabelRenderer
      • +
    • CommandLine.Help.IOptionRenderer
      • +
    • CommandLine.Help.IParameterRenderer
      • +
    • CommandLine.Help.IParamLabelRenderer
    • CommandLine.Help.Layout
    • CommandLine.Help.TextTable
    • CommandLine.Help.TextTable.Cell
    • CommandLine.Help.Visibility
    • CommandLine.HelpCommand
      • -
    • CommandLine.IExceptionHandler
      • -
    • CommandLine.IExceptionHandler2
      • -
    • CommandLine.IFactory
      • -
    • CommandLine.IHelpCommandInitializable
      • +
    • CommandLine.IExceptionHandler
      • +
    • CommandLine.IExceptionHandler2
      • +
    • CommandLine.IFactory
      • +
    • CommandLine.IHelpCommandInitializable
    • CommandLine.InitializationException
      • -
    • CommandLine.IParseResultHandler
      • -
    • CommandLine.IParseResultHandler2
      • -
    • CommandLine.ITypeConverter
      • -
    • CommandLine.IVersionProvider
      • +
    • CommandLine.IParseResultHandler
      • +
    • CommandLine.IParseResultHandler2
      • +
    • CommandLine.ITypeConverter
      • +
    • CommandLine.IVersionProvider
    • CommandLine.MaxValuesforFieldExceededException
    • CommandLine.MissingParameterException
    • CommandLine.MissingTypeConverterException
      • @@ -52,7 +50,7 @@

      All Classes

    • CommandLine.Model
    • CommandLine.Model.ArgSpec
    • CommandLine.Model.CommandSpec
      • -
    • CommandLine.Model.IBinding
      • +
    • CommandLine.Model.IBinding
    • CommandLine.Model.OptionSpec
    • CommandLine.Model.OptionSpec.Builder
    • CommandLine.Model.ParserSpec
      • diff --git a/docs/apidocs/constant-values.html b/docs/apidocs/constant-values.html index c6f34b93b..edb010f9c 100644 --- a/docs/apidocs/constant-values.html +++ b/docs/apidocs/constant-values.html @@ -2,20 +2,15 @@ - -Constant Field Values (picocli 3.0.0-alpha-1 API) - + +Constant Field Values (picocli 3.0.0-alpha-2 API) + - @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -47,10 +40,10 @@
      - +
      @@ -81,7 +74,7 @@

      Contents

      picocli.*

      - +
      -
      +
      +

      Picocli is a one-file framework for creating Java command line applications with almost zero code. It supports a variety of command line syntax styles including POSIX, GNU, MS-DOS and more. @@ -154,12 +148,11 @@

      picocli 3.0.0-alpha-1 API

      }
      +
      -
      +
      - -
      Skip navigation links
      - +
        @@ -179,10 +172,10 @@

        picocli 3.0.0-alpha-1 API

      - +
      diff --git a/docs/apidocs/overview-tree.html b/docs/apidocs/overview-tree.html index 65cfea876..a06e63613 100644 --- a/docs/apidocs/overview-tree.html +++ b/docs/apidocs/overview-tree.html @@ -2,20 +2,15 @@ - -Class Hierarchy (picocli 3.0.0-alpha-1 API) - + +Class Hierarchy (picocli 3.0.0-alpha-2 API) + - @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -47,10 +40,10 @@
      - +

      Hierarchy For All Packages

      -Package Hierarchies: +Package Hierarchies:
      -
      +
      - -
      Skip navigation links
      - +
        @@ -237,10 +227,10 @@

        Enum Hierarchy

      - +
      diff --git a/docs/apidocs/picocli/AutoComplete.html b/docs/apidocs/picocli/AutoComplete.html index 663c228d5..c4454a1c7 100644 --- a/docs/apidocs/picocli/AutoComplete.html +++ b/docs/apidocs/picocli/AutoComplete.html @@ -2,38 +2,25 @@ - -AutoComplete (picocli 3.0.0-alpha-1 API) - + +AutoComplete (picocli 3.0.0-alpha-2 API) + - -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -42,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -42,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -42,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -42,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -42,15 +35,15 @@
      @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -42,15 +35,15 @@
      @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -42,15 +35,15 @@
      @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -42,15 +35,15 @@
      @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -42,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -42,15 +35,15 @@
      @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -42,15 +35,15 @@
      @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -42,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -42,15 +35,15 @@
      @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -42,15 +35,15 @@
      @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -42,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -42,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -42,15 +35,15 @@
      @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -42,15 +35,15 @@
      @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -42,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@
      @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -42,15 +35,15 @@
      -
      +
      - -
      Skip navigation links
      - +
        @@ -48,15 +35,15 @@

      picocli.groovy

      diff --git a/docs/apidocs/picocli/groovy/package-summary.html b/docs/apidocs/picocli/groovy/package-summary.html index 43baa84a0..8eb80227b 100644 --- a/docs/apidocs/picocli/groovy/package-summary.html +++ b/docs/apidocs/picocli/groovy/package-summary.html @@ -2,20 +2,15 @@ - -picocli.groovy (picocli 3.0.0-alpha-1 API) - + +picocli.groovy (picocli 3.0.0-alpha-2 API) + - @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -42,15 +35,15 @@
      - +
      @@ -73,12 +66,12 @@

      Package picocli.groovy

      Provides classes and annotations to give Groovy scripts convenient access to picocli functionality.
      -

      See: Description

      +

      See: Description

      • - +
        @@ -103,7 +96,7 @@

        Package picocli.groovy

        Class Summary 
        Class
      • - +
        @@ -121,18 +114,16 @@

        Package picocli.groovy

        Annotation Types Summary 
        Annotation Type
      - +

      Package picocli.groovy Description

      Provides classes and annotations to give Groovy scripts convenient access to picocli functionality.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -147,15 +138,15 @@

        Package picocli.groovy Descriptio

      - +
      diff --git a/docs/apidocs/picocli/groovy/package-tree.html b/docs/apidocs/picocli/groovy/package-tree.html index 48df7e8c7..642bfe507 100644 --- a/docs/apidocs/picocli/groovy/package-tree.html +++ b/docs/apidocs/picocli/groovy/package-tree.html @@ -2,20 +2,15 @@ - -picocli.groovy Class Hierarchy (picocli 3.0.0-alpha-1 API) - + +picocli.groovy Class Hierarchy (picocli 3.0.0-alpha-2 API) + - @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -47,10 +40,10 @@
      - +

      Hierarchy For Package picocli.groovy

      -Package Hierarchies: +Package Hierarchies: @@ -82,14 +75,14 @@

      Class Hierarchy

      Annotation Type Hierarchy

        -
      • picocli.groovy.PicocliScript (implements java.lang.annotation.Annotation)
        • +
      • picocli.groovy.PicocliScript (implements java.lang.annotation.Annotation)
      -
      +
      - -
      Skip navigation links
      - +
        @@ -127,10 +118,10 @@

        Annotation Type Hierarchy

      - +
      diff --git a/docs/apidocs/picocli/package-frame.html b/docs/apidocs/picocli/package-frame.html index 7ceddfda6..ab6ed0f2f 100644 --- a/docs/apidocs/picocli/package-frame.html +++ b/docs/apidocs/picocli/package-frame.html @@ -2,30 +2,29 @@ - -picocli (picocli 3.0.0-alpha-1 API) - + +picocli (picocli 3.0.0-alpha-2 API) + -

      picocli

      Interfaces

      Classes

      - +

      Package picocli Description

      @@ -570,11 +557,9 @@

      Package picocli Description

      -
      +
      - -
      Skip navigation links
      - +
        @@ -589,15 +574,15 @@

        Package picocli Description

      - +
      diff --git a/docs/apidocs/picocli/package-tree.html b/docs/apidocs/picocli/package-tree.html index dd43a52a4..9859610b8 100644 --- a/docs/apidocs/picocli/package-tree.html +++ b/docs/apidocs/picocli/package-tree.html @@ -2,20 +2,15 @@ - -picocli Class Hierarchy (picocli 3.0.0-alpha-1 API) - + +picocli Class Hierarchy (picocli 3.0.0-alpha-2 API) + - @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -47,10 +40,10 @@
      - +

      Hierarchy For Package picocli

      -Package Hierarchies: +Package Hierarchies: @@ -80,70 +73,69 @@

      Class Hierarchy

      -
      +
      - -
      Skip navigation links
      - +
        @@ -221,10 +211,10 @@

        Enum Hierarchy

      - +
      diff --git a/docs/apidocs/serialized-form.html b/docs/apidocs/serialized-form.html index 663d488f7..2f10a6a1d 100644 --- a/docs/apidocs/serialized-form.html +++ b/docs/apidocs/serialized-form.html @@ -2,20 +2,15 @@ - -Serialized Form (picocli 3.0.0-alpha-1 API) - + +Serialized Form (picocli 3.0.0-alpha-2 API) + - @@ -23,11 +18,9 @@
      JavaScript is disabled on your browser.
      -
      +
      - -
      Skip navigation links
      - +
        @@ -47,10 +40,10 @@
      - +
      @@ -94,7 +87,9 @@

      Class -
    • +
    • + +

      Serialized Fields

      • @@ -159,7 +154,9 @@

        Class -
      • +
      • + +

        Serialized Fields

        • @@ -211,11 +208,9 @@

          Class +
          - -
          Skip navigation links
          - +
          - +
          diff --git a/docs/apidocs/stylesheet.css b/docs/apidocs/stylesheet.css index 98055b22d..0aeaa97fe 100644 --- a/docs/apidocs/stylesheet.css +++ b/docs/apidocs/stylesheet.css @@ -2,19 +2,16 @@ /* Overall document style */ - -@import url('resources/fonts/dejavu.css'); - body { background-color:#ffffff; color:#353833; - font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; - font-size:14px; + font-family:Arial, Helvetica, sans-serif; + font-size:76%; margin:0; } a:link, a:visited { text-decoration:none; - color:#4A6782; + color:#4c6b87; } a:hover, a:focus { text-decoration:none; @@ -22,7 +19,7 @@ a:hover, a:focus { } a:active { text-decoration:none; - color:#4A6782; + color:#4c6b87; } a[name] { color:#353833; @@ -32,51 +29,41 @@ a[name]:hover { color:#353833; } pre { - font-family:'DejaVu Sans Mono', monospace; - font-size:14px; + font-size:1.3em; } h1 { - font-size:20px; + font-size:1.8em; } h2 { - font-size:18px; + font-size:1.5em; } h3 { - font-size:16px; - font-style:italic; + font-size:1.4em; } h4 { - font-size:13px; + font-size:1.3em; } h5 { - font-size:12px; + font-size:1.2em; } h6 { - font-size:11px; + font-size:1.1em; } ul { list-style-type:disc; } code, tt { - font-family:'DejaVu Sans Mono', monospace; - font-size:14px; - padding-top:4px; - margin-top:8px; - line-height:1.4em; + font-size:1.2em; } dt code { - font-family:'DejaVu Sans Mono', monospace; - font-size:14px; - padding-top:4px; + font-size:1.2em; } table tr td dt code { - font-family:'DejaVu Sans Mono', monospace; - font-size:14px; + font-size:1.2em; vertical-align:top; - padding-top:4px; } sup { - font-size:8px; + font-size:.6em; } /* Document title and Copyright styles @@ -89,9 +76,9 @@ Document title and Copyright styles .aboutLanguage { float:right; padding:0px 21px; - font-size:11px; + font-size:.8em; z-index:200; - margin-top:-9px; + margin-top:-7px; } .legalCopy { margin-left:.5em; @@ -105,6 +92,9 @@ Document title and Copyright styles } .tab { background-color:#0066FF; + background-image:url(resources/titlebar.gif); + background-position:left top; + background-repeat:no-repeat; color:#ffffff; padding:8px; width:5em; @@ -114,15 +104,17 @@ Document title and Copyright styles Navigation bar styles */ .bar { - background-color:#4D7A97; + background-image:url(resources/background.gif); + background-repeat:repeat-x; color:#FFFFFF; padding:.8em .5em .4em .8em; height:auto;/*height:1.8em;*/ - font-size:11px; + font-size:1em; margin:0; } .topNav { - background-color:#4D7A97; + background-image:url(resources/background.gif); + background-repeat:repeat-x; color:#FFFFFF; float:left; padding:0; @@ -131,11 +123,11 @@ Navigation bar styles height:2.8em; padding-top:10px; overflow:hidden; - font-size:12px; } .bottomNav { margin-top:10px; - background-color:#4D7A97; + background-image:url(resources/background.gif); + background-repeat:repeat-x; color:#FFFFFF; float:left; padding:0; @@ -144,20 +136,18 @@ Navigation bar styles height:2.8em; padding-top:10px; overflow:hidden; - font-size:12px; } .subNav { background-color:#dee3e9; + border-bottom:1px solid #9eadc0; float:left; width:100%; overflow:hidden; - font-size:12px; } .subNav div { clear:left; float:left; padding:0 0 5px 6px; - text-transform:uppercase; } ul.navList, ul.subNavList { float:left; @@ -167,33 +157,27 @@ ul.navList, ul.subNavList { ul.navList li{ list-style:none; float:left; - padding: 5px 6px; - text-transform:uppercase; + padding:3px 6px; } ul.subNavList li{ list-style:none; float:left; + font-size:90%; } .topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { color:#FFFFFF; text-decoration:none; - text-transform:uppercase; } .topNav a:hover, .bottomNav a:hover { text-decoration:none; color:#bb7a2a; - text-transform:uppercase; } .navBarCell1Rev { - background-color:#F8981D; - color:#253441; + background-image:url(resources/tab.gif); + background-color:#a88834; + color:#FFFFFF; margin: auto 5px; -} -.skipNav { - position:absolute; - top:auto; - left:-9999px; - overflow:hidden; + border:1px solid #c9aa44; } /* Page header and footer styles @@ -207,11 +191,8 @@ Page header and footer styles margin:10px; position:relative; } -.indexHeader span{ - margin-right:15px; -} .indexHeader h1 { - font-size:13px; + font-size:1.3em; } .title { color:#2c4557; @@ -221,7 +202,7 @@ Page header and footer styles margin:5px 0 0 0; } .header ul { - margin:0 0 15px 0; + margin:0 0 25px 0; padding:0; } .footer ul { @@ -229,22 +210,24 @@ Page header and footer styles } .header ul li, .footer ul li { list-style:none; - font-size:13px; + font-size:1.2em; } /* Heading styles */ div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { background-color:#dee3e9; - border:1px solid #d0d9e0; + border-top:1px solid #9eadc0; + border-bottom:1px solid #9eadc0; margin:0 0 6px -8px; - padding:7px 5px; + padding:2px 5px; } ul.blockList ul.blockList ul.blockList li.blockList h3 { background-color:#dee3e9; - border:1px solid #d0d9e0; + border-top:1px solid #9eadc0; + border-bottom:1px solid #9eadc0; margin:0 0 6px -8px; - padding:7px 5px; + padding:2px 5px; } ul.blockList ul.blockList li.blockList h3 { padding:0; @@ -264,10 +247,10 @@ Page layout container styles .indexContainer { margin:10px; position:relative; - font-size:12px; + font-size:1.0em; } .indexContainer h2 { - font-size:13px; + font-size:1.1em; padding:0 0 3px 0; } .indexContainer ul { @@ -276,18 +259,15 @@ Page layout container styles } .indexContainer ul li { list-style:none; - padding-top:2px; } .contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { - font-size:12px; + font-size:1.1em; font-weight:bold; margin:10px 0 0 0; color:#4E4E4E; } .contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { - margin:5px 0 10px 0px; - font-size:14px; - font-family:'DejaVu Sans Mono',monospace; + margin:10px 0 10px 20px; } .serializedFormContainer dl.nameValue dt { margin-left:1px; @@ -326,24 +306,25 @@ ul.blockList, ul.blockListLast { } ul.blockList li.blockList, ul.blockListLast li.blockList { list-style:none; - margin-bottom:15px; - line-height:1.4; + margin-bottom:25px; } ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { padding:0px 20px 5px 10px; - border:1px solid #ededed; - background-color:#f8f8f8; + border:1px solid #9eadc0; + background-color:#f9f9f9; } ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { padding:0 0 5px 8px; background-color:#ffffff; - border:none; + border:1px solid #9eadc0; + border-top:none; } ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { margin-left:0; padding-left:0; padding-bottom:15px; border:none; + border-bottom:1px solid #9eadc0; } ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { list-style:none; @@ -357,155 +338,107 @@ table tr td dl, table tr td dl dt, table tr td dl dd { /* Table styles */ -.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { +.contentContainer table, .classUseContainer table, .constantValuesContainer table { + border-bottom:1px solid #9eadc0; width:100%; - border-left:1px solid #EEE; - border-right:1px solid #EEE; - border-bottom:1px solid #EEE; } -.overviewSummary, .memberSummary { - padding:0px; +.contentContainer ul li table, .classUseContainer ul li table, .constantValuesContainer ul li table { + width:100%; +} +.contentContainer .description table, .contentContainer .details table { + border-bottom:none; +} +.contentContainer ul li table th.colOne, .contentContainer ul li table th.colFirst, .contentContainer ul li table th.colLast, .classUseContainer ul li table th, .constantValuesContainer ul li table th, .contentContainer ul li table td.colOne, .contentContainer ul li table td.colFirst, .contentContainer ul li table td.colLast, .classUseContainer ul li table td, .constantValuesContainer ul li table td{ + vertical-align:top; + padding-right:20px; +} +.contentContainer ul li table th.colLast, .classUseContainer ul li table th.colLast,.constantValuesContainer ul li table th.colLast, +.contentContainer ul li table td.colLast, .classUseContainer ul li table td.colLast,.constantValuesContainer ul li table td.colLast, +.contentContainer ul li table th.colOne, .classUseContainer ul li table th.colOne, +.contentContainer ul li table td.colOne, .classUseContainer ul li table td.colOne { + padding-right:3px; } -.overviewSummary caption, .memberSummary caption, .typeSummary caption, -.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { +.overviewSummary caption, .packageSummary caption, .contentContainer ul.blockList li.blockList caption, .summary caption, .classUseContainer caption, .constantValuesContainer caption { position:relative; text-align:left; background-repeat:no-repeat; - color:#253441; + color:#FFFFFF; font-weight:bold; clear:none; overflow:hidden; padding:0px; - padding-top:10px; - padding-left:1px; margin:0px; - white-space:pre; -} -.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, -.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, -.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, -.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, -.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, -.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, -.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, -.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { +} +caption a:link, caption a:hover, caption a:active, caption a:visited { color:#FFFFFF; } -.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, -.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { +.overviewSummary caption span, .packageSummary caption span, .contentContainer ul.blockList li.blockList caption span, .summary caption span, .classUseContainer caption span, .constantValuesContainer caption span { white-space:nowrap; - padding-top:5px; - padding-left:12px; - padding-right:12px; - padding-bottom:7px; - display:inline-block; + padding-top:8px; + padding-left:8px; + display:block; float:left; - background-color:#F8981D; - border: none; - height:16px; + background-image:url(resources/titlebar.gif); + height:18px; } -.memberSummary caption span.activeTableTab span { - white-space:nowrap; - padding-top:5px; - padding-left:12px; - padding-right:12px; - margin-right:3px; - display:inline-block; +.overviewSummary .tabEnd, .packageSummary .tabEnd, .contentContainer ul.blockList li.blockList .tabEnd, .summary .tabEnd, .classUseContainer .tabEnd, .constantValuesContainer .tabEnd { + width:10px; + background-image:url(resources/titlebar_end.gif); + background-repeat:no-repeat; + background-position:top right; + position:relative; float:left; - background-color:#F8981D; - height:16px; } -.memberSummary caption span.tableTab span { - white-space:nowrap; - padding-top:5px; - padding-left:12px; - padding-right:12px; - margin-right:3px; - display:inline-block; - float:left; - background-color:#4D7A97; - height:16px; -} -.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { - padding-top:0px; - padding-left:0px; - padding-right:0px; - background-image:none; - float:none; - display:inline; +ul.blockList ul.blockList li.blockList table { + margin:0 0 12px 0px; + width:100%; } -.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, -.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { - display:none; - width:5px; - position:relative; - float:left; - background-color:#F8981D; +.tableSubHeadingColor { + background-color: #EEEEFF; } -.memberSummary .activeTableTab .tabEnd { - display:none; - width:5px; - margin-right:3px; - position:relative; - float:left; - background-color:#F8981D; +.altColor { + background-color:#eeeeef; } -.memberSummary .tableTab .tabEnd { - display:none; - width:5px; - margin-right:3px; - position:relative; - background-color:#4D7A97; - float:left; - +.rowColor { + background-color:#ffffff; } -.overviewSummary td, .memberSummary td, .typeSummary td, -.useSummary td, .constantsSummary td, .deprecatedSummary td { +.overviewSummary td, .packageSummary td, .contentContainer ul.blockList li.blockList td, .summary td, .classUseContainer td, .constantValuesContainer td { text-align:left; - padding:0px 0px 12px 10px; -} -th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, -td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ - vertical-align:top; - padding-right:0px; - padding-top:8px; - padding-bottom:3px; + padding:3px 3px 3px 7px; } -th.colFirst, th.colLast, th.colOne, .constantsSummary th { +th.colFirst, th.colLast, th.colOne, .constantValuesContainer th { background:#dee3e9; + border-top:1px solid #9eadc0; + border-bottom:1px solid #9eadc0; text-align:left; - padding:8px 3px 3px 7px; + padding:3px 3px 3px 7px; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; } td.colFirst, th.colFirst { + border-left:1px solid #9eadc0; white-space:nowrap; - font-size:13px; } td.colLast, th.colLast { - font-size:13px; + border-right:1px solid #9eadc0; } td.colOne, th.colOne { - font-size:13px; -} -.overviewSummary td.colFirst, .overviewSummary th.colFirst, -.useSummary td.colFirst, .useSummary th.colFirst, -.overviewSummary td.colOne, .overviewSummary th.colOne, -.memberSummary td.colFirst, .memberSummary th.colFirst, -.memberSummary td.colOne, .memberSummary th.colOne, -.typeSummary td.colFirst{ - width:25%; - vertical-align:top; + border-right:1px solid #9eadc0; + border-left:1px solid #9eadc0; } -td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { - font-weight:bold; -} -.tableSubHeadingColor { - background-color:#EEEEFF; +table.overviewSummary { + padding:0px; + margin-left:0px; } -.altColor { - background-color:#FFFFFF; +table.overviewSummary td.colFirst, table.overviewSummary th.colFirst, +table.overviewSummary td.colOne, table.overviewSummary th.colOne { + width:25%; + vertical-align:middle; } -.rowColor { - background-color:#EEEEEF; +table.packageSummary td.colFirst, table.overviewSummary th.colFirst { + width:25%; + vertical-align:middle; } /* Content styles @@ -520,24 +453,6 @@ Content styles .docSummary { padding:0; } - -ul.blockList ul.blockList ul.blockList li.blockList h3 { - font-style:normal; -} - -div.block { - font-size:14px; - font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; -} - -td.colLast div { - padding-top:0px; -} - - -td.colLast a { - padding-bottom:3px; -} /* Formatting effect styles */ @@ -548,27 +463,12 @@ Formatting effect styles h1.hidden { visibility:hidden; overflow:hidden; - font-size:10px; + font-size:.9em; } .block { display:block; - margin:3px 10px 2px 0px; - color:#474747; + margin:3px 0 0 0; } -.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, -.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, -.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { +.strong { font-weight:bold; } -.deprecationComment, .emphasizedPhrase, .interfaceName { - font-style:italic; -} - -div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, -div.block div.block span.interfaceName { - font-style:normal; -} - -div.contentContainer ul.blockList li.blockList h2{ - padding-bottom:0px; -} diff --git a/docs/autocomplete.adoc b/docs/autocomplete.adoc index 4c1c585f4..e60a002bd 100644 --- a/docs/autocomplete.adoc +++ b/docs/autocomplete.adoc @@ -1,8 +1,8 @@ = Autocomplete for Java Command Line Applications //:author: Remko Popma //:email: rpopma@apache.org -:revnumber: 3.0.0-alpha-2-SNAPSHOT -:revdate: 2018-03-21 +:revnumber: 3.0.0-alpha-2 +:revdate: 2018-03-27 :toc: left :numbered: :toclevels: 3 diff --git a/docs/autocomplete.html b/docs/autocomplete.html index 9976d7c68..7ef082f9a 100644 --- a/docs/autocomplete.html +++ b/docs/autocomplete.html @@ -513,8 +513,8 @@

      • 7. Help @@ -1957,6 +1958,13 @@

        6.6. Stop At Unmatched

        unmatched arguments list returned by CommandLine.getUnmatchedArguments().

      • +
      +

      6.7. Disallowing POSIX Clustered Short Options

      +
      +

      By default, the picocli parser allows POSIX clustered short options, so short options like -x -v -f SomeFile can be clustered together like -xvfSomeFile. +From picocli 3.0, applications can call CommandLine.setPosixClusteredShortOptionsAllowed(false) to enforce that options must be separated with whitespace on the command line.

      +
      +
      @@ -3784,7 +3792,7 @@

      14.3. Stdout or Stderr

      cmd.parseWithHandlers( new RunLast().useOut(myOut).useAnsi(Help.Ansi.ON), - new DefaultExceptionHandler().useErr(myErr).useAnsi(Help.Ansi.OFF), + CommandLine.defaultExceptionHandler().useErr(myErr).useAnsi(Help.Ansi.OFF), args); } } @@ -3807,7 +3815,7 @@

      14.4. Exit Code

      CommandLine cmd = new CommandLine(new ExitCodeDemo()); cmd.parseWithHandlers( new RunLast().andExit(123), - new DefaultExceptionHandler().andExit(456), + CommandLine.defaultExceptionHandler().andExit(456), args); } } @@ -4133,7 +4141,7 @@

      17.1. Groovy

      -
      @Grab('info.picocli:picocli:3.0.0-alpha-1')
+
      @Grab('info.picocli:picocli:3.0.0-alpha-2')
 @Command(name = "myCommand",
   description = "@|bold Groovy script|@ @|underline picocli|@ example")
 @picocli.groovy.PicocliScript
@@ -4172,7 +4180,7 @@ 
      17.1. Groovy
      -
      @Grab('info.picocli:picocli:3.0.0-alpha-1')
+
      @Grab('info.picocli:picocli:3.0.0-alpha-2')
 @GrabExclude('org.codehaus.groovy:groovy-all') // work around GROOVY-7613
 ...
      @@ -4344,7 +4352,7 @@

      23. Download

      23.1. Gradle

      -
      compile 'info.picocli:picocli:3.0.0-alpha-1'
      +
      compile 'info.picocli:picocli:3.0.0-alpha-2'
      @@ -4355,7 +4363,7 @@

      23.2. Maven

      <dependency>
   <groupId>info.picocli</groupId>
   <artifactId>picocli</artifactId>
-  <version>3.0.0-alpha-1</version>
+  <version>3.0.0-alpha-2</version>
 </dependency>
      @@ -4364,7 +4372,7 @@

      23.2. Maven

      23.3. Scala SBT

      -
      libraryDependencies += "info.picocli" % "picocli" % "3.0.0-alpha-1"
      +
      libraryDependencies += "info.picocli" % "picocli" % "3.0.0-alpha-2"
      @@ -4372,7 +4380,7 @@

      23.3. Scala SBT

      23.4. Ivy

      -
      <dependency org="info.picocli" name="picocli" rev="3.0.0-alpha-1" />
      +
      <dependency org="info.picocli" name="picocli" rev="3.0.0-alpha-2" />
      @@ -4397,11 +4405,7 @@

      23.5. Source

      */ package picocli; -import java.io.File; -import java.io.FileReader; -import java.io.LineNumberReader; -import java.io.PrintStream; -import java.io.StreamTokenizer; +import java.io.*; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; @@ -4520,7 +4524,7 @@

      23.5. Source

      */ public class CommandLine { /** This is picocli version {@value}. */ - public static final String VERSION = "3.0.0-alpha-1"; + public static final String VERSION = "3.0.0-alpha-2"; private final Tracer tracer = new Tracer(); private final CommandSpec commandSpec; @@ -4710,6 +4714,28 @@

      23.5. Source

      return this; } + /** Returns whether the parser accepts clustered short options. The default is {@code true}. + * @return {@code true} if short options like {@code -x -v -f SomeFile} can be clustered together like {@code -xvfSomeFile}, {@code false} otherwise + * @since 3.0 */ + public boolean isPosixClusteredShortOptionsAllowed() { return getCommandSpec().parser().posixClusteredShortOptionsAllowed(); } + + /** Sets whether short options like {@code -x -v -f SomeFile} can be clustered together like {@code -xvfSomeFile}. + * <p>The specified setting will be registered with this {@code CommandLine} and the full hierarchy of its + * subcommands and nested sub-subcommands <em>at the moment this method is called</em>. Subcommands added + * later will have the default setting. To ensure a setting is applied to all + * subcommands, call the setter last, after adding subcommands.</p> + * @param newValue the new setting + * @return this {@code CommandLine} object, to allow method chaining + * @since 3.0 + */ + public CommandLine setPosixClusteredShortOptionsAllowed(boolean newValue) { + getCommandSpec().parser().posixClusteredShortOptionsAllowed(newValue); + for (CommandLine command : getCommandSpec().subcommands().values()) { + command.setPosixClusteredShortOptionsAllowed(newValue); + } + return this; + } + /** Returns whether the parser interprets the first positional parameter as "end of options" so the remaining * arguments are all treated as positional parameters. The default is {@code false}. * @return {@code true} if all values following the first positional parameter should be treated as positional parameters, {@code false} otherwise @@ -4901,9 +4927,9 @@

      23.5. Source

      * Represents a function that can process the {@code ParseResult} object resulting from successfully * {@linkplain #parseArgs(String...) parsing} the command line arguments. This is a * <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/package-summary.html">functional interface</a> - * whose functional method is {@link IParseResultHandler2#handleParseResult(CommandLine.ParseResult, Object)}. + * whose functional method is {@link IParseResultHandler2#handleParseResult(CommandLine.ParseResult)}. * <p> - * Implementations of this function can be passed to the {@link #parseWithHandlers(IParseResultHandler2, Object, IExceptionHandler2, String...) CommandLine::parseWithHandlers} + * Implementations of this function can be passed to the {@link #parseWithHandlers(IParseResultHandler2, IExceptionHandler2, String...) CommandLine::parseWithHandlers} * methods to take some next step after the command line was successfully parsed. * </p><p> * This interface replaces the {@link IParseResultHandler} interface; it takes the parse result as a {@code ParseResult} @@ -4919,16 +4945,12 @@

      23.5. Source

      /** Processes the {@code ParseResult} object resulting from successfully * {@linkplain CommandLine#parseArgs(String...) parsing} the command line arguments and returns a return value. * @param parseResult the {@code ParseResult} that resulted from successfully parsing the command line arguments - * @param prototypeReturnValue prototype return value, may be returned as is when the user requested help for example, - * or may be used to collect results from multiple subcommands, or may be used by the - * handler for internal processing and a completely different object is returned - * @return an object resulting from handling the parse result * @throws ParameterException if a help command was invoked for an unknown subcommand. Any {@code ParameterExceptions} * thrown from this method are treated as if this exception was thrown during parsing and passed to the {@link IExceptionHandler2} * @throws ExecutionException if a problem occurred while processing the parse results; use * {@link ExecutionException#getCommandLine()} to get the command or subcommand where processing failed */ - R handleParseResult(ParseResult parseResult, R prototypeReturnValue) throws ExecutionException; + R handleParseResult(ParseResult parseResult) throws ExecutionException; } /** * Represents a function that can handle a {@code ParameterException} that occurred while @@ -4959,7 +4981,7 @@

      23.5. Source

      * and {@code ExecutionExceptions} that occurred while executing the {@code Runnable} or {@code Callable} command. * <p> * Implementations of this interface can be passed to the - * {@link #parseWithHandlers(IParseResultHandler2, Object, IExceptionHandler2, String...) CommandLine::parseWithHandlers} method. + * {@link #parseWithHandlers(IParseResultHandler2, IExceptionHandler2, String...) CommandLine::parseWithHandlers} method. * </p><p> * This interface replaces the {@link IParseResultHandler} interface. * </p> @@ -4971,22 +4993,18 @@

      23.5. Source

      * line arguments and optionally returns a list of results. * @param ex the ParameterException describing the problem that occurred while parsing the command line arguments, * and the CommandLine representing the command or subcommand whose input was invalid - * @param prototypeReturnValue prototype return value, may be returned as is or may be used by the - * handler for internal processing and a completely different object is returned * @param args the command line arguments that could not be parsed * @return an object resulting from handling the exception */       - R handleParseException(ParameterException ex, R prototypeReturnValue, String[] args); + R handleParseException(ParameterException ex, String[] args); /** Handles a {@code ExecutionException} that occurred while executing the {@code Runnable} or * {@code Callable} command and optionally returns a list of results. * @param ex the ExecutionException describing the problem that occurred while executing the {@code Runnable} or * {@code Callable} command, and the CommandLine representing the command or subcommand that was being executed - * @param prototypeReturnValue prototype return value, may be returned as is or may be used by the - * handler for internal processing and a completely different object is returned * @param parseResult the result of parsing the command line arguments * @return an object resulting from handling the exception */ - R handleExecutionException(ExecutionException ex, R prototypeReturnValue, ParseResult parseResult); + R handleExecutionException(ExecutionException ex, ParseResult parseResult); } /** Abstract superclass for {@link IParseResultHandler2} and {@link IExceptionHandler2} implementations. @@ -5073,12 +5091,11 @@

      23.5. Source

      * whose input was invalid, to the stream returned by {@link #err()}. * @param ex the ParameterException describing the problem that occurred while parsing the command line arguments, * and the CommandLine representing the command or subcommand whose input was invalid - * @param prototypeReturnValue prototype return value, returned as is unless an exit code is set * @param args the command line arguments that could not be parsed * @return the empty list * @since 3.0 */       - public R handleParseException(ParameterException ex, R prototypeReturnValue, String[] args) { - internalHandleParseException(ex, err(), ansi(), args); return returnResultOrExit(prototypeReturnValue); } + public R handleParseException(ParameterException ex, String[] args) { + internalHandleParseException(ex, err(), ansi(), args); return returnResultOrExit(null); } private void internalHandleParseException(ParameterException ex, PrintStream out, Help.Ansi ansi, String[] args) { out.println(ex.getMessage()); @@ -5087,14 +5104,15 @@

      23.5. Source

      /** This implementation always simply rethrows the specified exception. * @param ex the ExecutionException describing the problem that occurred while executing the {@code Runnable} or {@code Callable} command - * @param prototypeReturnValue ignored * @param parseResult the result of parsing the command line arguments * @return nothing: this method always rethrows the specified exception * @throws ExecutionException always rethrows the specified exception * @since 3.0 */ - public R handleExecutionException(ExecutionException ex, R prototypeReturnValue, ParseResult parseResult) { throw ex; } + public R handleExecutionException(ExecutionException ex, ParseResult parseResult) { throw ex; } @Override protected DefaultExceptionHandler<R> self() { return this; } } + /** Convenience method that returns {@code new DefaultExceptionHandler<List<Object>>()}. */ + public static DefaultExceptionHandler<List<Object>> defaultExceptionHandler() { return new DefaultExceptionHandler<List<Object>>(); } /** @deprecated use {@link #printHelpIfRequested(List, PrintStream, PrintStream, Help.Ansi)} instead * @since 2.0 */ @@ -5180,7 +5198,7 @@

      23.5. Source

      throw new ExecutionException(parsed, "Parsed command (" + command + ") is not Runnable or Callable"); } /** Command line parse result handler that returns a value. This handler prints help if requested, and otherwise calls - * {@link #handle(CommandLine.ParseResult, Object)} with the parse result. Facilitates implementation of the {@link IParseResultHandler2} interface. + * {@link #handle(CommandLine.ParseResult)} with the parse result. Facilitates implementation of the {@link IParseResultHandler2} interface. * <p>Note that {@code AbstractParseResultHandler} is a generic type. This, along with the abstract {@code self} method, * allows method chaining to work properly in subclasses, without the need for casts. An example subclass can look like this:</p> * <pre>{@code @@ -5193,24 +5211,21 @@

      23.5. Source

      * }</pre> * @since 3.0 */       public abstract static class AbstractParseResultHandler<R> extends AbstractHandler<R, AbstractParseResultHandler<R>> implements IParseResultHandler2<R> { - /** Prints help if requested, and otherwise calls {@link #handle(CommandLine.ParseResult, Object)}. + /** Prints help if requested, and otherwise calls {@link #handle(CommandLine.ParseResult)}. * Finally, either a list of result objects is returned, or the JVM is terminated if an exit code {@linkplain #andExit(int) was set}. * * @param parseResult the {@code ParseResult} that resulted from successfully parsing the command line arguments - * @param prototypeReturnValue prototype return value, may be returned as is when the user requested help for example, - * or may be used to collect results from multiple subcommands, or may be used by the - * handler for internal processing and a completely different object is returned * @return the result of processing parse results, may be the specified prototype or some other object * @throws ParameterException if the {@link HelpCommand HelpCommand} was invoked for an unknown subcommand. Any {@code ParameterExceptions} * thrown from this method are treated as if this exception was thrown during parsing and passed to the {@link IExceptionHandler2} * @throws ExecutionException if a problem occurred while processing the parse results; client code can use * {@link ExecutionException#getCommandLine()} to get the command or subcommand where processing failed */ - public R handleParseResult(ParseResult parseResult, R prototypeReturnValue) throws ExecutionException { + public R handleParseResult(ParseResult parseResult) throws ExecutionException { if (printHelpIfRequested(parseResult.asCommandLineList(), out(), err(), ansi())) { - return returnResultOrExit(prototypeReturnValue); + return returnResultOrExit(null); } - return returnResultOrExit(handle(parseResult, prototypeReturnValue)); + return returnResultOrExit(handle(parseResult)); } /** Processes the specified {@code ParseResult} and returns the result as a list of objects. @@ -5218,59 +5233,16 @@

      23.5. Source

      * rethrowing an {@code ExecutionException} that details the problem and captures the offending {@code CommandLine} object. * * @param parseResult the {@code ParseResult} that resulted from successfully parsing the command line arguments - * @param prototypeReturnValue prototype return value, may be returned as is when the user requested help for example, - * or may be used to collect results from multiple subcommands, or may be used by the - * handler for internal processing and a completely different object is returned * @return the result of processing parse results, may be the specified prototype or some other object * @throws ExecutionException if a problem occurred while processing the parse results; client code can use * {@link ExecutionException#getCommandLine()} to get the command or subcommand where processing failed */       - protected abstract R handle(ParseResult parseResult, R prototypeReturnValue) throws ExecutionException; + protected abstract R handle(ParseResult parseResult) throws ExecutionException; } - /** Command line parse result handler that does not return a result. Prints help if requested, and otherwise calls - * {@link #handle(CommandLine.ParseResult)} with the parse result. Facilitates implementation of the {@link IParseResultHandler2} interface. - * <p>An example subclass can look like this:</p> - * <pre>{@code - * class MyResultHandler extends AbstractSimpleParseResultHandler { - * protected void handle(ParseResult parseResult) throws ExecutionException { ... } - * } - * }</pre> - * @since 3.0 */ - public abstract static class AbstractSimpleParseResultHandler extends AbstractHandler<Void, AbstractSimpleParseResultHandler> implements IParseResultHandler2<Void> { - /** Prints help if requested, and otherwise calls {@link #handle(CommandLine.ParseResult)}. - * Finally, either a list of result objects is returned, or the JVM is terminated if an exit code {@linkplain #andExit(int) was set}. - * - * @param parseResult the {@code ParseResult} that resulted from successfully parsing the command line arguments - * @param ignored value returned as is - * @return the specified return value - * @throws ParameterException if the {@link HelpCommand HelpCommand} was invoked for an unknown subcommand. Any {@code ParameterExceptions} - * thrown from this method are treated as if this exception was thrown during parsing and passed to the {@link IExceptionHandler2} - * @throws ExecutionException if a problem occurred while processing the parse results; client code can use - * {@link ExecutionException#getCommandLine()} to get the command or subcommand where processing failed - */ - public Void handleParseResult(ParseResult parseResult, Void ignored) throws ExecutionException { - if (printHelpIfRequested(parseResult.asCommandLineList(), out(), err(), ansi())) { - return returnResultOrExit(ignored); - } - handle(parseResult); - return returnResultOrExit(ignored); - } - /** Processes the specified {@code ParseResult}. - * Implementations are responsible for catching any exceptions thrown in the {@code handle} method, and - * rethrowing an {@code ExecutionException} that details the problem and captures the offending {@code CommandLine} object. - * - * @param parseResult the {@code ParseResult} that resulted from successfully parsing the command line arguments - * @throws ExecutionException if a problem occurred while processing the parse results; client code can use - * {@link ExecutionException#getCommandLine()} to get the command or subcommand where processing failed - */ - protected abstract void handle(ParseResult parseResult) throws ExecutionException; - @Override protected AbstractSimpleParseResultHandler self() { return this; } - } - /** * Command line parse result handler that prints help if requested, and otherwise executes the top-level * {@code Runnable} or {@code Callable} command. - * For use in the {@link #parseWithHandlers(IParseResultHandler2, Object, IExceptionHandler2, String...) parseWithHandler} methods. + * For use in the {@link #parseWithHandlers(IParseResultHandler2, IExceptionHandler2, String...) parseWithHandler} methods. * @since 2.0 */ public static class RunFirst extends AbstractParseResultHandler<List<Object>> implements IParseResultHandler { /** Prints help if requested, and otherwise executes the top-level {@code Runnable} or {@code Callable} command. @@ -5302,7 +5274,7 @@

      23.5. Source

      * @throws ExecutionException if a problem occurred while processing the parse results; use * {@link ExecutionException#getCommandLine()} to get the command or subcommand where processing failed * @since 3.0 */       - protected List<Object> handle(ParseResult parseResult, List<Object> prototypeResult) throws ExecutionException { + protected List<Object> handle(ParseResult parseResult) throws ExecutionException { return execute(parseResult.commandSpec().commandLine(), new ArrayList<Object>()); // first } @Override protected RunFirst self() { return this; } @@ -5310,7 +5282,7 @@

      23.5. Source

      /** * Command line parse result handler that prints help if requested, and otherwise executes the most specific * {@code Runnable} or {@code Callable} subcommand. - * For use in the {@link #parseWithHandlers(IParseResultHandler2, Object, IExceptionHandler2, String...) parseWithHandler} methods. + * For use in the {@link #parseWithHandlers(IParseResultHandler2, IExceptionHandler2, String...) parseWithHandler} methods. * <p> * Something like this:</p> * <pre>{@code @@ -5375,16 +5347,16 @@

      23.5. Source

      * @throws ExecutionException if a problem occurred while processing the parse results; use * {@link ExecutionException#getCommandLine()} to get the command or subcommand where processing failed * @since 3.0 */       - protected List<Object> handle(ParseResult parseResult, List<Object> prototypeResult) throws ExecutionException { + protected List<Object> handle(ParseResult parseResult) throws ExecutionException { List<CommandLine> parsedCommands = parseResult.asCommandLineList(); - return execute(parsedCommands.get(parsedCommands.size() - 1), prototypeResult); + return execute(parsedCommands.get(parsedCommands.size() - 1), new ArrayList<Object>()); } @Override protected RunLast self() { return this; } } /** * Command line parse result handler that prints help if requested, and otherwise executes the top-level command and * all subcommands as {@code Runnable} or {@code Callable}. - * For use in the {@link #parseWithHandlers(IParseResultHandler2, Object, IExceptionHandler2, String...) parseWithHandler} methods. + * For use in the {@link #parseWithHandlers(IParseResultHandler2, IExceptionHandler2, String...) parseWithHandler} methods. * @since 2.0 */ public static class RunAll extends AbstractParseResultHandler<List<Object>> implements IParseResultHandler { /** Prints help if requested, and otherwise executes the top-level command and all subcommands as {@code Runnable} @@ -5421,7 +5393,8 @@

      23.5. Source

      * @throws ExecutionException if a problem occurred while processing the parse results; use * {@link ExecutionException#getCommandLine()} to get the command or subcommand where processing failed * @since 3.0 */       - protected List<Object> handle(ParseResult parseResult, List<Object> prototypeResult) throws ExecutionException { + protected List<Object> handle(ParseResult parseResult) throws ExecutionException { + List<Object> prototypeResult = new ArrayList<Object>(); execute(parseResult.commandSpec().commandLine(), prototypeResult); while (parseResult.hasSubcommand()) { parseResult = parseResult.subcommand(); @@ -5432,13 +5405,13 @@

      23.5. Source

      @Override protected RunAll self() { return this; } } - /** @deprecated use {@link #parseWithHandler(IParseResultHandler2, Object, String[])} instead + /** @deprecated use {@link #parseWithHandler(IParseResultHandler2, String[])} instead * @since 2.0 */ @Deprecated public List<Object> parseWithHandler(IParseResultHandler handler, PrintStream out, String... args) { return parseWithHandlers(handler, out, Help.Ansi.AUTO, new DefaultExceptionHandler(), args); } /** - * Returns the result of calling {@link #parseWithHandlers(IParseResultHandler2, Object, IExceptionHandler2, String...)} with + * Returns the result of calling {@link #parseWithHandlers(IParseResultHandler2, IExceptionHandler2, String...)} with * a new {@link DefaultExceptionHandler} in addition to the specified parse result handler and the specified command line arguments. * <p> * This is a convenience method intended to offer the same ease of use as the {@link #run(Runnable, PrintStream, PrintStream, Help.Ansi, String...) run} @@ -5449,9 +5422,9 @@

      23.5. Source

      * <pre>{@code * try { * ParseResult parseResult = parseArgs(args); - * return handler.handleParseResult(parseResult, prototypeReturnValue); + * return handler.handleParseResult(parseResult); * } catch (ParameterException ex) { - * return new DefaultExceptionHandler<R>().handleParseException(ex, prototypeReturnValue, args); + * return new DefaultExceptionHandler<R>().handleParseException(ex, args); * } * }</pre> * <p> @@ -5466,9 +5439,6 @@

      23.5. Source

      * </ul> * @param <R> the return type of this handler * @param handler the function that will handle the result of successfully parsing the command line arguments - * @param prototypeReturnValue prototype return value, may be returned as is when the user requested help for example, - * or may be used to collect results from multiple subcommands, or may be used by the - * handler for internal processing and a completely different object is returned * @param args the command line arguments * @return an object resulting from handling the parse result or the exception that occurred while parsing the input * @throws ExecutionException if the command line arguments were parsed successfully but a problem occurred while processing the @@ -5476,31 +5446,11 @@

      23.5. Source

      * @see RunLast * @see RunAll * @since 3.0 */       - public <R> R parseWithHandler(IParseResultHandler2<R> handler, R prototypeReturnValue, String[] args) { - return parseWithHandlers(handler, prototypeReturnValue, new DefaultExceptionHandler<R>(), args); - } - /** - * Calls {@link #parseWithSimpleHandlers(AbstractSimpleParseResultHandler, IExceptionHandler2, String...)} with - * a new {@link DefaultExceptionHandler} in addition to the specified parse result handler and the specified command line arguments. - * <p>Calling this method roughly expands to:</p> - * <pre>{@code - * try { - * ParseResult parseResult = parseArgs(args); - * handler.handleParseResult(parseResult); - * } catch (ParameterException ex) { - * new DefaultExceptionHandler<Void>().handleParseException(ex, null, (String[]) args); - * } - * }</pre> - * @param handler the function that will handle the result of successfully parsing the command line arguments - * @param args the command line arguments - * @throws ExecutionException if the command line arguments were parsed successfully but a problem occurred while processing the - * parse results; use {@link ExecutionException#getCommandLine()} to get the command or subcommand where processing failed - * @since 3.0 */ - public void parseWithSimpleHandler(AbstractSimpleParseResultHandler handler, String... args) { - parseWithSimpleHandlers(handler, new DefaultExceptionHandler<Void>(), args); + public <R> R parseWithHandler(IParseResultHandler2<R> handler, String[] args) { + return parseWithHandlers(handler, new DefaultExceptionHandler<R>(), args); } - /** @deprecated use {@link #parseWithHandlers(IParseResultHandler2, Object, IExceptionHandler2, String...)} instead + /** @deprecated use {@link #parseWithHandlers(IParseResultHandler2, IExceptionHandler2, String...)} instead * @since 2.0 */ @Deprecated public List<Object> parseWithHandlers(IParseResultHandler handler, PrintStream out, Help.Ansi ansi, IExceptionHandler exceptionHandler, String... args) { try { @@ -5544,9 +5494,6 @@

      23.5. Source

      * </ul> * * @param handler the function that will handle the result of successfully parsing the command line arguments - * @param prototypeReturnValue prototype return value, may be returned as is when the user requested help for example, - * or may be used to collect results from multiple subcommands, or may be used by the - * handler for internal processing and a completely different object is returned * @param exceptionHandler the function that can handle the {@code ParameterException} thrown when the command line arguments are invalid * @param args the command line arguments * @return an object resulting from handling the parse result or the exception that occurred while parsing the input @@ -5557,51 +5504,15 @@

      23.5. Source

      * @see RunAll * @see DefaultExceptionHandler * @since 3.0 */       - public <R> R parseWithHandlers(IParseResultHandler2<R> handler, R prototypeReturnValue, IExceptionHandler2<R> exceptionHandler, String... args) { + public <R> R parseWithHandlers(IParseResultHandler2<R> handler, IExceptionHandler2<R> exceptionHandler, String... args) { ParseResult parseResult = null; try { parseResult = parseArgs(args); - return handler.handleParseResult(parseResult, prototypeReturnValue); + return handler.handleParseResult(parseResult); } catch (ParameterException ex) { - return exceptionHandler.handleParseException(ex, prototypeReturnValue, (String[]) args); + return exceptionHandler.handleParseException(ex, (String[]) args); } catch (ExecutionException ex) { - return exceptionHandler.handleExecutionException(ex, prototypeReturnValue, parseResult); - } - } - /** - * Tries to {@linkplain #parseArgs(String...) parse} the specified command line arguments, and if successful, delegates - * the processing of the resulting {@code ParseResult} object to the specified {@linkplain AbstractSimpleParseResultHandler handler}. - * If the command line arguments were invalid, the {@code ParameterException} thrown from the {@code parse} method - * is caught and passed to the specified {@link IExceptionHandler2}. - * <p>Calling this method roughly expands to:</p> - * <pre> - * ParseResult parseResult = null; - * try { - * parseResult = parseArgs(args); - * handleParseResult(parseResult); - * } catch (ParameterException ex) { - * exceptionHandler.handleParseException(ex, null, (String[]) args); - * } catch (ExecutionException ex) { - * exceptionHandler.handleExecutionException(ex, null, parseResult); - * } - * </pre> - * - * @param handler the function that will handle the result of successfully parsing the command line arguments - * @param exceptionHandler the function that can handle the {@code ParameterException} thrown when the command line arguments are invalid - * @param args the command line arguments - * @throws ExecutionException if the command line arguments were parsed successfully but a problem occurred while processing the parse - * result {@code ParseResult} object; use {@link ExecutionException#getCommandLine()} to get the command or subcommand where processing failed - * @see DefaultExceptionHandler - * @since 3.0 */ - public void parseWithSimpleHandlers(AbstractSimpleParseResultHandler handler, IExceptionHandler2<Void> exceptionHandler, String... args) { - ParseResult parseResult = null; - try { - parseResult = parseArgs(args); - handler.handleParseResult(parseResult, null); - } catch (ParameterException ex) { - exceptionHandler.handleParseException(ex, null, (String[]) args); - } catch (ExecutionException ex) { - exceptionHandler.handleExecutionException(ex, null, parseResult); + return exceptionHandler.handleExecutionException(ex, parseResult); } } /** @@ -5643,9 +5554,13 @@

      23.5. Source

      * @param out the printStream to print to * @see #usage(PrintStream, Help.ColorScheme) */       - public void usage(PrintStream out) { - usage(out, Help.Ansi.AUTO); - } + public void usage(PrintStream out) { usage(out, Help.Ansi.AUTO); } + /** + * Delegates to {@link #usage(PrintWriter, Help.Ansi)} with the {@linkplain Help.Ansi#AUTO platform default}. + * @param writer the PrintWriter to print to + * @see #usage(PrintWriter, Help.ColorScheme) + * @since 3.0 */ + public void usage(PrintWriter writer) { usage(writer, Help.Ansi.AUTO); } /** * Delegates to {@link #usage(PrintStream, Help.ColorScheme)} with the {@linkplain Help#defaultColorScheme(CommandLine.Help.Ansi) default color scheme}. @@ -5653,9 +5568,11 @@

      23.5. Source

      * @param ansi whether the usage message should include ANSI escape codes or not * @see #usage(PrintStream, Help.ColorScheme) */       - public void usage(PrintStream out, Help.Ansi ansi) { - usage(out, Help.defaultColorScheme(ansi)); - } + public void usage(PrintStream out, Help.Ansi ansi) { usage(out, Help.defaultColorScheme(ansi)); } + /** Similar to {@link #usage(PrintStream, Help.Ansi)} but with the specified {@code PrintWriter} instead of a {@code PrintStream}. + * @since 3.0 */ + public void usage(PrintWriter writer, Help.Ansi ansi) { usage(writer, Help.defaultColorScheme(ansi)); } + /** * Prints a usage help message for the annotated command class to the specified {@code PrintStream}. * Delegates construction of the usage help message to the {@link Help} inner class and is equivalent to: @@ -5689,9 +5606,15 @@

      23.5. Source

      * @param colorScheme the {@code ColorScheme} defining the styles for options, parameters and commands when ANSI is enabled */       public void usage(PrintStream out, Help.ColorScheme colorScheme) { - Help help = new Help(getCommandSpec(), colorScheme); - StringBuilder sb = new StringBuilder() - .append(help.headerHeading()) + out.print(usage(new StringBuilder(), new Help(getCommandSpec(), colorScheme))); + } + /** Similar to {@link #usage(PrintStream, Help.ColorScheme)}, but with the specified {@code PrintWriter} instead of a {@code PrintStream}. + * @since 3.0 */ + public void usage(PrintWriter writer, Help.ColorScheme colorScheme) { + writer.print(usage(new StringBuilder(), new Help(getCommandSpec(), colorScheme))); + } + private static StringBuilder usage(StringBuilder sb, Help help) { + return sb.append(help.headerHeading()) .append(help.header()) .append(help.synopsisHeading()) //e.g. Usage: .append(help.synopsis(help.synopsisHeadingLength())) //e.g. &lt;main class&gt; [OPTIONS] &lt;command&gt; [COMMAND-OPTIONS] [ARGUMENTS] @@ -5705,7 +5628,6 @@

      23.5. Source

      .append(help.commandList()) //e.g. add adds the frup to the frooble .append(help.footerHeading()) .append(help.footer()); - out.print(sb); } /** @@ -5762,7 +5684,7 @@

      23.5. Source

      * @throws InitializationException if the specified command object does not have a {@link Command}, {@link Option} or {@link Parameters} annotation * @throws ExecutionException if the Callable throws an exception * @return {@code null} if an error occurred while parsing the command line options, otherwise returns the result of calling the Callable - * @see #parseWithHandlers(IParseResultHandler2, Object, IExceptionHandler2, String...) + * @see #parseWithHandlers(IParseResultHandler2, IExceptionHandler2, String...) * @since 3.0 */       public static <C extends Callable<T>, T> T call(C callable, String... args) { @@ -5781,7 +5703,7 @@

      23.5. Source

      * @throws InitializationException if the specified command object does not have a {@link Command}, {@link Option} or {@link Parameters} annotation * @throws ExecutionException if the Callable throws an exception * @return {@code null} if an error occurred while parsing the command line options, otherwise returns the result of calling the Callable - * @see #parseWithHandlers(IParseResultHandler2, Object, IExceptionHandler2, String...) + * @see #parseWithHandlers(IParseResultHandler2, IExceptionHandler2, String...) * @see RunLast */       public static <C extends Callable<T>, T> T call(C callable, PrintStream out, String... args) { @@ -5799,7 +5721,7 @@

      23.5. Source

      * @throws InitializationException if the specified command object does not have a {@link Command}, {@link Option} or {@link Parameters} annotation * @throws ExecutionException if the Callable throws an exception * @return {@code null} if an error occurred while parsing the command line options, otherwise returns the result of calling the Callable - * @see #parseWithHandlers(IParseResultHandler2, Object, IExceptionHandler2, String...) + * @see #parseWithHandlers(IParseResultHandler2, IExceptionHandler2, String...) * @see RunLast */       public static <C extends Callable<T>, T> T call(C callable, PrintStream out, Help.Ansi ansi, String... args) { @@ -5819,7 +5741,7 @@

      23.5. Source

      * <p> * If the specified Callable command has subcommands, the {@linkplain RunLast last} subcommand specified on the * command line is executed. - * Commands with subcommands may be interested in calling the {@link #parseWithHandler(IParseResultHandler2, Object, String[]) parseWithHandler} + * Commands with subcommands may be interested in calling the {@link #parseWithHandler(IParseResultHandler2, String[]) parseWithHandler} * method with the {@link RunAll} handler or a custom handler. * </p> * @param callable the command to call when {@linkplain #parse(String...) parsing} succeeds. @@ -5832,13 +5754,13 @@

      23.5. Source

      * @throws InitializationException if the specified command object does not have a {@link Command}, {@link Option} or {@link Parameters} annotation * @throws ExecutionException if the Callable throws an exception * @return {@code null} if an error occurred while parsing the command line options, or if help was requested and printed. Otherwise returns the result of calling the Callable - * @see #parseWithHandlers(IParseResultHandler2, Object, IExceptionHandler2, String...) + * @see #parseWithHandlers(IParseResultHandler2, IExceptionHandler2, String...) * @see RunLast * @since 3.0 */       public static <C extends Callable<T>, T> T call(C callable, PrintStream out, PrintStream err, Help.Ansi ansi, String... args) { CommandLine cmd = new CommandLine(callable); - List<Object> results = cmd.parseWithHandlers(new RunLast().useOut(out).useAnsi(ansi), new ArrayList<Object>(), new DefaultExceptionHandler<List<Object>>().useErr(err).useAnsi(ansi), args); + List<Object> results = cmd.parseWithHandlers(new RunLast().useOut(out).useAnsi(ansi), new DefaultExceptionHandler<List<Object>>().useErr(err).useAnsi(ansi), args); @SuppressWarnings("unchecked") T result = results == null || results.isEmpty() ? null : (T) results.get(0); return result; } @@ -5852,7 +5774,7 @@

      23.5. Source

      * @see #run(Runnable, PrintStream, PrintStream, Help.Ansi, String...) * @throws InitializationException if the specified command object does not have a {@link Command}, {@link Option} or {@link Parameters} annotation * @throws ExecutionException if the Runnable throws an exception - * @see #parseWithHandlers(IParseResultHandler2, Object, IExceptionHandler2, String...) + * @see #parseWithHandlers(IParseResultHandler2, IExceptionHandler2, String...) * @see RunLast * @since 3.0 */ @@ -5869,7 +5791,7 @@

      23.5. Source

      * @see #run(Runnable, PrintStream, PrintStream, Help.Ansi, String...) * @throws InitializationException if the specified command object does not have a {@link Command}, {@link Option} or {@link Parameters} annotation * @throws ExecutionException if the Runnable throws an exception - * @see #parseWithHandler(IParseResultHandler2, Object, String[]) + * @see #parseWithHandler(IParseResultHandler2, String[]) * @see RunLast */ public static <R extends Runnable> void run(R runnable, PrintStream out, String... args) { @@ -5885,7 +5807,7 @@

      23.5. Source

      * @see #run(Runnable, PrintStream, PrintStream, Help.Ansi, String...) * @throws InitializationException if the specified command object does not have a {@link Command}, {@link Option} or {@link Parameters} annotation * @throws ExecutionException if the Runnable throws an exception - * @see #parseWithHandlers(IParseResultHandler2, Object, IExceptionHandler2, String...) + * @see #parseWithHandlers(IParseResultHandler2, IExceptionHandler2, String...) * @see RunLast */ public static <R extends Runnable> void run(R runnable, PrintStream out, Help.Ansi ansi, String... args) { @@ -5903,7 +5825,7 @@

      23.5. Source

      * <p> * If the specified Runnable command has subcommands, the {@linkplain RunLast last} subcommand specified on the * command line is executed. - * Commands with subcommands may be interested in calling the {@link #parseWithHandler(IParseResultHandler2, Object, String[]) parseWithHandler} + * Commands with subcommands may be interested in calling the {@link #parseWithHandler(IParseResultHandler2, String[]) parseWithHandler} * method with the {@link RunAll} handler or a custom handler. * </p><p> * From picocli v2.0, this method prints usage help or version help if {@linkplain #printHelpIfRequested(List, PrintStream, PrintStream, Help.Ansi) requested}, @@ -5917,13 +5839,13 @@

      23.5. Source

      * @param <R> the annotated object must implement Runnable * @throws InitializationException if the specified command object does not have a {@link Command}, {@link Option} or {@link Parameters} annotation * @throws ExecutionException if the Runnable throws an exception - * @see #parseWithHandlers(IParseResultHandler2, Object, IExceptionHandler2, String...) + * @see #parseWithHandlers(IParseResultHandler2, IExceptionHandler2, String...) * @see RunLast * @since 3.0 */ public static <R extends Runnable> void run(R runnable, PrintStream out, PrintStream err, Help.Ansi ansi, String... args) { CommandLine cmd = new CommandLine(runnable); - cmd.parseWithHandlers(new RunLast().useOut(out).useAnsi(ansi), new ArrayList<Object>(), new DefaultExceptionHandler<List<Object>>().useErr(err).useAnsi(ansi), args); + cmd.parseWithHandlers(new RunLast().useOut(out).useAnsi(ansi), new DefaultExceptionHandler<List<Object>>().useErr(err).useAnsi(ansi), args); } /** @@ -7554,16 +7476,18 @@

      23.5. Source

      private boolean overwrittenOptionsAllowed = false; private boolean unmatchedArgumentsAllowed = false; private boolean expandAtFiles = true; + private boolean posixClusteredShortOptionsAllowed = true; /** Returns the String to use as the separator between options and option parameters. {@code "="} by default, * initialized from {@link Command#separator()} if defined.*/ public String separator() { return (separator == null) ? DEFAULT_SEPARATOR : separator; } - public boolean stopAtUnmatched() { return stopAtUnmatched; } - public boolean stopAtPositional() { return stopAtPositional; } - public boolean overwrittenOptionsAllowed() { return overwrittenOptionsAllowed; } - public boolean unmatchedArgumentsAllowed() { return unmatchedArgumentsAllowed; } - public boolean expandAtFiles() { return expandAtFiles; } + public boolean stopAtUnmatched() { return stopAtUnmatched; } + public boolean stopAtPositional() { return stopAtPositional; } + public boolean overwrittenOptionsAllowed() { return overwrittenOptionsAllowed; } + public boolean unmatchedArgumentsAllowed() { return unmatchedArgumentsAllowed; } + public boolean expandAtFiles() { return expandAtFiles; } + public boolean posixClusteredShortOptionsAllowed() { return posixClusteredShortOptionsAllowed; } /** Sets the String to use as the separator between options and option parameters. * @return this ParserSpec for method chaining */ @@ -7573,7 +7497,12 @@

      23.5. Source

      public ParserSpec overwrittenOptionsAllowed(boolean overwrittenOptionsAllowed) { this.overwrittenOptionsAllowed = overwrittenOptionsAllowed; return this; } public ParserSpec unmatchedArgumentsAllowed(boolean unmatchedArgumentsAllowed) { this.unmatchedArgumentsAllowed = unmatchedArgumentsAllowed; return this; } public ParserSpec expandAtFiles(boolean expandAtFiles) { this.expandAtFiles = expandAtFiles; return this; } - void initSeparator(String value) { if (initializable(separator, value, DEFAULT_SEPARATOR)) {separator = value;} } + public ParserSpec posixClusteredShortOptionsAllowed(boolean posixClusteredShortOptionsAllowed) { this.posixClusteredShortOptionsAllowed = posixClusteredShortOptionsAllowed; return this; } + void initSeparator(String value) { if (initializable(separator, value, DEFAULT_SEPARATOR)) {separator = value;} } + public String toString() { + return String.format("posixClusteredShortOptionsAllowed=%s, stopAtPositional=%s, stopAtUnmatched=%s, separator=%s, overwrittenOptionsAllowed=%s, unmatchedArgumentsAllowed=%s, expandAtFiles=%s", + posixClusteredShortOptionsAllowed, stopAtPositional, stopAtUnmatched, separator, overwrittenOptionsAllowed, unmatchedArgumentsAllowed, expandAtFiles); + } } /** Models the shared attributes of {@link OptionSpec} and {@link PositionalParamSpec}. * @since 3.0 */ @@ -8735,6 +8664,7 @@

      23.5. Source

      List<CommandLine> parse(String... args) { Assert.notNull(args, "argument array"); if (tracer.isInfo()) {tracer.info("Parsing %d command line args %s%n", args.length, Arrays.toString(args));} + if (tracer.isDebug()){tracer.debug("Parser configuration: %s%n", config());} List<String> expanded = new ArrayList<String>(); for (String arg : args) { addOrExpand(arg, expanded, new LinkedHashSet<String>()); } Stack<String> arguments = new Stack<String>(); @@ -8906,7 +8836,7 @@

      23.5. Source

      } // Compact (single-letter) options can be grouped with other options or with an argument. // only single-letter options can be combined with other options or with an argument - else if (arg.length() > 2 && arg.startsWith("-")) { + else if (config().posixClusteredShortOptionsAllowed() && arg.length() > 2 && arg.startsWith("-")) { if (tracer.isDebug()) {tracer.debug("Trying to process '%s' as clustered short options%n", arg, args);} processClusteredShortOptions(required, initialized, arg, args); } @@ -11685,8 +11615,8 @@

      23.5. Source

      diff --git a/docs/picocli-2.0-do-more-with-less.html b/docs/picocli-2.0-do-more-with-less.html index ec18688c8..707cc41a5 100644 --- a/docs/picocli-2.0-do-more-with-less.html +++ b/docs/picocli-2.0-do-more-with-less.html @@ -899,7 +899,7 @@

      Conclusion

      diff --git a/docs/picocli-2.0-groovy-scripts-on-steroids.html b/docs/picocli-2.0-groovy-scripts-on-steroids.html index 94c434b21..d24897efa 100644 --- a/docs/picocli-2.0-groovy-scripts-on-steroids.html +++ b/docs/picocli-2.0-groovy-scripts-on-steroids.html @@ -789,7 +789,7 @@

      Conclusion

      diff --git a/docs/picocli-3.0-programmatic-api.html b/docs/picocli-3.0-programmatic-api.html index fcf74c3bd..b1344846b 100644 --- a/docs/picocli-3.0-programmatic-api.html +++ b/docs/picocli-3.0-programmatic-api.html @@ -1043,7 +1043,7 @@

      4.2.2. Handlers with Return Value

      diff --git a/src/main/java/picocli/CommandLine.java b/src/main/java/picocli/CommandLine.java index 5cd371553..476142b40 100644 --- a/src/main/java/picocli/CommandLine.java +++ b/src/main/java/picocli/CommandLine.java @@ -134,7 +134,7 @@ */ public class CommandLine { /** This is picocli version {@value}. */ - public static final String VERSION = "3.0.0-alpha-2-SNAPSHOT"; + public static final String VERSION = "3.0.0-alpha-2"; private final Tracer tracer = new Tracer(); private final CommandSpec commandSpec; diff --git a/src/test/java/picocli/AutoCompleteTest.java b/src/test/java/picocli/AutoCompleteTest.java index d0d168e78..3ff8d1fb8 100644 --- a/src/test/java/picocli/AutoCompleteTest.java +++ b/src/test/java/picocli/AutoCompleteTest.java @@ -303,7 +303,7 @@ public void testAutoCompleteAppBothScriptFilesForceOverwrite() throws Exception "# =======================\n" + "#\n" + "# Bash completion support for the `picocli.AutoComplete` command,\n" + - "# generated by [picocli](http://picocli.info/) version 3.0.0-alpha-2-SNAPSHOT.\n" + + "# generated by [picocli](http://picocli.info/) version 3.0.0-alpha-2.\n" + "#\n" + "# Installation\n" + "# ------------\n" + diff --git a/src/test/java/picocli/CommandLineTest.java b/src/test/java/picocli/CommandLineTest.java index 84f4281af..10d333aae 100644 --- a/src/test/java/picocli/CommandLineTest.java +++ b/src/test/java/picocli/CommandLineTest.java @@ -154,7 +154,7 @@ class App { } } @Test public void testVersion() { - assertEquals("3.0.0-alpha-2-SNAPSHOT", CommandLine.VERSION); + assertEquals("3.0.0-alpha-2", CommandLine.VERSION); } @Test public void testArrayPositionalParametersAreAppendedNotReplaced() {