com.aspectran.shell.command.builtins.ClearCommand Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2022 The Aspectran Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.aspectran.shell.command.builtins;
import com.aspectran.shell.command.AbstractCommand;
import com.aspectran.shell.command.CommandRegistry;
import com.aspectran.shell.command.option.Option;
import com.aspectran.shell.command.option.ParsedOptions;
import com.aspectran.shell.console.Console;
/**
* Clear the terminal screen.
*/
public class ClearCommand extends AbstractCommand {
private static final String NAMESPACE = "builtins";
private static final String COMMAND_NAME = "clear";
private final CommandDescriptor descriptor = new CommandDescriptor();
public ClearCommand(CommandRegistry registry) {
super(registry);
addOption(Option.builder("h")
.longName("help")
.desc("Display help for this command")
.build());
}
@Override
public void execute(ParsedOptions options, Console console) throws Exception {
if (options.hasOption("help")) {
printHelp(console);
} else {
console.clearScreen();
}
}
@Override
public Descriptor getDescriptor() {
return descriptor;
}
private static class CommandDescriptor implements Descriptor {
@Override
public String getNamespace() {
return NAMESPACE;
}
@Override
public String getName() {
return COMMAND_NAME;
}
@Override
public String getDescription() {
return "Clear the terminal screen";
}
@Override
public String getUsage() {
return null;
}
}
}