001    /*--------------------------------------------------------------------------+
002    $Id: IRegexReplacement.java 26283 2010-02-18 11:18:57Z juergens $
003    |                                                                          |
004    | Copyright 2005-2010 Technische Universitaet Muenchen                     |
005    |                                                                          |
006    | Licensed under the Apache License, Version 2.0 (the "License");          |
007    | you may not use this file except in compliance with the License.         |
008    | You may obtain a copy of the License at                                  |
009    |                                                                          |
010    |    http://www.apache.org/licenses/LICENSE-2.0                            |
011    |                                                                          |
012    | Unless required by applicable law or agreed to in writing, software      |
013    | distributed under the License is distributed on an "AS IS" BASIS,        |
014    | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
015    | See the License for the specific language governing permissions and      |
016    | limitations under the License.                                           |
017    +--------------------------------------------------------------------------*/
018    package edu.tum.cs.commons.string;
019    
020    import java.util.regex.Pattern;
021    
022    /**
023     * This interface describe a replacement to be performed on a string. Syntax for
024     * patterns and replacements is specified in the API documentation of
025     * {@link java.util.regex.Pattern} and {@link java.util.regex.Matcher}.
026     * 
027     * @author Florian Deissenboeck
028     * @author $Author: juergens $
029     * @version $Rev: 26283 $
030     * @levd.rating GREEN Hash: C83D23458FC9BBD5E38FC9C40D2E7EC1
031     */
032    public interface IRegexReplacement {
033        /** The pattern to match. */
034        public Pattern getPattern();
035    
036        /**
037         * The replacement for the pattern. The empty string may be used to define a
038         * deletion.
039         */
040        public String getReplacement();
041    }