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