com.auxiliary.sikuli.app

Class AbstractApp

java.lang.Object

com.auxiliary.sikuli.app.AbstractApp

Direct Known Subclasses:

WindowsApp

public abstract class AbstractApp
extends Object

文件名：AbstractApp.java

用途： 定义应用启动基本的方法

编码时间：2021年12月17日 上午7:54:06

修改时间：2021年12月17日 上午7:54:06

Since:

autest 3.0.0

Version:

Ver1.0

Author:

彭宇琦

Field Summary

Fields

Modifier and Type	Field and Description
protected org.sikuli.script.App	app 用于存储所有的应用程序
protected HashMap<String,Integer>	appMap 存储应用程序相关的信息，键为应用名称，值为应用pid
protected int	DEFAULT_WAIT_TIME 定义默认的等待时间
protected String	nowAppName 用于指向当前正在执行的应用名称
protected int	openWaitTime 存储应用启动后的等待时间

Constructor Summary

Constructors

Constructor and Description
AbstractApp()

Method Summary

Modifier and Type	Method and Description
void	close() 该方法用于关闭当前正在操作的应用程序
void	close(String appName) 该方法用于关闭指定的应用程序
protected abstract List<Integer>	getAppPid(String... appCourseKeys) 该方法用于根据应用程序在终端中的名称，查找其对应的pid值，并进行返回。若无法查找到相应的PID值，则返回只有一个-1的集合
void	open(File appFile, String... appCourseKey) 该方法用于启动指定的应用程序，并将文件名称作为应用的名称
void	open(String appName, File appFile, String... appCourseKey) 该方法用于启动应用程序，并根据该应用程序的进程名称，获取应用程序的PID值
protected boolean	putApp(String appName, Integer pid) 该方法用于对应用的名称和pid值进行判断，对判断通过的值进行存储，并返回是否添加成功
void	quit() 该方法用于终止（强行结束）当前正在操作的应用程序
abstract void	quit(String appName) 该方法用于终止（强行结束）启动的应用程序
void	quitAll() 该方法用于终止（强行结束）所有启动的应用程序
protected void	removeApp(String appName) 该方法用于移除指定名称的应用，若移除的应用为当前正在操作的应用，则将nowAppName置空
protected boolean	setAppPid(String appName) 该方法用于根据应用名称，对存储的pid值进行切换
void	setOpenWaitTime(int openWaitTime) 该方法用于设置应用启动的等待时间，单位为秒，默认为5秒
void	switchApp(String appName) 该方法用于将指定的应用切换到顶层

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WAIT_TIME

protected final int DEFAULT_WAIT_TIME

定义默认的等待时间

See Also:

Constant Field Values

app

protected org.sikuli.script.App app

用于存储所有的应用程序

appMap

protected HashMap<String,Integer> appMap

存储应用程序相关的信息，键为应用名称，值为应用pid

nowAppName

protected String nowAppName

用于指向当前正在执行的应用名称

openWaitTime

protected int openWaitTime

存储应用启动后的等待时间

Constructor Detail

AbstractApp

public AbstractApp()

Method Detail

open

public void open(File appFile,
                 String... appCourseKey)

该方法用于启动指定的应用程序，并将文件名称作为应用的名称

Parameters:

appFile - 应用程序启动文件类对象

appCourseKey - 搜索应用进程名称的关键词组

Since:

autest 3.0.0

open

public void open(String appName,
                 File appFile,
                 String... appCourseKey)

该方法用于启动应用程序，并根据该应用程序的进程名称，获取应用程序的PID值

注意：搜索PID值是通过进程名称关键词，通过操作系统命令来查找，若通过关键词搜索到多个且不是通过程序打开的应用，则可能导致获取的PID值不正确。

Parameters:

appName - 应用名称

appFile - 应用程序启动文件类对象

appCourseKey - 搜索应用进程名称的关键词组

Throws:

OpenAppException - 当打开应用名称失败时，抛出的异常

Since:

autest 3.0.0

setOpenWaitTime

public void setOpenWaitTime(int openWaitTime)

该方法用于设置应用启动的等待时间，单位为秒，默认为5秒

注意：该方法设置为小于0的参数时，则使用默认值

Parameters:

openWaitTime - 应用启动等待时间

Since:

autest 3.0.0

switchApp

public void switchApp(String appName)

该方法用于将指定的应用切换到顶层

注意：若当前应用并未设置PID值，则不会进行切换操作

Parameters:

appName - 应用名称

Throws:

OpenAppException - 当应用名称不存在时，抛出的异常

Since:

autest 3.0.0

close

public void close()

该方法用于关闭当前正在操作的应用程序

Throws:

OpenAppException - 当前未打开应用时，抛出的异常

Since:

autest 3.0.0

close

public void close(String appName)

该方法用于关闭指定的应用程序

Throws:

OpenAppException - 当应用名称不存在时，抛出的异常

Since:

autest 3.0.0

quit

public void quit()

该方法用于终止（强行结束）当前正在操作的应用程序

Throws:

OpenAppException - 当前未打开应用时，抛出的异常

Since:

autest 3.0.0

quit

public abstract void quit(String appName)

该方法用于终止（强行结束）启动的应用程序

Parameters:

appName - 应用名称

Since:

autest 3.0.0

quitAll

public void quitAll()

该方法用于终止（强行结束）所有启动的应用程序

Since:

autest 3.0.0

getAppPid

protected abstract List<Integer> getAppPid(String... appCourseKeys)

该方法用于根据应用程序在终端中的名称，查找其对应的pid值，并进行返回。若无法查找到相应的PID值，则返回只有一个-1的集合

Parameters:

appCourseKeys - 应用在终端中的名称

Returns:

应用的pid值集合

Since:

autest 3.0.0

putApp

protected boolean putApp(String appName,
                         Integer pid)

该方法用于对应用的名称和pid值进行判断，对判断通过的值进行存储，并返回是否添加成功

Parameters:

appName - 应用名称

pid - 应用pid值

Returns:

应用名称是否添加成功

Since:

autest 3.0.0

setAppPid

protected boolean setAppPid(String appName)

该方法用于根据应用名称，对存储的pid值进行切换

Parameters:

appName - app名称

Returns:

是否成功设置

Since:

autest 3.0.0

removeApp

protected void removeApp(String appName)

该方法用于移除指定名称的应用，若移除的应用为当前正在操作的应用，则将nowAppName置空

Parameters:

appName - 应用名称

Since:

autest 3.0.0