类

class Matcher ^(deprecated)

public class Matcher {
    public init(re: Regex, input: String)
}

功能：正则匹配器，用于扫描输入序列并进行匹配。

注意：

未来版本即将废弃，使用 Regex 替代。

init(Regex, String)

public init(re: Regex, input: String)

功能：使用传入的正则表达式和输入序列创建 Matcher 实例。

参数：

re: Regex - 正则表达式。
input: String - 输入序列。

func allCount()

public func allCount(): Int64

功能：获取正则表示式的匹配结果总数。

默认是从头到尾匹配的结果，使用了 setRegion 后只会在设置的范围内查找。

返回值：

Int64 - 匹配结果总数。

func find()

public func find(): Option<MatchData>

功能：自当前字符串偏移位置起，查找第一个匹配到的子序列。

find 调用一次，当前偏移位置为最新一次匹配到的子序列后第一个字符位置，下次调用时，find 从当前位置开始匹配。

返回值：

Option<MatchData> - 匹配到结果返回 Option<MatchData>，如果匹配不到，返回 Option<MatchData>.None。

异常：

RegexException - 当存在匹配但提取匹配信息失败时，抛出异常。

func find(Int64)

public func find(index: Int64): Option<MatchData>

功能：重置该匹配器索引位置，从 index 对应的位置处开始对输入序列进行匹配，返回匹配到的子序列。

返回值：

Option<MatchData> - 匹配到结果返回 Option<MatchData>，如果匹配不到，返回 Option<MatchData>.None。

异常：

IndexOutOfBoundsException - 当 index 小于 0，或 index 大于等于输入序列的 size 时，抛出异常。
RegexException - 当存在匹配但提取匹配信息失败时，抛出异常。

func findAll()

public func findAll(): Option<Array<MatchData>>

功能：对整个输入序列进行匹配，查找所有匹配到的子序列。

返回值：

Option<Array<MatchData>> - 如果匹配到结果，返回 Option<Array<MatchData>>；如果匹配不到，返回 Option<Array<MatchData>>.None。

异常：

RegexException - 当存在匹配但提取匹配信息失败时，抛出异常。

func fullMatch()

public func fullMatch(): Option<MatchData>

功能：对整个输入序列进行匹配。

返回值：

Option<MatchData> - 如果全部匹配成功，返回 Option<MatchData>；否则返回 Option<MatchData>.None。

异常：

RegexException - 当存在匹配但提取匹配信息失败时，抛出异常。

func getString()

public func getString(): String

功能：获取匹配序列。

返回值：

String - 匹配序列。

func matchStart()

public func matchStart(): Option<MatchData>

功能：对输入序列的头部进行匹配。

返回值：

Option<MatchData> - 如果匹配成功，返回 Option<MatchData>；否则返回 Option<MatchData>.None。

异常：

RegexException - 当存在匹配但提取匹配信息失败时，抛出异常。

func region()

public func region(): Position

功能：返回匹配器的区域设置。

返回值：

Position - 匹配器的区域设置。

func replace(String)

public func replace(replacement: String): String

功能：自当前字符串偏移位置起，匹配到的第一个子序列替换为目标字符串，并将当前索引位置设置到匹配子序列的下一个位置。

参数：

replacement: String - 指定替换字符串。

返回值：

String - 替换后字符串。

func replace(String, Int64)

public func replace(replacement: String, index: Int64): String

功能：从输入序列的 index 位置起匹配正则，将匹配到的第一个子序列替换为目标字符串。

参数：

replacement: String - 指定替换字符串。
index: Int64 - 匹配开始位置。

返回值：

String - 替换后字符串。

异常：

IndexOutOfBoundsException - 当 index 小于 0，或 index 大于等于输入序列的 size 时，抛出异常。

func replaceAll(String)

public func replaceAll(replacement: String): String

功能：将输入序列中所有与正则匹配的子序列替换为给定的目标字符串。

参数：

replacement: String - 指定替换字符串。

返回值：

String - 替换后的字符串。

func replaceAll(String, Int64)

public func replaceAll(replacement: String, limit: Int64): String

功能：将输入序列中与正则匹配的前 limit 个子序列替换为给定的替换字符串。

参数：

replacement: String - 指定替换字符串。
limit: Int64 - 替换次数。如果 limit 等于 0，返回原来的序列；如果 limit 为负数，将尽可能多次的替换。

返回值：

String - 替换后字符串。

func resetRegion()

public func resetRegion(): Matcher

功能：重置匹配器开始位置和结束位置。

返回值：

Matcher - 匹配器自身。

func resetString(String)

public func resetString(input: String): Matcher

功能：重设匹配序列，并重置匹配器。

参数：

input: String - 新的匹配序列。

返回值：

Matcher - 匹配器自身。

func setRegion(Int64, Int64)

public func setRegion(beginIndex: Int64, endIndex: Int64): Matcher

功能：设置匹配器可搜索区域的位置信息，具体位置由指定的 begin 和 end 决定。

参数：

beginIndex: Int64 - 区域开始位置。
endIndex: Int64 - 区域结束位置。

返回值：

Matcher - 匹配器自身。

异常：

IndexOutOfBoundsException - 当 beginIndex 小于0，或 beginIndex 大于输入序列的 size 时，抛出异常；当 endIndex 小于0，或 endIndex 大于输入序列的 size 时，抛出异常；当 beginIndex 大于 endIndex 时，抛出异常。

func split()

public func split(): Array<String>

功能：将给定的输入序列根据正则尽可能的分割成多个子序列。

返回值：

Array<String> - 子序列数组。

func split(Int64)

public func split(limit: Int64): Array<String>

功能：将给定的输入序列根据正则尽可能的分割成多个子序列 (最多分割成 limit 个子串)。

参数：

limit: Int64 - 最多分割的子串个数。

返回值：

Array<String> - 如果 limit>0，返回最多 limit 个子串；如果 limit<=0，返回最大可分割数个子串。

class Regex

public class Regex {
    public init(pattern: String, flags: Array<RegexFlag>)
    public init(pattern: String, option: RegexOption)
}

功能：用来指定编译类型并创建正则表达式实例。

正则匹配规则详见 regex 规则集。

init(String, Array<RegexFlag>)

public init(pattern: String, flags: Array<RegexFlag>)

功能：创建 Regex 实例。

参数：

pattern: String - 正则表达式。
flags: Array<RegexFlag> - 正则匹配的模式列表。

异常：

RegexException - 当初始化失败时，抛出异常。

init(String, RegexOption) ^(deprecated)

public init(pattern: String, option: RegexOption)

功能：使用指定的模式创建一个 Regex 实例。

注意：

未来版本即将废弃，使用 init(String, Array<RegexFlag>) 替代。

参数：

pattern: String - 正则表达式。
option: RegexOption - 正则匹配的模式。

异常：

RegexException - 当初始化失败时，抛出异常。

func find(String, Bool)

public func find(input: String, group!: Bool = false): Option<MatchData>

功能：查找第一个匹配到的子序列。

参数：

input: String - 待匹配序列。
group!: Bool - 指定是否开启捕获组的提取。

返回值：

Option<MatchData> - 匹配到结果返回 Option<MatchData>，如果匹配不到，返回 Option<MatchData>.None。

异常：

RegexException - 当存在匹配但提取匹配信息失败时，抛出异常。

func findAll(String, Bool)

public func findAll(input: String, group!: Bool = false): Array<MatchData>

功能：对整个输入序列进行匹配，查找所有匹配到的子序列。

参数：

input: String - 待匹配序列。
group!: Bool - 指定是否开启捕获组的提取。

返回值：

Array<MatchData> - 存储匹配结果的数组，如果未匹配到，数组为空。

异常：

RegexException - 当存在匹配但提取匹配信息失败时，抛出异常。

func getNamedGroups(): Map<String, Int64>

public func getNamedGroups(): Map<String, Int64>

功能：获取命名捕获组的名称与索引映射。

返回值：

Map<String, Int64> - 命名捕获组的名称与索引映射。

func lazyFindAll(String, Bool)

public func lazyFindAll(input: String, group!: Bool = false): Iterator<MatchData>

功能：对整个输入序列进行匹配，获取匹配的迭代器。

参数：

input: String - 待匹配序列。
group!: Bool - 指定是否开启捕获组的提取。

返回值：

Iterator<MatchData> - 匹配的迭代器。

func matcher(String) ^(deprecated)

public func matcher(input: String): Matcher

功能：创建匹配器。

注意：

未来版本即将废弃。

参数：

input: String - 要匹配的字符串。

返回值：

Matcher - 创建的匹配器。

func matches(String)

public func matches(input: String): Bool

功能：判断入参 input 与正则表达式是否存在匹配。

参数：

input: String - 要匹配的字符串。

返回值：

Bool - 如果存在匹配，返回 true，否则返回 false。

func replace(String, String)

public func replace(input: String, replacement: String): String

功能：自当前字符串起始位置开始，匹配到的第一个子序列替换为目标字符串。

参数：

input: String - 待匹配序列。
replacement: String - 指定替换字符串。

返回值：

String - 替换后字符串。

func replace(String, String, Int64)

public func replace(input: String, replacement: String, index: Int64): String

功能：从输入序列的 index 位置起匹配正则，将匹配到的第一个子序列替换为目标字符串。

参数：

input: String - 待匹配序列。
replacement: String - 指定替换字符串。
index: Int64 - 匹配开始位置。

返回值：

String - 替换后字符串。

异常：

IndexOutOfBoundsException - 当 index 小于 0，或 index 大于等于输入序列的 size 时，抛出异常。

func replaceAll(String, String)

public func replaceAll(input: String, replacement: String): String

功能：将输入序列中所有与正则匹配的子序列替换为给定的目标字符串。

参数：

input: String - 待匹配序列。
replacement: String - 指定替换字符串。

返回值：

String - 替换后的字符串。

func replaceAll(String, String, Int64)

public func replaceAll(input: String, replacement: String, limit: Int64): String

功能：将输入序列中与正则匹配的前 limit 个子序列替换为给定的替换字符串。

参数：

input: String - 待匹配序列。
replacement: String - 指定替换字符串。
limit: Int64 - 替换次数。如果 limit 等于 0，返回原来的序列；如果 limit 为负数，将尽可能多次的替换。

返回值：

String - 替换后字符串。

func split(String)

public func split(input: String): Array<String>

功能：将给定的输入序列根据正则尽可能的分割成多个子序列。

参数：

input: String - 待匹配序列。

返回值：

Array<String> - 子序列数组。

func split(String, Int64)

public func split(input: String, limit: Int64): Array<String>

功能：将给定的输入序列根据正则尽可能的分割成多个子序列 (最多分割成 limit 个子串)。

参数：

input: String - 待匹配序列。
limit: Int64 - 最多分割的子串个数。

返回值：

Array<String> - 如果 limit>0，返回最多 limit 个子串；如果 limit<=0，返回最大可分割数个子串。

func string()

public func string(): String

功能：获取正则的输入序列。

返回值：

String - 输入序列。

class RegexOption ^(deprecated)

public class RegexOption <: ToString {
    public init()
}

功能：用于指定正则匹配的模式。

注意：

未来版本即将废弃，使用 RegexFlag 替代。

父类型：

ToString

init()

public init()

功能：创建一个 RegexOption 实例，匹配模式为普通模式（NORMAL）。

func ignoreCase()

public func ignoreCase(): RegexOption

功能：修改 RegexOption，修改匹配模式为忽略大小写（IGNORECASE）。

返回值：

RegexOption - 修改后的 RegexOption。

func multiLine()

public func multiLine(): RegexOption

功能：修改 RegexOption，修改匹配模式为多行文本模式（MULTILINE）。

返回值：

RegexOption - 修改后的 RegexOption。

func toString()

public func toString(): String

功能：获取 RegexOption 当前表示的正则匹配模式。

返回值：

String - 正则匹配模式。

仓颉编程语言标准库 API