From 40b31ae43973800c83a58db8c68fba9da9128138 Mon Sep 17 00:00:00 2001 From: rpopma Date: Thu, 21 Dec 2017 21:10:07 +0900 Subject: [PATCH] Release picocli version 2.2 --- .../apidocs/picocli/CommandLine.IFactory.html | 239 ++++++++++++++++++ .../picocli/CommandLine.IVersionProvider.html | 235 +++++++++++++++++ .../picocli/CommandLine.ParentCommand.html | 195 ++++++++++++++ 3 files changed, 669 insertions(+) create mode 100644 docs/apidocs/picocli/CommandLine.IFactory.html create mode 100644 docs/apidocs/picocli/CommandLine.IVersionProvider.html create mode 100644 docs/apidocs/picocli/CommandLine.ParentCommand.html diff --git a/docs/apidocs/picocli/CommandLine.IFactory.html b/docs/apidocs/picocli/CommandLine.IFactory.html new file mode 100644 index 000000000..1569828ca --- /dev/null +++ b/docs/apidocs/picocli/CommandLine.IFactory.html @@ -0,0 +1,239 @@ + + + + + +CommandLine.IFactory (picocli 2.2.0 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
picocli
+

Interface CommandLine.IFactory

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      <K> Kcreate(java.lang.Class<K> cls) +
      Creates and returns an instance of the specified class.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        create

        +
        <K> K create(java.lang.Class<K> cls)
+      throws java.lang.Exception
        +
        Creates and returns an instance of the specified class.
        +
        +
        Type Parameters:
        +
        K - the type to instantiate
        +
        Parameters:
        +
        cls - the class to instantiate
        +
        Returns:
        +
        the new instance
        +
        Throws:
        +
        java.lang.Exception - an exception detailing what went wrong when creating the instance
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/apidocs/picocli/CommandLine.IVersionProvider.html b/docs/apidocs/picocli/CommandLine.IVersionProvider.html new file mode 100644 index 000000000..9435ca575 --- /dev/null +++ b/docs/apidocs/picocli/CommandLine.IVersionProvider.html @@ -0,0 +1,235 @@ + + + + + +CommandLine.IVersionProvider (picocli 2.2.0 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
picocli
+

Interface CommandLine.IVersionProvider

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    CommandLine
    +
    +
    +
    +
    public static interface CommandLine.IVersionProvider
    +
    Provides version information for a command. Commands may configure a provider with the + CommandLine.Command.versionProvider() annotation attribute.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getVersion

        +
        java.lang.String[] getVersion()
+                       throws java.lang.Exception
        +
        Returns version information for a command.
        +
        +
        Returns:
        +
        version information (each string in the array is displayed on a separate line)
        +
        Throws:
        +
        java.lang.Exception - an exception detailing what went wrong when obtaining version information
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/apidocs/picocli/CommandLine.ParentCommand.html b/docs/apidocs/picocli/CommandLine.ParentCommand.html new file mode 100644 index 000000000..7c4cf41f0 --- /dev/null +++ b/docs/apidocs/picocli/CommandLine.ParentCommand.html @@ -0,0 +1,195 @@ + + + + + +CommandLine.ParentCommand (picocli 2.2.0 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + +
+
picocli
+

Annotation Type CommandLine.ParentCommand

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+ @Target(value=FIELD)
+public static @interface CommandLine.ParentCommand
    +

    + Fields annotated with @ParentCommand will be initialized with the parent command of the current subcommand. + If the current command does not have a parent command, this annotation has no effect. +

    + Parent commands often define options that apply to all the subcommands. + This annotation offers a convenient way to inject a reference to the parent command into a subcommand, so the + subcommand can access its parent options. For example: + 

    + @Command(name = "top", subcommands = Sub.class)
+ class Top implements Runnable {
+
+     @Option(names = {"-d", "--directory"}, description = "this option applies to all subcommands")
+     File baseDirectory;
+
+     public void run() { System.out.println("Hello from top"); }
+ }
+
+ @Command(name = "sub")
+ class Sub implements Runnable {
+
+     @ParentCommand
+     private Top parent;
+
+     public void run() {
+         System.out.println("Subcommand: parent command 'directory' is " + parent.baseDirectory);
+     }
+ }
+
    +
    +
    Since:
    +
    2.2
    +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Element
    • +
+
+ + +
+ + +