xyz.scootaloo.console.app.application

类 AbstractConsoleApplication

java.lang.Object

xyz.scootaloo.console.app.application.AbstractConsoleApplication

直接已知子类:

ConsoleApplication

public abstract class AbstractConsoleApplication
extends Object

抽象的控制台应用<

从以下版本开始:

2020/12/27 21:54

作者:

flutterdash@qq.com

字段概要

字段

限定符和类型	字段和说明
protected CallBack	callBack
protected Consumer<ConsoleAppRuntimeException>	exceptionHandle

构造器概要

构造器

构造器和说明
AbstractConsoleApplication()

方法概要

限定符和类型	方法和说明
abstract AbstractConsoleApplication	addPostProcessor(PostProcessor processor) 提供一个处理器接受命令的执行信息
protected void	exceptionHandle(ConsoleAppRuntimeException e)
protected String	getCmdName(List<String> items) 获取命令行中的命令名称
protected abstract String	getInput()
protected abstract boolean	isExitCmd(String cmdName)
protected abstract void	printPrompt()
void	run() 1.
AbstractConsoleApplication	setExitAction(CallBack callBack) 指定一个其他的退出方法
AbstractConsoleApplication	setGlobalExHandle(Consumer<ConsoleAppRuntimeException> exceptionHandle) 提供一个全局异常处理器 当框架中有不能处理的异常就会被传递到这个处理器来。
protected void	shutdown()
protected abstract boolean	simpleRunCommand(String command) 运行命令的方式
protected void	welcome()

从类继承的方法 java.lang.Object

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

字段详细资料

exceptionHandle

protected Consumer<ConsoleAppRuntimeException> exceptionHandle

callBack

protected CallBack callBack

构造器详细资料

AbstractConsoleApplication

public AbstractConsoleApplication()

方法详细资料

getInput

protected abstract String getInput()

printPrompt

protected abstract void printPrompt()

isExitCmd

protected abstract boolean isExitCmd(String cmdName)

run

public void run()

1. 打印欢迎信息 2. 等待键盘输入 3. 解释键盘输入 3.1 假如是退出命令，则执行 whenExit() 方法后应用退出 3.2 解释命令时抛出异常，将由 exceptionHandle(e) 进行处理 4. 解释结束，回到步骤2.

welcome

protected void welcome()

shutdown

protected void shutdown()

exceptionHandle

protected void exceptionHandle(ConsoleAppRuntimeException e)

setGlobalExHandle

public AbstractConsoleApplication setGlobalExHandle(Consumer<ConsoleAppRuntimeException> exceptionHandle)

提供一个全局异常处理器
当框架中有不能处理的异常就会被传递到这个处理器来。如果没有指定异常处理器，则默认根据配置文件决定是否打印调用栈。

框架中的异常分为两类，
1. 解析命令行时
2. 执行方法时

参数:

exceptionHandle - 异常处理器

返回:

返回控制台应用对象，可以继续进行配置

另请参阅:

ConsoleAppRuntimeException

setExitAction

public AbstractConsoleApplication setExitAction(CallBack callBack)

指定一个其他的退出方法

参数:

callBack - 这将是系统的最后一个方法，调用完这个方法后，程序退出。

返回:

返回控制台应用对象，可以继续进行配置

addPostProcessor

public abstract AbstractConsoleApplication addPostProcessor(PostProcessor processor)

提供一个处理器接受命令的执行信息

参数:

processor - 处理器

返回:

返回控制台应用对象，可以继续进行配置，另外，这个处理器可以设置多个，框架将按照顺序调用它们

simpleRunCommand

protected abstract boolean simpleRunCommand(String command)
                                     throws ConsoleAppRuntimeException

运行命令的方式

参数:

command - 字符串命令

返回:

bool 是否是退出命令

抛出:

ConsoleAppRuntimeException - 可能抛出的异常

getCmdName

protected String getCmdName(List<String> items)

获取命令行中的命令名称

参数:

items - 使用空格分隔的参数段

返回:

命令名称(小写处理)