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