com.auxiliary.sikuli.event

Class SikuliAssertEvent

java.lang.Object

com.auxiliary.sikuli.event.SikuliAbstractEvent

com.auxiliary.sikuli.event.SikuliAssertEvent

public class SikuliAssertEvent
extends SikuliAbstractEvent

文件名：SikuliAssertEvent.java

用途： 封装sikuli工具的断言事件，可设置FindSikuliElement类对象，用以元素名称来进行操作

注意：通过元素名称对元素进行查找的方式不支持外链词语

编码时间：2022年2月16日 上午8:40:52

修改时间：2022年2月16日 上午8:40:52

Since:

JDK 1.8, autest 3.1.0

Version:

Ver1.0

Author:

彭宇琦

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SikuliAssertEvent.SikuliAssertFailException 文件名：SikuliAssertEvent.java

Field Summary

Fields inherited from class com.auxiliary.sikuli.event.SikuliAbstractEvent

DEFAULT_REGION, find, log, operateTime

Constructor Summary

Constructors

Constructor and Description
SikuliAssertEvent() 构造对象

Method Summary

Modifier and Type	Method and Description
boolean	assertElementsNumber(SikuliElement referencedElement, CompareNumberType compareNumberType, SikuliElement comparativeElement) 断言两元素中的数字内容，按照CompareNumberType指定的比较类型进行比较。若断言的 元素文本内容存在非数字字符时，则直接断言失败
boolean	assertElementsNumber(String referencedElementName, CompareNumberType compareNumberType, String comparativeElementName) 断言两元素中的数字内容，按照CompareNumberType指定的比较类型进行比较。若断言的元素文本内容存在非数字字符时，则直接断言失败
boolean	assertElementsNumber(String referencedElementName, int referencedIndex, CompareNumberType compareNumberType, String comparativeElementName, int comparativeIndex) 断言两元素中的数字内容，按照CompareNumberType指定的比较类型进行比较。若断言的元素文本内容存在非数字字符时，则直接断言失败
boolean	assertNumber(SikuliElement element, CompareNumberType compareNumberType, double compareNumber) 断言元素中的数字内容与指定的数字按照CompareNumberType指定的比较类型进行比较。若断言的元素文本内容为非数字字符时，则直接断言失败
boolean	assertNumber(String elementName, CompareNumberType compareNumberType, double compareNumber) 断言两元素中的数字内容，按照CompareNumberType指定的比较类型进行比较。若断言的元素文本内容存在非数字字符时，则直接断言失败
boolean	assertNumber(String elementName, int index, CompareNumberType compareNumberType, double compareNumber) 断言两元素中的数字内容，按照CompareNumberType指定的比较类型进行比较。若断言的元素文本内容存在非数字字符时，则直接断言失败
boolean	assertTextContainKey(SikuliElement element, boolean isJudgeAllKey, String... keys) 断言元素的文本内容中包含指定的关键词。可设置元素的文本内容是否需要判断传入的所有关键词，其用法可参考AssertStringUtil.assertTextContainKey(String, boolean, String...)
boolean	assertTextContainKey(String elementName, boolean isJudgeAllKey, String... keys) 断言元素的文本内容中包含指定的关键词。可设置元素的文本内容是否需要判断传入的所有关键词，其用法可参考AssertStringUtil.assertTextContainKey(String, boolean, String...)
boolean	assertTextContainKey(String elementName, int index, boolean isJudgeAllKey, String... keys) 断言元素的文本内容中包含指定的关键词。可设置元素的文本内容是否需要判断传入的所有关键词，其用法可参考AssertStringUtil.assertTextContainKey(String, boolean, String...)
boolean	assertTextNotContainKey(SikuliElement element, boolean isJudgeAllKey, String... keys) 断言元素的文本内容中不包含指定的关键词。可设置元素的文本内容是否需要判断传入的所有关键词，其用法可参考AssertStringUtil.assertTextNotContainKey(String, boolean, String...)
boolean	assertTextNotContainKey(String elementName, boolean isJudgeAllKey, String... keys) 断言元素的文本内容中不包含指定的关键词。可设置元素的文本内容是否需要判断传入的所有关键词，其用法可参考AssertStringUtil.assertTextNotContainKey(String, boolean, String...)
boolean	assertTextNotContainKey(String elementName, int index, boolean isJudgeAllKey, String... keys) 断言元素的文本内容中不包含指定的关键词。可设置元素的文本内容是否需要判断传入的所有关键词，其用法可参考AssertStringUtil.assertTextNotContainKey(String, boolean, String...)
void	setOcrEvent(SikuliOcrEvent ocr) 该方法用于设置使用自定义配置的ocr事件类对象
void	setThrowException(boolean isThrowException) 该方法用于设置当断言失败时，是否抛出SikuliAssertEvent.SikuliAssertFailException异常

Methods inherited from class com.auxiliary.sikuli.event.SikuliAbstractEvent

actionOperate, recordLog, setFindElementTool, setLogRecordTool, setOperateTime

Methods inherited from class java.lang.Object

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

Constructor Detail

SikuliAssertEvent

public SikuliAssertEvent()

构造对象

Since:

autest 3.1.0

Method Detail

setThrowException

public void setThrowException(boolean isThrowException)

该方法用于设置当断言失败时，是否抛出SikuliAssertEvent.SikuliAssertFailException异常

Parameters:

isThrowException - 断言是否是否抛出异常

Since:

autest 3.1.0

setOcrEvent

public void setOcrEvent(SikuliOcrEvent ocr)

该方法用于设置使用自定义配置的ocr事件类对象

Parameters:

ocr - ocr事件类对象

Since:

autest 3.1.0

assertTextContainKey

public boolean assertTextContainKey(SikuliElement element,
                                    boolean isJudgeAllKey,
                                    String... keys)

断言元素的文本内容中包含指定的关键词。可设置元素的文本内容是否需要判断传入的所有关键词，其用法可参考AssertStringUtil.assertTextContainKey(String, boolean, String...)

Parameters:

element - 元素类对象

isJudgeAllKey - 是否需要完全判断所有关键词

keys - 关键词组

Returns:

断言结果

Throws:

OperateTimeoutException - 操作超时时，抛出的异常

assertTextContainKey

public boolean assertTextContainKey(String elementName,
                                    int index,
                                    boolean isJudgeAllKey,
                                    String... keys)

断言元素的文本内容中包含指定的关键词。可设置元素的文本内容是否需要判断传入的所有关键词，其用法可参考AssertStringUtil.assertTextContainKey(String, boolean, String...)

Parameters:

elementName - 元素名称

index - 多元素时的下标，允许传入负数，参考FindSikuliElement.findElement(String, int, String...)方法

isJudgeAllKey - 是否需要完全判断所有关键词

keys - 关键词组

Returns:

断言结果

Throws:

ElementOperateException - 未指定元素查找类时，抛出的异常

TimeoutException - 元素查找超时时，抛出的异常

OperateTimeoutException - 操作超时时，抛出的异常

assertTextContainKey

public boolean assertTextContainKey(String elementName,
                                    boolean isJudgeAllKey,
                                    String... keys)

断言元素的文本内容中包含指定的关键词。可设置元素的文本内容是否需要判断传入的所有关键词，其用法可参考AssertStringUtil.assertTextContainKey(String, boolean, String...)

Parameters:

elementName - 元素名称

isJudgeAllKey - 是否需要完全判断所有关键词

keys - 关键词组

Returns:

断言结果

Throws:

ElementOperateException - 未指定元素查找类时，抛出的异常

TimeoutException - 元素查找超时时，抛出的异常

OperateTimeoutException - 操作超时时，抛出的异常

assertTextNotContainKey

public boolean assertTextNotContainKey(SikuliElement element,
                                       boolean isJudgeAllKey,
                                       String... keys)

断言元素的文本内容中不包含指定的关键词。可设置元素的文本内容是否需要判断传入的所有关键词，其用法可参考AssertStringUtil.assertTextNotContainKey(String, boolean, String...)

Parameters:

element - 元素类对象

isJudgeAllKey - 是否需要完全判断所有关键词

keys - 关键词组

Returns:

断言结果

Throws:

OperateTimeoutException - 操作超时时，抛出的异常

assertTextNotContainKey

public boolean assertTextNotContainKey(String elementName,
                                       int index,
                                       boolean isJudgeAllKey,
                                       String... keys)

断言元素的文本内容中不包含指定的关键词。可设置元素的文本内容是否需要判断传入的所有关键词，其用法可参考AssertStringUtil.assertTextNotContainKey(String, boolean, String...)

Parameters:

elementName - 元素名称

index - 多元素时的下标，允许传入负数，参考FindSikuliElement.findElement(String, int, String...)方法

isJudgeAllKey - 是否需要完全判断所有关键词

keys - 关键词组

Returns:

断言结果

Throws:

ElementOperateException - 未指定元素查找类时，抛出的异常

TimeoutException - 元素查找超时时，抛出的异常

OperateTimeoutException - 操作超时时，抛出的异常

assertTextNotContainKey

public boolean assertTextNotContainKey(String elementName,
                                       boolean isJudgeAllKey,
                                       String... keys)

断言元素的文本内容中不包含指定的关键词。可设置元素的文本内容是否需要判断传入的所有关键词，其用法可参考AssertStringUtil.assertTextNotContainKey(String, boolean, String...)

Parameters:

elementName - 元素名称

isJudgeAllKey - 是否需要完全判断所有关键词

keys - 关键词组

Returns:

断言结果

Throws:

ElementOperateException - 未指定元素查找类时，抛出的异常

TimeoutException - 元素查找超时时，抛出的异常

OperateTimeoutException - 操作超时时，抛出的异常

assertElementsNumber

public boolean assertElementsNumber(SikuliElement referencedElement,
                                    CompareNumberType compareNumberType,
                                    SikuliElement comparativeElement)

断言两元素中的数字内容，按照CompareNumberType指定的比较类型进行比较。若断言的 元素文本内容存在非数字字符时，则直接断言失败

Parameters:

referencedElement - 参考元素

compareNumberType - 比较方式CompareNumberType枚举类

comparativeElement - 比较元素

Returns:

断言结果

Throws:

OperateTimeoutException - 操作超时时，抛出的异常

assertElementsNumber

public boolean assertElementsNumber(String referencedElementName,
                                    int referencedIndex,
                                    CompareNumberType compareNumberType,
                                    String comparativeElementName,
                                    int comparativeIndex)

断言两元素中的数字内容，按照CompareNumberType指定的比较类型进行比较。若断言的元素文本内容存在非数字字符时，则直接断言失败

Parameters:

referencedElementName - 参考元素名称

referencedIndex - 多元素时的下标，允许传入负数，参考FindSikuliElement.findElement(String, int, String...)方法

compareNumberType - 比较方式CompareNumberType枚举类

comparativeElementName - 比较元素名称

comparativeIndex - 多元素时的下标，允许传入负数，参考FindSikuliElement.findElement(String, int, String...)方法

Returns:

断言结果

Throws:

ElementOperateException - 未指定元素查找类时，抛出的异常

TimeoutException - 元素查找超时时，抛出的异常

OperateTimeoutException - 操作超时时，抛出的异常

assertElementsNumber

public boolean assertElementsNumber(String referencedElementName,
                                    CompareNumberType compareNumberType,
                                    String comparativeElementName)

断言两元素中的数字内容，按照CompareNumberType指定的比较类型进行比较。若断言的元素文本内容存在非数字字符时，则直接断言失败

Parameters:

referencedElementName - 参考元素名称

compareNumberType - 比较方式CompareNumberType枚举类

comparativeElementName - 比较元素名称

Returns:

断言结果

Throws:

ElementOperateException - 未指定元素查找类时，抛出的异常

TimeoutException - 元素查找超时时，抛出的异常

OperateTimeoutException - 操作超时时，抛出的异常

assertNumber

public boolean assertNumber(SikuliElement element,
                            CompareNumberType compareNumberType,
                            double compareNumber)

断言元素中的数字内容与指定的数字按照CompareNumberType指定的比较类型进行比较。若断言的元素文本内容为非数字字符时，则直接断言失败

Parameters:

element - Element对象

compareNumberType - 比较方式CompareNumberType枚举类

compareNumber - 预期数字

Returns:

断言结果

Throws:

OperateTimeoutException - 操作超时时，抛出的异常

assertNumber

public boolean assertNumber(String elementName,
                            int index,
                            CompareNumberType compareNumberType,
                            double compareNumber)

断言两元素中的数字内容，按照CompareNumberType指定的比较类型进行比较。若断言的元素文本内容存在非数字字符时，则直接断言失败

Parameters:

elementName - 参考元素名称

index - 多元素时的下标，允许传入负数，参考FindSikuliElement.findElement(String, int, String...)方法

compareNumberType - 比较方式CompareNumberType枚举类

compareNumber - 预期数字

Returns:

断言结果

Throws:

ElementOperateException - 未指定元素查找类时，抛出的异常

TimeoutException - 元素查找超时时，抛出的异常

OperateTimeoutException - 操作超时时，抛出的异常

assertNumber

public boolean assertNumber(String elementName,
                            CompareNumberType compareNumberType,
                            double compareNumber)

断言两元素中的数字内容，按照CompareNumberType指定的比较类型进行比较。若断言的元素文本内容存在非数字字符时，则直接断言失败

Parameters:

elementName - 参考元素名称

compareNumberType - 比较方式CompareNumberType枚举类

compareNumber - 预期数字

Returns:

断言结果

Throws:

ElementOperateException - 未指定元素查找类时，抛出的异常

TimeoutException - 元素查找超时时，抛出的异常

OperateTimeoutException - 操作超时时，抛出的异常