net.hasor.tconsole.commands.HelpExecutor Maven / Gradle / Ivy
/*
* Copyright 2008-2009 the original author or authors.
*
* 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 net.hasor.tconsole.commands;
import net.hasor.tconsole.TelCommand;
import net.hasor.tconsole.TelContext;
import net.hasor.tconsole.TelExecutor;
import net.hasor.utils.StringUtils;
import javax.inject.Singleton;
import java.io.StringWriter;
import java.util.List;
/**
* 显示所有指令
* @version : 2019年10月30日
* @author 赵永春 ([email protected])
*/
@Singleton
public class HelpExecutor implements TelExecutor {
@Override
public String helpInfo() {
return "command help manual. the function like linux man.\r\n"//
+ " - help (show all commands help info.)\r\n"//
+ " - help (show help detail info.)\r\n"//
+ " - example : \r\n"//
+ " help quit (show the 'quit' command help info.)";
}
@Override
public String doCommand(TelCommand telCommand) {
TelContext finder = telCommand.getSession().getTelContext();
List cmdNames = finder.getCommandNames();
StringWriter sw = new StringWriter();
if (cmdNames == null || cmdNames.isEmpty()) {
return "there is nothing command to display information.";
}
String[] args = telCommand.getCommandArgs();
if (args != null && args.length > 0) {
String cmdName = args[0];
TelExecutor cmd = finder.findCommand(cmdName);
if (cmd != null) {
sw.write(">>>>>>>>>>>>>>>>>>>>>>>> " + cmdName + " <<<<<<<<<<<<<<<<<<<<<<<<\r\n");
sw.write(cmd.helpInfo() + "\r\n");
} else {
sw.write("[ERROR] command '" + cmdName + "' does not exist.\r\n");
}
return sw.toString();
}
//
cmdNames.remove("help");
cmdNames.remove("man");
int maxLength = 0;
for (String name : cmdNames) {
maxLength = name.length() > maxLength ? name.length() : maxLength;
}
maxLength = maxLength + 2;
for (String name : cmdNames) {
TelExecutor cmd = finder.findCommand(name);
sw.write(" - " + StringUtils.rightPad(name, maxLength, " ") + cmd.helpInfo().split("\r\n")[0]);
if (cmdNames.size() > 1) {
sw.write("\r\n");
}
}
return sw.toString();
}
}