org.supercsv.cellprocessor.constraint.ForbidSubStr Maven / Gradle / Ivy

/*
 * Copyright 2007 Kasper B. Graversen
 * 
 * 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 org.supercsv.cellprocessor.constraint;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.supercsv.cellprocessor.CellProcessorAdaptor;
import org.supercsv.cellprocessor.ift.CellProcessor;
import org.supercsv.cellprocessor.ift.StringCellProcessor;
import org.supercsv.exception.SuperCsvCellProcessorException;
import org.supercsv.exception.SuperCsvConstraintViolationException;
import org.supercsv.util.CsvContext;

/**
 * Converts the input to a String and ensures that it doesn't contain any of the supplied substrings. For example, this
 * constraint might be handy when reading/writing filenames and wanting to ensure no filename contains ":", "/", etc.
 * 
 * @since 1.10
 * @author Kasper B. Graversen
 * @author James Bassett
 */
public class ForbidSubStr extends CellProcessorAdaptor implements StringCellProcessor {
	
	private final List forbiddenSubStrings = new ArrayList();
	
	/**
	 * Constructs a new ForbidSubStr processor which ensures the input doesn't contain any of the supplied
	 * substrings.
	 * 
	 * @param forbiddenSubStrings
	 *            the List of forbidden substrings
	 * @throws NullPointerException
	 *             if forbiddenSubStrings or one of its elements is null
	 * @throws IllegalArgumentException
	 *             if forbiddenSubStrings is empty
	 */
	public ForbidSubStr(final List forbiddenSubStrings) {
		super();
		checkPreconditions(forbiddenSubStrings);
		checkAndAddForbiddenStrings(forbiddenSubStrings);
	}
	
	/**
	 * Constructs a new ForbidSubStr processor which ensures the input doesn't contain any of the supplied
	 * substrings.
	 * 
	 * @param forbiddenSubStrings
	 *            the forbidden substrings
	 * @throws NullPointerException
	 *             if forbiddenSubStrings or one of its elements is null
	 * @throws IllegalArgumentException
	 *             if forbiddenSubStrings is empty
	 */
	public ForbidSubStr(final String... forbiddenSubStrings) {
		super();
		checkPreconditions(forbiddenSubStrings);
		checkAndAddForbiddenStrings(forbiddenSubStrings);
	}
	
	/**
	 * Constructs a new ForbidSubStr processor which ensures the input doesn't contain any of the supplied
	 * substrings, then calls the next processor in the chain.
	 * 
	 * @param forbiddenSubStrings
	 *            the List of forbidden substrings
	 * @param next
	 *            the next processor in the chain
	 * @throws NullPointerException
	 *             if forbiddenSubStrings, one of its elements or next is null
	 * @throws IllegalArgumentException
	 *             if forbiddenSubStrings is empty
	 */
	public ForbidSubStr(final List forbiddenSubStrings, final CellProcessor next) {
		super(next);
		checkPreconditions(forbiddenSubStrings);
		checkAndAddForbiddenStrings(forbiddenSubStrings);
	}
	
	/**
	 * Constructs a new ForbidSubStr processor which ensures the input doesn't contain the supplied substring,
	 * then calls the next processor in the chain.
	 * 
	 * @param forbiddenSubString
	 *            the forbidden substring
	 * @param next
	 *            the next processor in the chain
	 * @throws NullPointerException
	 *             if forbiddenSubString or next is null
	 */
	public ForbidSubStr(final String forbiddenSubString, final CellProcessor next) {
		this(new String[] { forbiddenSubString }, next);
	}
	
	/**
	 * Constructs a new ForbidSubStr processor which ensures the input doesn't contain any of the supplied
	 * substrings, then calls the next processor in the chain.
	 * 
	 * @param forbiddenSubStrings
	 *            the forbidden substrings
	 * @param next
	 *            the next processor in the chain
	 * @throws NullPointerException
	 *             if forbiddenSubStrings, one of its elements or next is null
	 * @throws IllegalArgumentException
	 *             if forbiddenSubStrings is empty
	 */
	public ForbidSubStr(final String[] forbiddenSubStrings, final CellProcessor next) {
		super(next);
		checkPreconditions(forbiddenSubStrings);
		checkAndAddForbiddenStrings(forbiddenSubStrings);
	}
	
	/**
	 * Checks the preconditions for creating a new ForbidSubStr processor with a List of forbidden substrings.
	 * 
	 * @param forbiddenSubStrings
	 *            the forbidden substrings
	 * @throws NullPointerException
	 *             if forbiddenSubStrings is null
	 * @throws IllegalArgumentException
	 *             if forbiddenSubStrings is empty
	 */
	private static void checkPreconditions(final List forbiddenSubStrings) {
		if( forbiddenSubStrings == null ) {
			throw new NullPointerException("forbiddenSubStrings list should not be null");
		} else if( forbiddenSubStrings.isEmpty() ) {
			throw new IllegalArgumentException("forbiddenSubStrings list should not be empty");
		}
	}
	
	/**
	 * Checks the preconditions for creating a new ForbidSubStr processor with an array of forbidden substrings.
	 * 
	 * @param forbiddenSubStrings
	 *            the forbidden substrings
	 * @throws NullPointerException
	 *             if forbiddenSubStrings is null
	 * @throws IllegalArgumentException
	 *             if forbiddenSubStrings is empty
	 */
	private static void checkPreconditions(final String... forbiddenSubStrings) {
		if( forbiddenSubStrings == null ) {
			throw new NullPointerException("forbiddenSubStrings array should not be null");
		} else if( forbiddenSubStrings.length == 0 ) {
			throw new IllegalArgumentException("forbiddenSubStrings array should not be empty");
		}
	}
	
	/**
	 * Adds each forbidden substring, checking that it's not null.
	 * 
	 * @param forbiddenSubStrings
	 *            the forbidden substrings
	 * @throws NullPointerException
	 *             if a forbidden substring is null
	 */
	private void checkAndAddForbiddenStrings(final String... forbiddenSubStrings) {
		checkAndAddForbiddenStrings(Arrays.asList(forbiddenSubStrings));
	}
	
	/**
	 * Adds each forbidden substring, checking that it's not null.
	 * 
	 * @param forbiddenSubStrings
	 *            the forbidden substrings
	 * @throws NullPointerException
	 *             if a forbidden substring is null
	 */
	private void checkAndAddForbiddenStrings(final List forbiddenSubStrings) {
		for( String forbidden : forbiddenSubStrings ) {
			if( forbidden == null ) {
				throw new NullPointerException("forbidden substring should not be null");
			}
			this.forbiddenSubStrings.add(forbidden);
		}
	}
	
	/**
	 * {@inheritDoc}
	 * 
	 * @throws SuperCsvCellProcessorException
	 *             if value is null
	 * @throws SuperCsvConstraintViolationException
	 *             if value is in the forbidden list
	 */
	public Object execute(final Object value, final CsvContext context) {
		validateInputNotNull(value, context);
		
		final String stringValue = value.toString();
		
		for( String forbidden : forbiddenSubStrings ) {
			if( stringValue.contains(forbidden) ) {
				throw new SuperCsvConstraintViolationException(String.format(
					"'%s' contains the forbidden substring '%s'", value, forbidden), context, this);
			}
		}
		
		return next.execute(value, context);
	}
}