ReadLocation (autest - Gitee.com))

All Known Implementing Classes:

AbstractLocation, JsonLocation, NoFileLocation, TextLocation, XmlLocation, YamlLocation
```
public interface ReadLocation
```
文件名：ReadLocation.java

用途： 定义读取元素定位内容必须实现的方法

编码时间：2020年10月29日下午12:52:41

修改时间：2021年4月17日上午10:34:00

Version:

Ver1.1

Author:

彭宇琦

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ReadLocation`	`find(String name)` 用于预读元素信息，并将元素信息进行缓存，以便于快速查找元素信息
`long`	`getBeforeTime()` 用于返回元素的前置等待时间
`ArrayList<ElementLocationInfo>`	`getElementLocation()` 用于返回元素的定位信息
`ElementType`	`getElementType()` 用于返回元素的类型
`String`	`getEndElementPlaceholder()` 该方法用于返回元素占位符结束标识
`ArrayList<String>`	`getIframeNameList()` 用于返回元素的所有父窗体名称集合
`Placeholder`	`getPlaceholder()` 该方法用于返回占位符类对象
`String`	`getStartElementPlaceholder()` 该方法用于返回元素占位符起始标识
`long`	`getWaitTime()` 用于返回元素的等待时间
`void`	`setElementPlaceholder(String startRegex, String endRegex)` 该方法用于设置自定义的元素占位符标识

- Method Detail
  - getElementLocation
```
ArrayList<ElementLocationInfo> getElementLocation()
```
    用于返回元素的定位信息
    
    Returns:
    
    元素定位信息
    
    Throws:
    
    UndefinedElementException - 元素不存在时抛出的异常
    
    Since:
    
    autest 2.2.0
  - getElementType
```
ElementType getElementType()
```
    用于返回元素的类型
    
    Returns:
    
    元素类型（ElementType枚举）
    
    Throws:
    
    UndefinedElementException - 元素不存在时抛出的异常
    
    Since:
    
    autest 2.2.0
  - getIframeNameList
```
ArrayList<String> getIframeNameList()
```
    用于返回元素的所有父窗体名称集合
    
    Returns:
    
    元素的所有父窗体名称集合
    
    Throws:
    
    UndefinedElementException - 元素不存在时抛出的异常
    
    Since:
    
    autest 2.2.0
  - getWaitTime
```
long getWaitTime()
```
    用于返回元素的等待时间
    
    Returns:
    
    元素的等待时间
    
    Throws:
    
    UndefinedElementException - 元素不存在时抛出的异常
    
    Since:
    
    autest 2.2.0
  - find
```
ReadLocation find(String name)
```
    用于预读元素信息，并将元素信息进行缓存，以便于快速查找元素信息
    
    Parameters:
    
    name - 元素名称
    
    Since:
    
    autest 2.2.0
  - getBeforeTime
```
long getBeforeTime()
```
    用于返回元素的前置等待时间
    注意：该方法读取到的时间单位为毫秒
    
    Returns:
    
    元素等待时间
    
    Throws:
    
    UndefinedElementException - 元素不存在时抛出的异常
    
    Since:
    
    autest 2.3.0
  - setElementPlaceholder
```
void setElementPlaceholder(String startRegex,
                           String endRegex)
```
    该方法用于设置自定义的元素占位符标识
    注意：该方法接收的标识符是正则表达式，若传入的标识符为特殊符号（如：*），则需要使用双反斜杠来转义（如：\\*）
    
    Parameters:
    
    startRegex - 占位符起始标识
    
    endRegex - 占位符结束标识
    
    Since:
    
    autest 2.7.0
  - getStartElementPlaceholder
```
String getStartElementPlaceholder()
```
    该方法用于返回元素占位符起始标识
    
    Returns:
    
    占位符起始标识
    
    Since:
    
    autest 2.7.0
  - getEndElementPlaceholder
```
String getEndElementPlaceholder()
```
    该方法用于返回元素占位符结束标识
    
    Returns:
    
    占位符结束标识
    
    Since:
    
    autest 2.7.0
  - getPlaceholder
```
Placeholder getPlaceholder()
```
    该方法用于返回占位符类对象
    
    Returns:
    
    占位符类对象
    
    Since:
    
    autest 4.2.0

Interface ReadLocation

Method Summary

Method Detail

getElementLocation

getElementType

getIframeNameList

getWaitTime

find

getBeforeTime

setElementPlaceholder

getStartElementPlaceholder

getEndElementPlaceholder

getPlaceholder