blob: 7938d8beb98d1003fbe1d9797eb178b3c1d35a70 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.tools.ant.util.regexp;
import java.util.Vector;
import org.apache.tools.ant.BuildException;
/**
* Interface describing a regular expression matcher.
*
*/
public interface RegexpMatcher {
/***
* Default Mask (case insensitive, neither multiline nor
* singleline specified).
*/
int MATCH_DEFAULT = 0x00000000;
/***
* Perform a case insensitive match
*/
int MATCH_CASE_INSENSITIVE = 0x00000100;
/***
* Treat the input as a multiline input
*/
int MATCH_MULTILINE = 0x00001000;
/***
* Treat the input as singleline input ('.' matches newline)
*/
int MATCH_SINGLELINE = 0x00010000;
/**
* Set the regexp pattern from the String description.
* @param pattern the pattern to match
* @throws BuildException on error
*/
void setPattern(String pattern) throws BuildException;
/**
* Get a String representation of the regexp pattern
* @return the pattern
* @throws BuildException on error
*/
String getPattern() throws BuildException;
/**
* Does the given argument match the pattern?
* @param argument the string to match against
* @return true if the pattern matches
* @throws BuildException on error
*/
boolean matches(String argument) throws BuildException;
/**
* Returns a Vector of matched groups found in the argument
* using default options.
*
* <p>Group 0 will be the full match, the rest are the
* parenthesized subexpressions</p>.
*
* @param argument the string to match against
* @return the vector of groups
* @throws BuildException on error
*/
Vector getGroups(String argument) throws BuildException;
/***
* Does this regular expression match the input, given
* certain options
* @param input The string to check for a match
* @param options The list of options for the match. See the
* MATCH_ constants above.
* @return true if the pattern matches
* @throws BuildException on error
*/
boolean matches(String input, int options) throws BuildException;
/***
* Get the match groups from this regular expression. The return
* type of the elements is always String.
* @param input The string to check for a match
* @param options The list of options for the match. See the
* MATCH_ constants above.
* @return the vector of groups
* @throws BuildException on error
*/
Vector getGroups(String input, int options) throws BuildException;
}
|
