StringUtils.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2023 The Gridarta Developers.
 *
 * 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 Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
package net.sf.gridarta.utils;
 
import java.util.Arrays;
import java.util.regex.Pattern;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class StringUtils {
 
    @NotNull
    public static final Pattern PATTERN_WHITESPACE = Pattern.compile("[\\x00-\\x09\\x0b\\x20]+");
 
    @NotNull
    public static final Pattern PATTERN_WHITESPACE_NEWLINE = Pattern.compile("[\\x00-\\x0b\\x0d\\x20]+");
 
    @NotNull
    private static final Pattern PATTERN_TRAILING_WHITESPACE = Pattern.compile("[\\x00-\\x09\\x0b\\x20]+$");
 
    @NotNull
    private static final Pattern PATTERN_MULTI_LINE_TRAILING_WHITESPACE = Pattern.compile("(?m)[\\x00-\\x09\\x0b\\x20]+$");
 
    @NotNull
    public static final Pattern PATTERN_END_OF_LINE = Pattern.compile("\\s*\n");
 
    @NotNull
    public static final Pattern PATTERN_SPACE = Pattern.compile(" ");
 
    @NotNull
    public static final Pattern PATTERN_SPACES = Pattern.compile(" +");
 
    @NotNull
    public static final Pattern PATTERN_SLASH = Pattern.compile("/");
 
    @NotNull
    public static final Pattern PATTERN_BACKSLASH = Pattern.compile("\\\\");
 
    @NotNull
    public static final Pattern PATTERN_COLON = Pattern.compile(":");
 
    @NotNull
    public static final Pattern PATTERN_COMMA = Pattern.compile(",");
 
    @NotNull
    public static final Pattern PATTERN_EQUAL = Pattern.compile("=");
 
    @NotNull
    public static final Pattern PATTERN_NEWLINE = Pattern.compile("\n");
 
    private StringUtils() {
    }
 
    @NotNull
    public static String removeTrailingWhitespace(@NotNull final CharSequence str) {
        return PATTERN_TRAILING_WHITESPACE.matcher(str).replaceFirst("");
    }
 
    @NotNull
    public static String removeTrailingWhitespaceFromLines(@NotNull final CharSequence str) {
        return PATTERN_MULTI_LINE_TRAILING_WHITESPACE.matcher(str).replaceAll("");
    }
 
    @NotNull
    public static CharSequence ensureTrailingNewline(@NotNull final String str) {
        return str.length() <= 0 ? "" : str.endsWith("\n") ? str : str + "\n";
    }
 
    @Nullable
    public static CharSequence diffTextString(@NotNull final CharSequence base, @NotNull final String str, final boolean ignoreValues) {
        for (final String line : PATTERN_END_OF_LINE.split(base, 0)) {
            if (ignoreValues ? line.startsWith(str) : line.equals(str)) {
                return line;
            }
        }
        return null;
    }
 
    @Nullable
    public static String getAttribute(@NotNull final CharSequence attributes, @NotNull final String attributeName) {
        final String str = attributeName + " ";
        for (final String line : PATTERN_END_OF_LINE.split(attributes, 0)) {
            if (line.startsWith(str)) {
                return line.substring(str.length());
            }
        }
        return null;
    }
 
    @NotNull
    public static String sortLines(@NotNull final CharSequence string) {
        final String[] lines = PATTERN_NEWLINE.split(string, -1);
        Arrays.sort(lines);
        final StringBuilder sb = new StringBuilder();
        for (final String line : lines) {
            sb.append(line).append('\n');
        }
        return sb.toString();
    }
 
}