Gridarta Editor
StringUtils.java
Go to the documentation of this file.
1 /*
2  * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
3  * Copyright (C) 2000-2023 The Gridarta Developers.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
20 package net.sf.gridarta.utils;
21 
22 import java.util.Arrays;
23 import java.util.regex.Pattern;
24 import org.jetbrains.annotations.NotNull;
25 import org.jetbrains.annotations.Nullable;
26 
31 public class StringUtils {
32 
36  @NotNull
37  public static final Pattern PATTERN_WHITESPACE = Pattern.compile("[\\x00-\\x09\\x0b\\x20]+");
38 
42  @NotNull
43  public static final Pattern PATTERN_WHITESPACE_NEWLINE = Pattern.compile("[\\x00-\\x0b\\x0d\\x20]+");
44 
48  @NotNull
49  private static final Pattern PATTERN_TRAILING_WHITESPACE = Pattern.compile("[\\x00-\\x09\\x0b\\x20]+$");
50 
54  @NotNull
55  private static final Pattern PATTERN_MULTI_LINE_TRAILING_WHITESPACE = Pattern.compile("(?m)[\\x00-\\x09\\x0b\\x20]+$");
56 
60  @NotNull
61  public static final Pattern PATTERN_END_OF_LINE = Pattern.compile("\\s*\n");
62 
66  @NotNull
67  public static final Pattern PATTERN_SPACE = Pattern.compile(" ");
68 
72  @NotNull
73  public static final Pattern PATTERN_SPACES = Pattern.compile(" +");
74 
78  @NotNull
79  public static final Pattern PATTERN_SLASH = Pattern.compile("/");
80 
84  @NotNull
85  public static final Pattern PATTERN_BACKSLASH = Pattern.compile("\\\\");
86 
90  @NotNull
91  public static final Pattern PATTERN_COLON = Pattern.compile(":");
92 
96  @NotNull
97  public static final Pattern PATTERN_COMMA = Pattern.compile(",");
98 
102  @NotNull
103  public static final Pattern PATTERN_EQUAL = Pattern.compile("=");
104 
108  @NotNull
109  public static final Pattern PATTERN_NEWLINE = Pattern.compile("\n");
110 
114  private StringUtils() {
115  }
116 
122  @NotNull
123  public static String removeTrailingWhitespace(@NotNull final CharSequence str) {
124  return PATTERN_TRAILING_WHITESPACE.matcher(str).replaceFirst("");
125  }
126 
132  @NotNull
133  public static String removeTrailingWhitespaceFromLines(@NotNull final CharSequence str) {
134  return PATTERN_MULTI_LINE_TRAILING_WHITESPACE.matcher(str).replaceAll("");
135  }
136 
145  @NotNull
146  public static CharSequence ensureTrailingNewline(@NotNull final String str) {
147  return str.length() <= 0 ? "" : str.endsWith("\n") ? str : str + "\n";
148  }
149 
161  @Nullable
162  public static CharSequence diffTextString(@NotNull final CharSequence base, @NotNull final String str, final boolean ignoreValues) {
163  for (final String line : PATTERN_END_OF_LINE.split(base, 0)) {
164  if (ignoreValues ? line.startsWith(str) : line.equals(str)) {
165  return line;
166  }
167  }
168  return null;
169  }
170 
180  @Nullable
181  public static String getAttribute(@NotNull final CharSequence attributes, @NotNull final String attributeName) {
182  final String str = attributeName + " ";
183  for (final String line : PATTERN_END_OF_LINE.split(attributes, 0)) {
184  if (line.startsWith(str)) {
185  return line.substring(str.length());
186  }
187  }
188  return null;
189  }
190 
196  @NotNull
197  public static String sortLines(@NotNull final CharSequence string) {
198  final String[] lines = PATTERN_NEWLINE.split(string, -1);
199  Arrays.sort(lines);
200  final StringBuilder sb = new StringBuilder();
201  for (final String line : lines) {
202  sb.append(line).append('\n');
203  }
204  return sb.toString();
205  }
206 
207 }
net.sf.gridarta.utils.StringUtils.StringUtils
StringUtils()
Private constructor to prevent instantiation.
Definition: StringUtils.java:114
net.sf.gridarta.utils.StringUtils.PATTERN_SLASH
static final Pattern PATTERN_SLASH
The pattern that matches a single slash ("/").
Definition: StringUtils.java:79
net.sf.gridarta.utils.StringUtils.PATTERN_COLON
static final Pattern PATTERN_COLON
The pattern that matches a single colon (":").
Definition: StringUtils.java:91
net.sf.gridarta.utils.StringUtils.PATTERN_TRAILING_WHITESPACE
static final Pattern PATTERN_TRAILING_WHITESPACE
Pattern to match trailing whitespace.
Definition: StringUtils.java:49
net.sf.gridarta.utils.StringUtils.PATTERN_WHITESPACE
static final Pattern PATTERN_WHITESPACE
Pattern to match whitespace excluding NL and CR.
Definition: StringUtils.java:37
net.sf.gridarta.utils.StringUtils.removeTrailingWhitespace
static String removeTrailingWhitespace(@NotNull final CharSequence str)
Removes trailing whitespace from a string.
Definition: StringUtils.java:123
net.sf.gridarta.utils.StringUtils.PATTERN_END_OF_LINE
static final Pattern PATTERN_END_OF_LINE
The pattern to match end of line characters separating lines.
Definition: StringUtils.java:61
net.sf.gridarta.utils.StringUtils.diffTextString
static CharSequence diffTextString(@NotNull final CharSequence base, @NotNull final String str, final boolean ignoreValues)
Helper function for 'diffArchText()': Looks for occurrence of the attribute 'str' in 'base' and if fo...
Definition: StringUtils.java:162
net.sf.gridarta.utils.StringUtils.PATTERN_MULTI_LINE_TRAILING_WHITESPACE
static final Pattern PATTERN_MULTI_LINE_TRAILING_WHITESPACE
Pattern to match trailing whitespace in a multi line string.
Definition: StringUtils.java:55
net.sf.gridarta.utils.StringUtils.PATTERN_SPACE
static final Pattern PATTERN_SPACE
The pattern that matches a single space.
Definition: StringUtils.java:67
net.sf.gridarta.utils.StringUtils.PATTERN_WHITESPACE_NEWLINE
static final Pattern PATTERN_WHITESPACE_NEWLINE
Pattern to match whitespace including NL and CR.
Definition: StringUtils.java:43
net.sf.gridarta.utils.StringUtils
Utility class for string manipulation.
Definition: StringUtils.java:31
net.sf.gridarta.utils.StringUtils.getAttribute
static String getAttribute(@NotNull final CharSequence attributes, @NotNull final String attributeName)
Returns an attribute line from a set of attribute definitions.
Definition: StringUtils.java:181
net.sf.gridarta.utils.StringUtils.sortLines
static String sortLines(@NotNull final CharSequence string)
Sorts newline separated lines in a string.
Definition: StringUtils.java:197
net.sf.gridarta.utils.StringUtils.PATTERN_COMMA
static final Pattern PATTERN_COMMA
The pattern that matches a single comma (",").
Definition: StringUtils.java:97
net.sf.gridarta.utils.StringUtils.PATTERN_NEWLINE
static final Pattern PATTERN_NEWLINE
The pattern that matches a single newline ("\n").
Definition: StringUtils.java:109
net.sf.gridarta.utils.StringUtils.ensureTrailingNewline
static CharSequence ensureTrailingNewline(@NotNull final String str)
Returns a given string which ends with a trailing newline character; empty strings remain empty.
Definition: StringUtils.java:146
net.sf.gridarta.utils.StringUtils.PATTERN_SPACES
static final Pattern PATTERN_SPACES
The pattern that matches a non-empty sequence of spaces.
Definition: StringUtils.java:73
net.sf.gridarta.utils.StringUtils.PATTERN_BACKSLASH
static final Pattern PATTERN_BACKSLASH
The pattern that matches a single backslash ("\").
Definition: StringUtils.java:85
net.sf.gridarta.utils.StringUtils.removeTrailingWhitespaceFromLines
static String removeTrailingWhitespaceFromLines(@NotNull final CharSequence str)
Removes trailing whitespace from all lines of a string.
Definition: StringUtils.java:133
net.sf.gridarta.utils.StringUtils.PATTERN_EQUAL
static final Pattern PATTERN_EQUAL
The pattern that matches a single equal sign ("=").
Definition: StringUtils.java:103