net.lamgc.utils.base.runner

类 ArgumentsRunner

java.lang.Object

net.lamgc.utils.base.runner.ArgumentsRunner

public class ArgumentsRunner
extends Object

命令行参数运行器.
该运行器根据传入的参数, 自动选择指定类中带有Command标注的方法, 且支持参数传入.
运行格式: java -jar jarFile <Command> [Arguments...]

构造器概要

构造器

构造器和说明
ArgumentsRunner(Class<?> runClass) 构造一个参数运行器
ArgumentsRunner(Class<?> runClass, ArgumentsRunnerConfig config) 构造一个参数运行器

方法概要

限定符和类型	方法和说明
Set<String>	getCommandNames() 获取已获得的命令名.
static Object	run(Class<?> runClass, Object object, String[] args) 无配置启动一个运行器.
static Object	run(Class<?> runClass, String[] args) 无配置启动一个运行器.
Object	run(Object object, String[] args) 启动运行器
Object	run(String[] args) 无实例对象启动运行器
static Object	runInThisClass(Object object, String[] args) 在调用该方法所在类启动ArgumentsRunner.
static Object	runInThisClass(String[] args) 在调用该方法所在类启动ArgumentsRunner.

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

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

构造器详细资料

ArgumentsRunner

public ArgumentsRunner(Class<?> runClass)

构造一个参数运行器

参数:

runClass - 运行类对象

抛出:

RunnerException - 当检查Class发生异常时抛出, 注意检查 RunnerException.getExceptionTrigger() 返回值, 该异常会标记引发原因, 详情请查看RunnerException.getExceptionTrigger()

ArgumentsRunner

public ArgumentsRunner(Class<?> runClass,
                       ArgumentsRunnerConfig config)
                throws RunnerException

构造一个参数运行器

参数:

runClass - 运行类对象

config - 运行器配置对象

抛出:

RunnerException - 当检查Class发生异常时抛出, 注意检查 RunnerException.getExceptionTrigger() 返回值, 该异常会标记引发原因, 详情请查看RunnerException.getExceptionTrigger()

方法详细资料

run

public static Object run(Class<?> runClass,
                         String[] args)

无配置启动一个运行器.

参数:

runClass - 待运行的Class对象

args - 运行参数

返回:

返回命令处理方法的返回值.

抛出:

RunnerException - 当运行器发生异常时抛出, 注意检查 RunnerException.getExceptionTrigger() 返回值, 该异常会标记引发原因, 详情请查看RunnerException.getExceptionTrigger()

run

public static Object run(Class<?> runClass,
                         Object object,
                         String[] args)
                  throws RunnerException

无配置启动一个运行器.

参数:

runClass - 待运行的Class对象

object - class的实例对象

args - 运行参数

返回:

返回命令处理方法的返回值.

抛出:

RunnerException - 当运行器发生异常时抛出, 注意检查 RunnerException.getExceptionTrigger() 返回值, 该异常会标记引发原因, 详情请查看RunnerException.getExceptionTrigger()

runInThisClass

public static Object runInThisClass(String[] args)
                             throws RunnerException

在调用该方法所在类启动ArgumentsRunner.
注意: 当项目使用如SpringBoot之类的框架, 而框架存在重新打包项目并分隔目录的情况时, 请不要使用本方法! 经过重新打包的Jar将无法根据堆栈找到 RunClass.

参数:

args - 参数

返回:

返回命令处理方法的返回值.

抛出:

RunnerException - 当运行器发生异常时抛出, 注意检查 RunnerException.getExceptionTrigger() 返回值, 该异常会标记引发原因, 详情请查看RunnerException.getExceptionTrigger()

runInThisClass

public static Object runInThisClass(Object object,
                                    String[] args)
                             throws RunnerException

在调用该方法所在类启动ArgumentsRunner.
注意: 当项目使用如SpringBoot之类的框架, 而框架存在重新打包项目并分隔目录的情况时, 请不要使用本方法! 经过重新打包的Jar将无法根据堆栈找到 RunClass.

参数:

object - 当前方法所在的class的实例对象

args - 参数

返回:

返回命令处理方法的返回值.

抛出:

RunnerException - 当运行器发生异常时抛出, 注意检查 RunnerException.getExceptionTrigger() 返回值, 该异常会标记引发原因, 详情请查看RunnerException.getExceptionTrigger()

run

public Object run(String[] args)
           throws RunnerException

无实例对象启动运行器

参数:

args - 运行参数

返回:

返回命令处理方法的返回值.

抛出:

RunnerException - 当运行器发生异常时抛出, 注意检查 RunnerException.getExceptionTrigger() 返回值, 该异常会标记引发原因, 详情请查看RunnerException.getExceptionTrigger()

run

public Object run(Object object,
                  String[] args)
           throws RunnerException

启动运行器

参数:

object - 构造时提供的class所属的实例对象

args - 运行参数

返回:

返回命令处理方法的返回值.

抛出:

RunnerException - 当运行器发生异常时抛出, 注意检查 RunnerException.getExceptionTrigger() 返回值, 该异常会标记引发原因, 详情请查看RunnerException.getExceptionTrigger()

getCommandNames

public Set<String> getCommandNames()

获取已获得的命令名.
命令根据方法静态与否, 在命令名前有静态表示的 "Static." 前缀,
例如实例命令方法 "Command", 如果是静态方法, 则为 "Static.Command"

返回:

返回存储命令名的Set对象, 如尚未解析Class内的方法, 则返回null