org.kuali.common.util.Str Maven / Gradle / Ivy
/**
* Copyright 2010-2014 The Kuali Foundation
*
* Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
*
* 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.kuali.common.util;
import static org.apache.commons.lang3.StringUtils.replace;
import static org.apache.commons.lang3.StringUtils.trim;
import static org.kuali.common.util.Encodings.ASCII;
import java.io.UnsupportedEncodingException;
import java.util.List;
import org.apache.commons.lang3.StringUtils;
/**
* Operations on String that are null safe
*/
public class Str {
public static final String EMPTY_STRING = "";
public static final String UTF8 = Encodings.UTF8;
public static final String COMMA = ",";
public static final String SPACE = " ";
public static final String CR = "\r";
public static final String LF = "\n";
public static final String DOT = ".";
public static final String COLON = ":";
public static final String FORWARD_SLASH = "/";
public static final char DOUBLE_QUOTE = '"';
public static final String CDATA_PREFIX = "";
public static final String[] EMPTY_ARRAY = new String[0];
private static final String CONCEALED_PREFIX = "cnc--";
/**
*
* A trivial way to conceal text. Can be reversed using reveal(). Do NOT use this method in an attempt to obscure sensitive data. The algorithm
* is completely trivial and exceedingly simple to reverse engineer. Not to mention, the reveal() method can reproduce the original string without requiring any
* secret knowledge.
*
*
*
* The use case here is to help prevent someone with otherwise mostly good intentions from altering a piece of information in a way they should not. This is NOT intended
* to defeat any serious attempt at discovering the original text.
*
*
*
* Think a hungry sales or marketing rep who stumbles across a config file with the entry vending.machine.refill.day=wed in it and tries to change that to
* mon in order to beat a case of the munchies. :)
*
*
*
* If the entry says vending.machine.refill.day=cnc--jrq instead of vending.machine.refill.day=wed they are far more likely to ask around before they
* change it OR just give up and head out to lunch instead.
*
*
* @see reveal
*/
public static final String conceal(String text) {
if (text == null) {
return null;
}
Assert.noBlanks(text);
if (isConcealed(text)) {
return text;
}
Assert.notConcealed(text);
char[] chars = text.toCharArray();
StringBuilder sb = new StringBuilder();
sb.append(CONCEALED_PREFIX);
for (char c : chars) {
sb.append(Ascii.flip(c));
}
return sb.toString();
}
/**
* Reveal the original contents of a string concealed by the conceal method.
*
* @see conceal
*/
public static final String reveal(String text) {
if (text == null) {
return null;
}
Assert.noBlanks(text);
if (!isConcealed(text)) {
return text;
}
Assert.concealed(text);
String substring = removePrefix(text, CONCEALED_PREFIX);
char[] chars = substring.toCharArray();
StringBuilder sb = new StringBuilder();
for (char c : chars) {
sb.append(Ascii.flip(c));
}
return sb.toString();
}
/**
* Return true if text is concealed
*/
public static final boolean isConcealed(String text) {
return StringUtils.startsWith(text, CONCEALED_PREFIX);
}
/**
* If strings are null return EMPTY_ARRAY, otherwise return strings.
*/
public static final String[] toEmptyArray(String[] strings) {
if (strings == null) {
return EMPTY_ARRAY;
} else {
return strings;
}
}
/**
* Convert the tokens into a string delimited by the colon ":" character
*
*
* "foo","bar" ,"baz" -> foo:bar:baz
* "foo", null ,"baz" -> foo::baz
* "foo", "" ,"baz" -> foo::baz
* "foo", null , null -> foo::
* null,"bar" , null -> :bar:
*
*/
public static final String getId(String... tokens) {
if (tokens == null) {
return null;
}
StringBuilder sb = new StringBuilder();
for (int i = 0; i < tokens.length; i++) {
if (i != 0) {
sb.append(COLON);
}
sb.append(StringUtils.trimToEmpty(tokens[i]));
}
return sb.toString();
}
/**
* Turn the string into CDATA - http://en.wikipedia.org/wiki/CDATA
*/
public static final String cdata(String s) {
if (s == null) {
return null;
} else {
return CDATA_PREFIX + s + CDATA_SUFFIX;
}
}
/**
* If s ends with suffix, remove it
*/
public static final String removeSuffix(String s, String suffix) {
if (StringUtils.endsWith(s, suffix)) {
int end = StringUtils.length(s) - StringUtils.length(suffix);
return StringUtils.substring(s, 0, end);
} else {
return s;
}
}
/**
* If s starts with prefix, remove it
*/
public static final String removePrefix(String s, String prefix) {
if (StringUtils.startsWith(s, prefix)) {
int beginIndex = StringUtils.length(prefix);
return StringUtils.substring(s, beginIndex);
} else {
return s;
}
}
/**
* Return true if s starts with prefix and ends with suffix
*/
public static final boolean matches(String s, String prefix, String suffix) {
return StringUtils.startsWith(s, prefix) && StringUtils.endsWith(s, suffix);
}
public static final String remove(String s, String prefix, String suffix) {
String returnValue = s;
returnValue = removePrefix(returnValue, prefix);
returnValue = removeSuffix(returnValue, suffix);
return returnValue;
}
/**
* If s is null return "" otherwise return s
*/
public static final String toEmpty(String s) {
if (s == null) {
return "";
} else {
return s;
}
}
public static final String getAsciiString(byte[] bytes) {
return getString(bytes, ASCII);
}
public static final String getUTF8String(byte[] bytes) {
return getString(bytes, UTF8);
}
public static final String getString(byte[] bytes, String encoding) {
if (bytes == null) {
return null;
}
if (encoding == null) {
return new String(bytes);
}
try {
return new String(bytes, encoding);
} catch (UnsupportedEncodingException e) {
throw new IllegalArgumentException(e);
}
}
public static final byte[] getAsciiBytes(String s) {
if (s == null) {
return null;
} else {
return getBytes(s, ASCII);
}
}
public static final byte[] getUTF8Bytes(String s) {
if (s == null) {
return null;
} else {
return getBytes(s, UTF8);
}
}
public static final byte[] getBytes(String s, String encoding) {
if (s == null) {
return null;
}
if (encoding == null) {
return s.getBytes();
}
try {
return s.getBytes(encoding);
} catch (UnsupportedEncodingException e) {
throw new IllegalArgumentException(e);
}
}
public static final boolean contains(List tokens, String value, boolean caseSensitive) {
for (String token : tokens) {
if (equals(token, value, caseSensitive)) {
return true;
}
}
return false;
}
public static final boolean equals(String s1, String s2, boolean caseSensitive) {
if (caseSensitive) {
return StringUtils.equals(s1, s2);
} else {
return StringUtils.equalsIgnoreCase(s1, s2);
}
}
/**
* Combine tokens into a String
*/
public static final String toString(String[] tokens) {
if (tokens == null) {
return null;
}
StringBuilder sb = new StringBuilder();
for (String token : tokens) {
sb.append(token);
}
return sb.toString();
}
/**
* Convert dots to forward slashes and trim.
*/
public static final String getPath(String s) {
return trim(replace(s, DOT, FORWARD_SLASH));
}
/**
* Surround the string with double quotes.
*/
public static final String quote(String s) {
return s == null ? null : DOUBLE_QUOTE + s + DOUBLE_QUOTE;
}
/**
* Split comma separated values into tokens, optionally trimming the tokens.
*/
public static final String[] splitCSV(String csv, boolean trim) {
return split(csv, COMMA, trim);
}
/**
* Split comma separated values into tokens, trimming as we go.
*/
public static final String[] splitAndTrimCSV(String csv) {
return splitCSV(csv, true);
}
/**
* Split the string into tokens using the indicated separator, trimming as we go.
*/
public static final String[] splitAndTrim(String s, String separatorChars) {
return split(s, separatorChars, true);
}
/**
* Split the string into tokens using the indicated separator chars, optionally trimming the tokens.
*/
public static final String[] split(String s, String separatorChars, boolean trim) {
String[] tokens = StringUtils.split(s, separatorChars);
if (tokens == null) {
return null;
}
for (int i = 0; i < tokens.length; i++) {
tokens[i] = trim ? StringUtils.trim(tokens[i]) : tokens[i];
}
return tokens;
}
/**
* Replace carriage returns and linefeeds with a space
*/
public static final String flatten(String s) {
return flatten(s, SPACE, SPACE);
}
/**
* Replace carriage returns with cr and linefeeds with lf.
*/
public static final String flatten(String s, String cr, String lf) {
return StringUtils.replace(StringUtils.replace(s, CR, cr), LF, lf);
}
/**
* Replace cr with carriage return and lf with linefeed.
*/
public static final String inflate(String s, String cr, String lf) {
return StringUtils.replace(StringUtils.replace(s, cr, CR), lf, LF);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy