Help (Apache Parquet Command-line 1.13.1 API)

java.lang.Object
- org.apache.parquet.cli.Help

All Implemented Interfaces:: Command

public class Help
extends Object
implements Command

Constructor Summary

Constructors
Constructor Description

Help(com.beust.jcommander.JCommander jc, org.slf4j.Logger console)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<String>`	`getExamples()`	Returns a list of example uses.
`void`	`printGenericHelp()`
`int`	`run()`	Runs this `Command`.
`void`	`setProgramName(String programName)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Help
```
public Help(com.beust.jcommander.JCommander jc,
            org.slf4j.Logger console)
```
- Method Detail
  - setProgramName
```
public void setProgramName(String programName)
```
  - run
```
public int run()
```
    Description copied from interface: Command
    
    Runs this Command.
    
    Specified by:
    
    run in interface Command
    
    Returns:
    
    a return code for the process, 0 indicates success.
  - printGenericHelp
```
public void printGenericHelp()
```
  - getExamples
```
public List<String> getExamples()
```
    Description copied from interface: Command
    
    Returns a list of example uses. Lines starting with '#' will not have the executable name added when formatting.
    
    Specified by:
    
    getExamples in interface Command
    
    Returns:
    
    a list of String examples