Matcher

appendReplacement

Matcher appendReplacement (StringBuffer sb, 
                String replacement)

实现非终端追加和替换步骤。

该方法执行以下操作：

1. 它从输入序列中读取字符，从append位置开始，并将它们附加到给定的字符串缓冲区。 它在读取前一匹配之前的最后一个字符后停止，即索引为start() - 1的字符。

2. 它将给定的替换字符串附加到字符串缓冲区。

3. 它将匹配器的追加位置设置为匹配的最后一个字符的索引，再加上一个，即 end() 。

替换字符串可能包含对前一次匹配过程中捕获的子序列的引用：每次出现$ g将被替换为分别评估相应的group(g)的结果。 对于$克 ，在$后的第一个数字始终被视为该组参考的一部分。 随后的数字会被合并到g中，如果它们会形成合法的组参考。 只有数字“0”到“9”被认为是组参考的潜在组成部分。 例如，如果第二组匹配字符串"foo" ，则传递替换字符串"$2bar"将导致"foobar"追加到字符串缓冲区。 美元符号（ $ ）可能作为文字包含在替换字符串中，前面带有反斜杠（ \$ ）。

请注意替换字符串中的反斜杠（ \ ）和美元符号（ $ ）可能会导致结果与将它视为字面替换字符串时的结果不同。 如上所述，美元符号可以视为对捕获的子序列的引用，而反斜杠用于转义替换字符串中的文字字符。

此方法旨在与appendTail和find方法一起用于循环中。 例如，以下代码将one dog two dogs in the yard写入标准输出流：

 Pattern p = Pattern.compile("cat");
 Matcher m = p.matcher("one cat two cats in the yard");
 StringBuffer sb = new StringBuffer();
 while (m.find()) {
     m.appendReplacement(sb, "dog");
 }
 m.appendTail(sb);
 System.out.println(sb.toString());

appendTail

StringBuffer appendTail (StringBuffer sb)

实现终端附加和替换步骤。

此方法从输入序列中读取字符，从append位置开始，并将它们附加到给定的字符串缓冲区。 它旨在调用appendReplacement方法的一个或多个调用以复制输入序列的其余部分。

end

int end (int group)

返回前一次匹配操作期间给定组捕获的子序列的最后一个字符后的偏移量。

Capturing groups从左到右索引，从1开始。 零组表示整个模式，所以表达式m。 end(0)等于m。 end() 。

end

int end ()

Returns the offset after the last character matched.

find

boolean find ()

尝试查找与模式匹配的输入序列的下一个子序列。

该方法从该匹配器的区域的开始处开始，或者如果之前的方法调用成功并且匹配器尚未被重置，则在与先前的匹配不匹配的第一个字符处开始。

如果匹配成功可以通过 start，end，和 group方法来获得，然后更多的信息。

find

boolean find (int start)

重置此匹配器，然后尝试从指定索引处开始查找与模式匹配的输入序列的下一个子序列。

如果匹配成功可以通过 start，end，和 group方法，以及随后的调用能够得到那么更多的信息 find()方法将在不受此匹配匹配的第一个字符开始。

group

String group (int group)

返回上一次匹配操作期间给定组所捕获的输入子序列。

对于匹配器m ，输入序列s和组索引g ，表达式m。 group( g )和s。 substring(米 。 start( g ), m。 end( g ))是等效的。

Capturing groups从左到右索引，从1开始。 零组表示整个模式，因此表达式m.group(0)等同于m.group() 。

如果匹配成功但指定的组未能匹配输入序列的任何部分，则返回null 。 请注意，某些组（例如(a*) ）与空字符串匹配。 当这个组成功匹配输入中的空字符串时，此方法将返回空字符串。

group

String group ()

返回前一次匹配所匹配的输入子序列。

对于具有输入序列s的匹配器m ，表达式m。 group()和s。 substring( 米。 start(), m。 end())是等同的。

请注意，某些模式（例如a* ）与空字符串匹配。 当模式成功匹配输入中的空字符串时，此方法将返回空字符串。

groupCount

int groupCount ()

返回此匹配器模式中的捕获组的数量。

零组表示按照惯例的整个模式。 这不包括在这个计数中。

任何小于或等于此方法返回的值的非负整数保证为此匹配器的有效组索引。

hasAnchoringBounds

boolean hasAnchoringBounds ()

查询该匹配器的区域边界的锚定。

如果此匹配使用 固定的边界，否则 false此方法返回 true。

有关锚定界限的描述，请参阅 useAnchoringBounds 。

默认情况下，匹配器使用锚定区域边界。

hasTransparentBounds

boolean hasTransparentBounds ()

查询此匹配器的区域边界的透明度。

如果此匹配使用 透明边界 ，false，如果它使用 不透明边界此方法返回 true。

有关透明和不透明边界的说明，请参见 useTransparentBounds 。

默认情况下，匹配器使用不透明的区域边界。

hitEnd

boolean hitEnd ()

如果在匹配器执行的最后一次匹配操作中输入的结尾被搜索引擎击中，则返回true。

当此方法返回true时，则可能有更多输入会改变上次搜索的结果。

lookingAt

boolean lookingAt ()

尝试将从区域开始处开始的输入序列与模式匹配。

和matches方法一样，这个方法总是从该区域的开始处开始; 不像那种方法，它不需要整个区域匹配。

如果匹配成功可以通过 start，end，和 group方法来获得，然后更多的信息。

matches

boolean matches ()

试图将整个区域与该模式进行匹配。

如果匹配成功可以通过 start，end，和 group方法来获得，然后更多的信息。

pattern

Pattern pattern ()

返回由此匹配器解释的模式。

quoteReplacement

String quoteReplacement (String s)

返回面值替换String指定的String 。 此方法生成一个String ，它将作为Matcher类的appendReplacement方法中的文字替换s 。 生成的String将与s作为文字序列处理的字符序列相匹配。 斜线（'\'）和美元符号（'$'）将没有特别的含义。

region

Matcher region (int start, 
                int end)

设置此匹配器区域的限制。 该区域是将被搜索以找到匹配的输入序列的一部分。 调用此方法重置匹配器，然后设置区域由指定的索引处开始start由指定的索引在参数和结束end参数。

根据所使用的透明度和锚定情况（请参阅 useTransparentBounds和 useAnchoringBounds ），某些构造（如锚点）在该区域边界处或附近的行为可能会有所不同。

regionEnd

int regionEnd ()

报告匹配器区域的结束索引（独占）。 匹配者进行的搜索仅限于在regionStart （含）和regionEnd （ regionStart ）中找到匹配regionStart 。

regionStart

int regionStart ()

报告匹配器区域的开始索引。 此匹配器进行的搜索仅限于在regionStart （含）和regionEnd （ regionStart ）中查找匹配regionStart 。

replaceAll

String replaceAll (String replacement)

用输入替换字符串替换与模式匹配的输入序列的每个子序列。

该方法首先重置此匹配器。 然后它扫描输入序列以查找模式的匹配。 不属于任何匹配的字符直接附加到结果字符串; 每个匹配在替换字符串的结果中被替换。 替换字符串可能包含对捕获子序列的引用，如appendReplacement方法中所述。

请注意替换字符串中的反斜杠（ \ ）和美元符号（ $ ）可能会导致结果与将它视为字面替换字符串时的结果不同。 如上所述，美元符号可以视为对捕获的子序列的引用，而反斜杠用于转义替换字符串中的文字字符。

给定正则表达式 a*b ，输入 "aabfooaabfooabfoob"和替换字符串 "-" ，在该表达式的匹配器上调用此方法将产生字符串 "-foo-foo-foo-" 。

调用这个方法改变了这个匹配器的状态。 如果匹配器将被用于进一步的匹配操作，那么它应该首先被重置。

replaceFirst

String replaceFirst (String replacement)

将输入序列的第一个子序列替换为给定替换字符串的模式。

该方法首先重置此匹配器。 然后它扫描输入序列，寻找模式的匹配。 不属于匹配的字符直接附加到结果字符串; 在替换字符串的结果中匹配被替换。 如appendReplacement方法中的替换字符串可能包含对捕获的子序列的appendReplacement 。

请注意，替换字符串中的反斜杠（ \ ）和美元符号（ $ ）可能会导致结果与将它视为字面替换字符串时的结果不同。 如上所述，美元符号可以视为对捕获的子序列的引用，而反斜杠用于转义替换字符串中的文字字符。

给定正则表达式 dog ，输入 "zzzdogzzzdogzzz"和替换字符串 "cat" ，在该表达式的匹配器上调用此方法将产生字符串 "zzzcatzzzdogzzz" 。

调用这个方法改变了这个匹配器的状态。 如果匹配器将被用于进一步的匹配操作，那么它应该首先被重置。

requireEnd

boolean requireEnd ()

如果有更多输入可以将正匹配变为负匹配，则返回true。

如果此方法返回true，并且找到匹配项，则更多输入可能会导致匹配丢失。 如果此方法返回false并找到匹配项，则更多输入可能会更改匹配，但匹配不会丢失。 如果找不到匹配，那么requireEnd就没有意义。

reset

Matcher reset (CharSequence input)

用新的输入序列重新设置匹配器。

重置匹配器会丢弃其所有显式状态信息，并将其附加位置设置为零。 匹配器的区域被设置为默认区域，这是它的整个字符序列。 匹配器区域边界的锚定和透明度不受影响。

reset

Matcher reset ()

重置此匹配器。

重置匹配器会丢弃其所有显式状态信息，并将其附加位置设置为零。 匹配器的区域被设置为默认区域，这是它的整个字符序列。 匹配器区域边界的锚定和透明度不受影响。

start

int start ()

Returns the start index of the previous match.

start

int start (int group)

返回上一次匹配操作期间给定组捕获的子序列的开始索引。

Capturing groups从左到右索引，从1开始。 零组表示整个模式，所以表达式m。 start(0)等于m。 start() 。

toMatchResult

MatchResult toMatchResult ()

以MatchResult返回此匹配器的匹配状态。 结果不受随后在此匹配器上执行的操作的影响。

toString

String toString ()

返回此匹配器的字符串表示形式。 Matcher的字符串表示包含可能对调试有用的信息。 确切的格式是未指定的。

useAnchoringBounds

Matcher useAnchoringBounds (boolean value)

设置此匹配器的区域边界的锚定。

调用此方法的参数为true将设置此匹配器以使用锚定边界。 如果布尔参数是false ，则将使用非锚定边界。

使用锚定边界，匹配器的区域的边界匹配诸如^和$的锚点。

如果没有锚定边界，则此匹配器区域的边界将不匹配诸如^和$之类的锚点。

默认情况下，匹配器使用锚定区域边界。

usePattern

Matcher usePattern (Pattern newPattern)

更改 Pattern，这 Matcher用于查找与匹配。

此方法会导致此匹配程序丢失有关上次发生的匹配组的信息。 匹配器在输入中的位置保持不变，其最后的附加位置不受影响。

useTransparentBounds

Matcher useTransparentBounds (boolean value)

设置此匹配器的区域边界的透明度。

用参数true调用此方法将设置此匹配器以使用透明边界。 如果布尔参数是false ，那么将使用不透明边界。

使用透明边界，此匹配器区域的边界对前瞻，后视和边界匹配构造是透明的。 这些结构可以超越区域边界看到比赛是否合适。

使用不透明边界，该匹配器区域的边界对前瞻，后视和边界匹配构造是不透明的，这些构造可能试图超越它们。 这些构造不能超越边界，因此它们将无法匹配区域之外的任何东西。

默认情况下，匹配器使用不透明边界。