com.univocity.parsers.conversions.RegexConversion Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of univocity-parsers Show documentation
Show all versions of univocity-parsers Show documentation
univocity's open source parsers for processing different text formats using a consistent API
/*******************************************************************************
* Copyright 2014 uniVocity Software Pty Ltd
*
* Licensed 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 com.univocity.parsers.conversions;
/**
* Replaces contents of a given input String, identified by a regular expression, with a replacement String.
*
* The {@link RegexConversion#revert(String)} implements the same behavior of {@link RegexConversion#execute(String)}. Null inputs produce null outputs.
*
* @author uniVocity Software Pty Ltd - [email protected]
*
*/
public class RegexConversion implements Conversion {
private final String replaceRegex;
private final String replacement;
/**
* Creates a conversion that matches contents identified by the given regular expression and replaces them by the given replacement String.
* @param replaceRegex the regular expression used to match contents of a given input String
* @param replacement the replacement content to replace any contents matched by the given regular expression
*/
public RegexConversion(String replaceRegex, String replacement) {
this.replaceRegex = replaceRegex;
this.replacement = replacement;
}
/**
* Executes the regular expression provided in the constructor of this class against the input and replaces any matched content with the replacement String.
* Equivalent to {@link RegexConversion#revert(String)}
* @param input The input to have contents matched by the regular expression and replaced
* @return The String resulting from the content replacement
*/
@Override
public String execute(String input) {
if (input == null) {
return null;
}
return input.replaceAll(replaceRegex, replacement);
}
/**
* Executes the regular expression provided in the constructor of this class against the input and replaces any matched content with the replacement String.
* Equivalent to {@link RegexConversion#execute(String)}
* @param input The input to have contents matched by the regular expression and replaced
* @return The String resulting from the content replacement
*/
@Override
public String revert(String input) {
return execute(input);
}
}