org.acegisecurity.util.StringSplitUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of acegi-security
There is a newer version: 1.0.7
/* Copyright 2004, 2005 Acegi Technology Pty Limited
 *
 * 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.acegisecurity.util;

import org.springframework.util.Assert;
import org.springframework.util.StringUtils;

import java.util.HashMap;
import java.util.Map;


/**
 * Provides several String manipulation methods.
 *
 * @author Ben Alex
 * @version $Id: StringSplitUtils.java,v 1.3 2005/11/17 00:56:09 benalex Exp $
 */
public class StringSplitUtils {
    //~ Methods ================================================================

    /**
     * Splits a String at the first instance of the delimiter.
     * 
     * 
     * Does not include the delimiter in the response.
     * 
     *
     * @param toSplit the string to split
     * @param delimiter to split the string up with
     *
     * @return a two element array with index 0 being before the delimiter, and
     *         index 1 being after the delimiter (neither element includes the
     *         delimiter)
     *
     * @throws IllegalArgumentException if an argument was invalid
     */
    public static String[] split(String toSplit, String delimiter) {
        Assert.hasLength(toSplit, "Cannot split a null or empty string");
        Assert.hasLength(delimiter,
            "Cannot use a null or empty delimiter to split a string");

        if (delimiter.length() != 1) {
            throw new IllegalArgumentException(
                "Delimiter can only be one character in length");
        }

        int offset = toSplit.indexOf(delimiter);

        if (offset < 0) {
            return null;
        }

        String beforeDelimiter = toSplit.substring(0, offset);
        String afterDelimiter = toSplit.substring(offset + 1);

        return new String[] {beforeDelimiter, afterDelimiter};
    }

    /**
     * Takes an array of Strings, and for each element removes any
     * instances of removeCharacter, and splits the element based
     * on the delimiter. A Map is then generated,
     * with the left of the delimiter providing the key, and the right of the
     * delimiter providing the value.
     * 
     * 
     * Will trim both the key and value before adding to the Map.
     * 
     *
     * @param array the array to process
     * @param delimiter to split each element using (typically the equals
     *        symbol)
     * @param removeCharacters one or more characters to remove from each
     *        element prior to attempting the split operation (typically the
     *        quotation mark symbol) or null if no removal should
     *        occur
     *
     * @return a Map representing the array contents, or
     *         null if the array to process was null or empty
     */
    public static Map splitEachArrayElementAndCreateMap(String[] array,
        String delimiter, String removeCharacters) {
        if ((array == null) || (array.length == 0)) {
            return null;
        }

        Map map = new HashMap();

        for (int i = 0; i < array.length; i++) {
            String postRemove;

            if (removeCharacters == null) {
                postRemove = array[i];
            } else {
                postRemove = StringUtils.replace(array[i], removeCharacters, "");
            }

            String[] splitThisArrayElement = split(postRemove, delimiter);

            if (splitThisArrayElement == null) {
                continue;
            }

            map.put(splitThisArrayElement[0].trim(),
                splitThisArrayElement[1].trim());
        }

        return map;
    }
}