PicocliCommands.PicocliCommandsFactory (picocli 4.7.5 API)

java.lang.Object
- picocli.shell.jline3.PicocliCommands.PicocliCommandsFactory

All Implemented Interfaces:

CommandLine.IFactory

Enclosing class:

PicocliCommands
```
public static class PicocliCommands.PicocliCommandsFactory
extends Object
implements CommandLine.IFactory
```
Command factory that is necessary for applications that want the use the ClearScreen subcommand. It can be chained with other factories.
WARNING: If the application uses the ClearScreen subcommand, construct the CommandLine with a PicocliCommandsFactory, and set the Terminal on that factory. Applications need to call the setTerminal method with a Terminal; this will be passed to the ClearScreen subcommand. For example:
```
 PicocliCommandsFactory factory = new PicocliCommandsFactory();
 CommandLine cmd = new CommandLine(new MyApp(), factory);
 // create terminal
 factory.setTerminal(terminal);
 
```
Other factories can be chained by passing them in to the constructor like this:
```
 MyCustomFactory customFactory = createCustomFactory(); // your application custom factory
 PicocliCommandsFactory factory = new PicocliCommandsFactory(customFactory); // chain the factories
 
```
Since:

4.6

Constructor Summary

Constructors
Constructor Description

PicocliCommandsFactory()

PicocliCommandsFactory(CommandLine.IFactory nextFactory)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`<K> K`	`create(Class<K> clazz)`	Returns an instance of the specified class.
`void`	`setTerminal(org.jline.terminal.Terminal terminal)`

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

- Constructor Detail
  - PicocliCommandsFactory
```
public PicocliCommandsFactory()
```
  - PicocliCommandsFactory
```
public PicocliCommandsFactory(CommandLine.IFactory nextFactory)
```
- Method Detail
  - create
```
public <K> K create(Class<K> clazz)
             throws Exception
```
    Description copied from interface: CommandLine.IFactory
    
    Returns an instance of the specified class.
    
    Specified by:
    
    create in interface CommandLine.IFactory
    
    Type Parameters:
    
    K - the type of the object to return
    
    Parameters:
    
    clazz - the class of the object to return
    
    Returns:
    
    the instance
    
    Throws:
    
    Exception - an exception detailing what went wrong when creating or obtaining the instance
  - setTerminal
```
public void setTerminal(org.jline.terminal.Terminal terminal)
```