1 | /*
|
---|
2 | * Copyright 2001-2002,2004 The Apache Software Foundation
|
---|
3 | *
|
---|
4 | * Licensed under the Apache License, Version 2.0 (the "License");
|
---|
5 | * you may not use this file except in compliance with the License.
|
---|
6 | * You may obtain a copy of the License at
|
---|
7 | *
|
---|
8 | * http://www.apache.org/licenses/LICENSE-2.0
|
---|
9 | *
|
---|
10 | * Unless required by applicable law or agreed to in writing, software
|
---|
11 | * distributed under the License is distributed on an "AS IS" BASIS,
|
---|
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
---|
13 | * See the License for the specific language governing permissions and
|
---|
14 | * limitations under the License.
|
---|
15 | *
|
---|
16 | */
|
---|
17 | package org.apache.tools.ant.util.regexp;
|
---|
18 |
|
---|
19 | import org.apache.tools.ant.BuildException;
|
---|
20 |
|
---|
21 | /***
|
---|
22 | * Interface which represents a regular expression, and the operations
|
---|
23 | * that can be performed on it.
|
---|
24 | *
|
---|
25 | */
|
---|
26 | public interface Regexp extends RegexpMatcher {
|
---|
27 |
|
---|
28 | /**
|
---|
29 | * Replace only the first occurance of the regular expression
|
---|
30 | */
|
---|
31 | int REPLACE_FIRST = 0x00000001;
|
---|
32 |
|
---|
33 | /**
|
---|
34 | * Replace all occurances of the regular expression
|
---|
35 | */
|
---|
36 | int REPLACE_ALL = 0x00000010;
|
---|
37 |
|
---|
38 | /**
|
---|
39 | * Perform a substitution on the regular expression.
|
---|
40 | * @param input The string to substitute on
|
---|
41 | * @param argument The string which defines the substitution
|
---|
42 | * @param options The list of options for the match and replace. See the
|
---|
43 | * MATCH_ and REPLACE_ constants above.
|
---|
44 | * @return the result of the operation
|
---|
45 | * @throws BuildException on error
|
---|
46 | */
|
---|
47 | String substitute(String input, String argument, int options)
|
---|
48 | throws BuildException;
|
---|
49 | }
|
---|