Java String Tokenize tokenizeQuotedStrings(final String aInput, final String aDelimiters)

Description

Tokenizes a given input stream and breaks it into parts on the given delimiters.

License

Open Source License

Parameter

Parameter	Description
aInput	the input string to tokenize, can be <code>null</code>;
aDelimiters	the delimiter <em>characters</em> to break the given input on, cannot be <code>null</code>.

Return

the individual tokens of the given input, or null if the original input was null.

Declaration

public static String[] tokenizeQuotedStrings(final String aInput, final String aDelimiters) 

Method Source Code

//package com.java2s;
/*// www . j a  va2 s  .co m
 * OpenBench LogicSniffer / SUMP project 
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
 *
 * 
 * Copyright (C) 2010-2011 J.W. Janssen, www.lxtreme.nl
 */

import java.util.*;

public class Main {
    /**
     * Tokenizes a given input stream and breaks it into parts on the given
     * delimiters. The tokens are considered to be double quoted strings.
     * 
     * @param aInput
     *          the input string to tokenize, can be <code>null</code>;
     * @param aDelimiters
     *          the delimiter <em>characters</em> to break the given input on,
     *          cannot be <code>null</code>.
     * @return the individual tokens of the given input, or <code>null</code> if
     *         the original input was <code>null</code>.
     */
    public static String[] tokenizeQuotedStrings(final String aInput, final String aDelimiters) {
        if (aInput == null) {
            return null;
        }

        final List<String> result = new ArrayList<String>();

        String lookback = "";
        boolean inQuotedString = false;

        final StringTokenizer tokenizer = new StringTokenizer(aInput, aDelimiters, true /* returnDelims */);
        while (tokenizer.hasMoreTokens()) {
            String token = tokenizer.nextToken();

            if (!inQuotedString && token.startsWith("\"") && !token.endsWith("\"")) {
                inQuotedString = true;
                lookback = token;
            } else if (inQuotedString) {
                lookback = lookback.concat(token);
                if (token.endsWith("\"")) {
                    inQuotedString = false;
                    token = lookback;
                }
            }

            if (!inQuotedString && !isDelimiter(token, aDelimiters)) {
                result.add(token);
            }
        }

        // Last step is to unquote all results...
        final ListIterator<String> iter = result.listIterator();
        while (iter.hasNext()) {
            final String token = iter.next();
            iter.set(unquote(token));
        }

        return result.toArray(new String[result.size()]);
    }

    /**
     * @param aInput
     * @param aDelimiters
     * @return
     */
    private static boolean isDelimiter(final String aInput, final String aDelimiters) {
        final String regex = "^[" + aDelimiters + "]+$";
        return aInput.matches(regex);
    }

    /**
     * Removes all double quotes from the given input.
     * 
     * @param aInput
     *          the input string to remove the quotes from, may be
     *          <code>null</code>.
     * @return the unquoted version of the given input, or <code>null</code> if
     *         the original input was <code>null</code>.
     * @see #unquote(String, char)
     */
    public static String unquote(final String aInput) {
        return unquote(aInput, '"');
    }

    /**
     * Removes all quotes, denoted by the given character, from the given input.
     * 
     * @param aInput
     *          the input string to remove the quotes from, may be
     *          <code>null</code>;
     * @param aQuoteChar
     *          the quote character to remove.
     * @return the unquoted version of the given input, or <code>null</code> if
     *         the original input was <code>null</code>. If the given input
     *         contained leading and/or trailing whitespace, it is removed from
     *         the result.
     */
    public static String unquote(final String aInput, final char aQuoteChar) {
        if (aInput == null) {
            return null;
        }

        final String quoteChar = Character.toString(aQuoteChar);

        String result = aInput.trim();
        if (result.startsWith(quoteChar) && result.endsWith(quoteChar)) {
            result = result.substring(1, result.length() - 1);
        }
        return result;
    }
}

Related

1. tokenizeNumbersFromString(String stream)
2. tokenizeOnWhitespace(String input)
3. tokenizePath(String path)
4. tokenizePathAsArray(String path)
5. tokenizePattern(String pattern)
6. tokenizeQuotes(String f1)
7. tokenizeStatement(String statement)
8. tokenizeString(final String inputString, final String seperator)
9. tokenizeString(String inString, char delimiter, String enclosures)