picocli.shell.jline3

Class PicocliCommands.ClearScreen

java.lang.Object

picocli.shell.jline3.PicocliCommands.ClearScreen

All Implemented Interfaces:

java.util.concurrent.Callable<java.lang.Void>

Enclosing class:

PicocliCommands

public static class PicocliCommands.ClearScreen
extends java.lang.Object
implements java.util.concurrent.Callable<java.lang.Void>

Command that clears the screen.

WARNING: This subcommand needs a JLine Terminal to clear the screen. To accomplish this, construct the CommandLine with a PicocliCommandsFactory, and set the Terminal on that factory. For example:

 @Command(subcommands = PicocliCommands.ClearScreen.class)
 class MyApp //...

 PicocliCommandsFactory factory = new PicocliCommandsFactory();
 CommandLine cmd = new CommandLine(new MyApp(), factory);
 // create terminal
 factory.setTerminal(terminal);
 

Since:

4.6

Method Summary

Modifier and Type	Method and Description
java.lang.Void	call()

Methods inherited from class java.lang.Object

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

Method Detail

call

public java.lang.Void call()
                    throws java.io.IOException

Specified by:

call in interface java.util.concurrent.Callable<java.lang.Void>

Throws:

java.io.IOException