com.Ostermiller.util.StringHelper Maven / Gradle / Ivy
/*
* Static String formatting and query routines.
* Copyright (C) 2001-2005 Stephen Ostermiller
* http://ostermiller.org/contact.pl?regarding=Java+Utilities
*
* 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.
*
* See COPYING.TXT for details.
*/
package com.Ostermiller.util;
import java.util.HashMap;
import java.util.regex.Pattern;
/**
* Utilities for String formatting, manipulation, and queries.
* More information about this class is available from ostermiller.org.
*
* @author Stephen Ostermiller http://ostermiller.org/contact.pl?regarding=Java+Utilities
* @since ostermillerutils 1.00.00
*/
public class StringHelper {
/**
* Pad the beginning of the given String with spaces until
* the String is of the given length.
*
* If a String is longer than the desired length,
* it will not be truncated, however no padding
* will be added.
*
* @param s String to be padded.
* @param length desired length of result.
* @return padded String.
* @throws NullPointerException if s is null.
*
* @since ostermillerutils 1.00.00
*/
public static String prepad(String s, int length){
return prepad(s, length, ' ');
}
/**
* Pre-pend the given character to the String until
* the result is the desired length.
*
* If a String is longer than the desired length,
* it will not be truncated, however no padding
* will be added.
*
* @param s String to be padded.
* @param length desired length of result.
* @param c padding character.
* @return padded String.
* @throws NullPointerException if s is null.
*
* @since ostermillerutils 1.00.00
*/
public static String prepad(String s, int length, char c){
int needed = length - s.length();
if (needed <= 0){
return s;
}
char padding[] = new char[needed];
java.util.Arrays.fill(padding, c);
StringBuffer sb = new StringBuffer(length);
sb.append(padding);
sb.append(s);
return sb.toString();
}
/**
* Pad the end of the given String with spaces until
* the String is of the given length.
*
* If a String is longer than the desired length,
* it will not be truncated, however no padding
* will be added.
*
* @param s String to be padded.
* @param length desired length of result.
* @return padded String.
* @throws NullPointerException if s is null.
*
* @since ostermillerutils 1.00.00
*/
public static String postpad(String s, int length){
return postpad(s, length, ' ');
}
/**
* Append the given character to the String until
* the result is the desired length.
*
* If a String is longer than the desired length,
* it will not be truncated, however no padding
* will be added.
*
* @param s String to be padded.
* @param length desired length of result.
* @param c padding character.
* @return padded String.
* @throws NullPointerException if s is null.
*
* @since ostermillerutils 1.00.00
*/
public static String postpad(String s, int length, char c){
int needed = length - s.length();
if (needed <= 0){
return s;
}
char padding[] = new char[needed];
java.util.Arrays.fill(padding, c);
StringBuffer sb = new StringBuffer(length);
sb.append(s);
sb.append(padding);
return sb.toString();
}
/**
* Pad the beginning and end of the given String with spaces until
* the String is of the given length. The result is that the original
* String is centered in the middle of the new string.
*
* If the number of characters to pad is even, then the padding
* will be split evenly between the beginning and end, otherwise,
* the extra character will be added to the end.
*
* If a String is longer than the desired length,
* it will not be truncated, however no padding
* will be added.
*
* @param s String to be padded.
* @param length desired length of result.
* @return padded String.
* @throws NullPointerException if s is null.
*
* @since ostermillerutils 1.00.00
*/
public static String midpad(String s, int length){
return midpad(s, length, ' ');
}
/**
* Pad the beginning and end of the given String with the given character
* until the result is the desired length. The result is that the original
* String is centered in the middle of the new string.
*
* If the number of characters to pad is even, then the padding
* will be split evenly between the beginning and end, otherwise,
* the extra character will be added to the end.
*
* If a String is longer than the desired length,
* it will not be truncated, however no padding
* will be added.
*
* @param s String to be padded.
* @param length desired length of result.
* @param c padding character.
* @return padded String.
* @throws NullPointerException if s is null.
*
* @since ostermillerutils 1.00.00
*/
public static String midpad(String s, int length, char c){
int needed = length - s.length();
if (needed <= 0){
return s;
}
int beginning = needed / 2;
int end = beginning + needed % 2;
char prepadding[] = new char[beginning];
java.util.Arrays.fill(prepadding, c);
char postpadding[] = new char[end];
java.util.Arrays.fill(postpadding, c);
StringBuffer sb = new StringBuffer(length);
sb.append(prepadding);
sb.append(s);
sb.append(postpadding);
return sb.toString();
}
/**
* Split the given String into tokens.
*
* This method is meant to be similar to the split
* function in other programming languages but it does
* not use regular expressions. Rather the String is
* split on a single String literal.
*
* Unlike java.util.StringTokenizer which accepts
* multiple character tokens as delimiters, the delimiter
* here is a single String literal.
*
* Each null token is returned as an empty String.
* Delimiters are never returned as tokens.
*
* If there is no delimiter because it is either empty or
* null, the only element in the result is the original String.
*
* StringHelper.split("1-2-3", "-");
* result: {"1","2","3"}
* StringHelper.split("-1--2-", "-");
* result: {"","1","","2",""}
* StringHelper.split("123", "");
* result: {"123"}
* StringHelper.split("1-2---3----4", "--");
* result: {"1-2","-3","","4"}
*
* @param s String to be split.
* @param delimiter String literal on which to split.
* @return an array of tokens.
* @throws NullPointerException if s is null.
*
* @since ostermillerutils 1.00.00
*/
public static String[] split(String s, String delimiter){
int delimiterLength;
// the next statement has the side effect of throwing a null pointer
// exception if s is null.
int stringLength = s.length();
if (delimiter == null || (delimiterLength = delimiter.length()) == 0){
// it is not inherently clear what to do if there is no delimiter
// On one hand it would make sense to return each character because
// the null String can be found between each pair of characters in
// a String. However, it can be found many times there and we don'
// want to be returning multiple null tokens.
// returning the whole String will be defined as the correct behavior
// in this instance.
return new String[] {s};
}
// a two pass solution is used because a one pass solution would
// require the possible resizing and copying of memory structures
// In the worst case it would have to be resized n times with each
// resize having a O(n) copy leading to an O(n^2) algorithm.
int count;
int start;
int end;
// Scan s and count the tokens.
count = 0;
start = 0;
while((end = s.indexOf(delimiter, start)) != -1){
count++;
start = end + delimiterLength;
}
count++;
// allocate an array to return the tokens,
// we now know how big it should be
String[] result = new String[count];
// Scan s again, but this time pick out the tokens
count = 0;
start = 0;
while((end = s.indexOf(delimiter, start)) != -1){
result[count] = (s.substring(start, end));
count++;
start = end + delimiterLength;
}
end = stringLength;
result[count] = s.substring(start, end);
return (result);
}
/**
* Split the given String into tokens. Delimiters will
* be returned as tokens.
*
* This method is meant to be similar to the split
* function in other programming languages but it does
* not use regular expressions. Rather the String is
* split on a single String literal.
*
* Unlike java.util.StringTokenizer which accepts
* multiple character tokens as delimiters, the delimiter
* here is a single String literal.
*
* Each null token is returned as an empty String.
* Delimiters are never returned as tokens.
*
* If there is no delimiter because it is either empty or
* null, the only element in the result is the original String.
*
* StringHelper.split("1-2-3", "-");
* result: {"1","-","2","-","3"}
* StringHelper.split("-1--2-", "-");
* result: {"","-","1","-","","-","2","-",""}
* StringHelper.split("123", "");
* result: {"123"}
* StringHelper.split("1-2--3---4----5", "--");
* result: {"1-2","--","3","--","-4","--","","--","5"}
*
* @param s String to be split.
* @param delimiter String literal on which to split.
* @return an array of tokens.
* @throws NullPointerException if s is null.
*
* @since ostermillerutils 1.05.00
*/
public static String[] splitIncludeDelimiters(String s, String delimiter){
int delimiterLength;
// the next statement has the side effect of throwing a null pointer
// exception if s is null.
int stringLength = s.length();
if (delimiter == null || (delimiterLength = delimiter.length()) == 0){
// it is not inherently clear what to do if there is no delimiter
// On one hand it would make sense to return each character because
// the null String can be found between each pair of characters in
// a String. However, it can be found many times there and we don'
// want to be returning multiple null tokens.
// returning the whole String will be defined as the correct behavior
// in this instance.
return new String[] {s};
}
// a two pass solution is used because a one pass solution would
// require the possible resizing and copying of memory structures
// In the worst case it would have to be resized n times with each
// resize having a O(n) copy leading to an O(n^2) algorithm.
int count;
int start;
int end;
// Scan s and count the tokens.
count = 0;
start = 0;
while((end = s.indexOf(delimiter, start)) != -1){
count+=2;
start = end + delimiterLength;
}
count++;
// allocate an array to return the tokens,
// we now know how big it should be
String[] result = new String[count];
// Scan s again, but this time pick out the tokens
count = 0;
start = 0;
while((end = s.indexOf(delimiter, start)) != -1){
result[count] = (s.substring(start, end));
count++;
result[count] = delimiter;
count++;
start = end + delimiterLength;
}
end = stringLength;
result[count] = s.substring(start, end);
return (result);
}
/**
* Join all the elements of a string array into a single
* String.
*
* If the given array empty an empty string
* will be returned. Null elements of the array are allowed
* and will be treated like empty Strings.
*
* @param array Array to be joined into a string.
* @return Concatenation of all the elements of the given array.
* @throws NullPointerException if array is null.
*
* @since ostermillerutils 1.05.00
*/
public static String join(String[] array){
return join(array, "");
}
/**
* Join all the elements of a string array into a single
* String.
*
* If the given array empty an empty string
* will be returned. Null elements of the array are allowed
* and will be treated like empty Strings.
*
* @param array Array to be joined into a string.
* @param delimiter String to place between array elements.
* @return Concatenation of all the elements of the given array with the the delimiter in between.
* @throws NullPointerException if array or delimiter is null.
*
* @since ostermillerutils 1.05.00
*/
public static String join(String[] array, String delimiter){
// Cache the length of the delimiter
// has the side effect of throwing a NullPointerException if
// the delimiter is null.
int delimiterLength = delimiter.length();
// Nothing in the array return empty string
// has the side effect of throwing a NullPointerException if
// the array is null.
if (array.length == 0) return "";
// Only one thing in the array, return it.
if (array.length == 1){
if (array[0] == null) return "";
return array[0];
}
// Make a pass through and determine the size
// of the resulting string.
int length = 0;
for (int i=0; i
* result: "1|2|3"
* StringHelper.replace("-1--2-", "-", "|");
* result: "|1||2|"
* StringHelper.replace("123", "", "|");
* result: "123"
* StringHelper.replace("1-2---3----4", "--", "|");
* result: "1-2|-3||4"
* StringHelper.replace("1-2---3----4", "--", "---");
* result: "1-2----3------4"
*
* @param s String to be modified.
* @param find String to find.
* @param replace String to replace.
* @return a string with all the occurrences of the string to find replaced.
* @throws NullPointerException if s is null.
*
* @since ostermillerutils 1.00.00
*/
public static String replace(String s, String find, String replace){
int findLength;
// the next statement has the side effect of throwing a null pointer
// exception if s is null.
int stringLength = s.length();
if (find == null || (findLength = find.length()) == 0){
// If there is nothing to find, we won't try and find it.
return s;
}
if (replace == null){
// a null string and an empty string are the same
// for replacement purposes.
replace = "";
}
int replaceLength = replace.length();
// We need to figure out how long our resulting string will be.
// This is required because without it, the possible resizing
// and copying of memory structures could lead to an unacceptable runtime.
// In the worst case it would have to be resized n times with each
// resize having a O(n) copy leading to an O(n^2) algorithm.
int length;
if (findLength == replaceLength){
// special case in which we don't need to count the replacements
// because the count falls out of the length formula.
length = stringLength;
} else {
int count;
int start;
int end;
// Scan s and count the number of times we find our target.
count = 0;
start = 0;
while((end = s.indexOf(find, start)) != -1){
count++;
start = end + findLength;
}
if (count == 0){
// special case in which on first pass, we find there is nothing
// to be replaced. No need to do a second pass or create a string buffer.
return s;
}
length = stringLength - (count * (findLength - replaceLength));
}
int start = 0;
int end = s.indexOf(find, start);
if (end == -1){
// nothing was found in the string to replace.
// we can get this if the find and replace strings
// are the same length because we didn't check before.
// in this case, we will return the original string
return s;
}
// it looks like we actually have something to replace
// *sigh* allocate memory for it.
StringBuffer sb = new StringBuffer(length);
// Scan s and do the replacements
while (end != -1){
sb.append(s.substring(start, end));
sb.append(replace);
start = end + findLength;
end = s.indexOf(find, start);
}
end = stringLength;
sb.append(s.substring(start, end));
return (sb.toString());
}
/**
* Replaces characters that may be confused by a HTML
* parser with their equivalent character entity references.
*
* Any data that will appear as text on a web page should
* be be escaped. This is especially important for data
* that comes from untrusted sources such as Internet users.
* A common mistake in CGI programming is to ask a user for
* data and then put that data on a web page. For example:
* Server: What is your name?
* User: <b>Joe<b>
* Server: Hello Joe, Welcome
* If the name is put on the page without checking that it doesn't
* contain HTML code or without sanitizing that HTML code, the user
* could reformat the page, insert scripts, and control the the
* content on your web server.
*
* This method will replace HTML characters such as > with their
* HTML entity reference (>) so that the html parser will
* be sure to interpret them as plain text rather than HTML or script.
*
* This method should be used for both data to be displayed in text
* in the html document, and data put in form elements. For example:
* <html><body>This in not a <tag>
* in HTML</body></html>
* and
* <form><input type="hidden" name="date" value="This data could
* be "malicious""></form>
* In the second example, the form data would be properly be resubmitted
* to your CGI script in the URLEncoded format:
* This data could be %22malicious%22
*
* @param s String to be escaped
* @return escaped String
* @throws NullPointerException if s is null.
*
* @since ostermillerutils 1.00.00
*/
public static String escapeHTML(String s){
int length = s.length();
int newLength = length;
boolean someCharacterEscaped = false;
// first check for characters that might
// be dangerous and calculate a length
// of the string that has escapes.
for (int i=0; i':{
newLength += 3;
someCharacterEscaped = true;
} break;
}
}
}
if (!someCharacterEscaped){
// nothing to escape in the string
return s;
}
StringBuffer sb = new StringBuffer(newLength);
for (int i=0; i':{
sb.append(">");
} break;
default: {
sb.append(c);
}
}
}
}
return sb.toString();
}
/**
* Replaces characters that may be confused by an SQL
* parser with their equivalent escape characters.
*
* Any data that will be put in an SQL query should
* be be escaped. This is especially important for data
* that comes from untrusted sources such as Internet users.
*
* For example if you had the following SQL query:
* "SELECT * FROM addresses WHERE name='" + name + "' AND private='N'"
* Without this function a user could give " OR 1=1 OR ''='"
* as their name causing the query to be:
* "SELECT * FROM addresses WHERE name='' OR 1=1 OR ''='' AND private='N'"
* which will give all addresses, including private ones.
* Correct usage would be:
* "SELECT * FROM addresses WHERE name='" + StringHelper.escapeSQL(name) + "' AND private='N'"
*
* Another way to avoid this problem is to use a PreparedStatement
* with appropriate place holders.
*
* @param s String to be escaped
* @return escaped String
* @throws NullPointerException if s is null.
*
* @since ostermillerutils 1.00.00
*/
public static String escapeSQL(String s){
int length = s.length();
int newLength = length;
// first check for characters that might
// be dangerous and calculate a length
// of the string that has escapes.
for (int i=0; i=0; i--){
char ch = s.charAt(i);
found = true;
for (int j=0; found && j htmlEntities = new HashMap();
static {
htmlEntities.put("n"+"b"+"s"+"p", new Integer(160));
htmlEntities.put("i"+"e"+"x"+"c"+"l", new Integer(161));
htmlEntities.put("cent", new Integer(162));
htmlEntities.put("pound", new Integer(163));
htmlEntities.put("c"+"u"+"r"+"r"+"e"+"n", new Integer(164));
htmlEntities.put("y"+"e"+"n", new Integer(165));
htmlEntities.put("b"+"r"+"v"+"b"+"a"+"r", new Integer(166));
htmlEntities.put("sect", new Integer(167));
htmlEntities.put("u"+"m"+"l", new Integer(168));
htmlEntities.put("copy", new Integer(169));
htmlEntities.put("o"+"r"+"d"+"f", new Integer(170));
htmlEntities.put("l"+"a"+"quo", new Integer(171));
htmlEntities.put("not", new Integer(172));
htmlEntities.put("shy", new Integer(173));
htmlEntities.put("r"+"e"+"g", new Integer(174));
htmlEntities.put("m"+"a"+"c"+"r", new Integer(175));
htmlEntities.put("d"+"e"+"g", new Integer(176));
htmlEntities.put("plus"+"m"+"n", new Integer(177));
htmlEntities.put("sup2", new Integer(178));
htmlEntities.put("sup3", new Integer(179));
htmlEntities.put("acute", new Integer(180));
htmlEntities.put("m"+"i"+"c"+"r"+"o", new Integer(181));
htmlEntities.put("par"+"a", new Integer(182));
htmlEntities.put("mid"+"dot", new Integer(183));
htmlEntities.put("c"+"e"+"d"+"i"+"l", new Integer(184));
htmlEntities.put("sup1", new Integer(185));
htmlEntities.put("o"+"r"+"d"+"m", new Integer(186));
htmlEntities.put("r"+"a"+"quo", new Integer(187));
htmlEntities.put("frac14", new Integer(188));
htmlEntities.put("frac12", new Integer(189));
htmlEntities.put("frac34", new Integer(190));
htmlEntities.put("i"+"quest", new Integer(191));
htmlEntities.put("A"+"grave", new Integer(192));
htmlEntities.put("A"+"a"+"cute", new Integer(193));
htmlEntities.put("A"+"c"+"i"+"r"+"c", new Integer(194));
htmlEntities.put("A"+"tilde", new Integer(195));
htmlEntities.put("A"+"u"+"m"+"l", new Integer(196));
htmlEntities.put("A"+"ring", new Integer(197));
htmlEntities.put("A"+"E"+"l"+"i"+"g", new Integer(198));
htmlEntities.put("C"+"c"+"e"+"d"+"i"+"l", new Integer(199));
htmlEntities.put("E"+"grave", new Integer(200));
htmlEntities.put("E"+"a"+"cute", new Integer(201));
htmlEntities.put("E"+"c"+"i"+"r"+"c", new Integer(202));
htmlEntities.put("E"+"u"+"m"+"l", new Integer(203));
htmlEntities.put("I"+"grave", new Integer(204));
htmlEntities.put("I"+"a"+"cute", new Integer(205));
htmlEntities.put("I"+"c"+"i"+"r"+"c", new Integer(206));
htmlEntities.put("I"+"u"+"m"+"l", new Integer(207));
htmlEntities.put("ETH", new Integer(208));
htmlEntities.put("N"+"tilde", new Integer(209));
htmlEntities.put("O"+"grave", new Integer(210));
htmlEntities.put("O"+"a"+"cute", new Integer(211));
htmlEntities.put("O"+"c"+"i"+"r"+"c", new Integer(212));
htmlEntities.put("O"+"tilde", new Integer(213));
htmlEntities.put("O"+"u"+""+"m"+"l", new Integer(214));
htmlEntities.put("times", new Integer(215));
htmlEntities.put("O"+"slash", new Integer(216));
htmlEntities.put("U"+"grave", new Integer(217));
htmlEntities.put("U"+"a"+"cute", new Integer(218));
htmlEntities.put("U"+"c"+"i"+"r"+"c", new Integer(219));
htmlEntities.put("U"+"u"+"m"+"l", new Integer(220));
htmlEntities.put("Y"+"a"+"cute", new Integer(221));
htmlEntities.put("THORN", new Integer(222));
htmlEntities.put("s"+"z"+"l"+"i"+"g", new Integer(223));
htmlEntities.put("a"+"grave", new Integer(224));
htmlEntities.put("a"+"a"+"cute", new Integer(225));
htmlEntities.put("a"+"c"+"i"+"r"+"c", new Integer(226));
htmlEntities.put("a"+"tilde", new Integer(227));
htmlEntities.put("a"+"u"+"m"+"l", new Integer(228));
htmlEntities.put("a"+"ring", new Integer(229));
htmlEntities.put("a"+"e"+"l"+"i"+"g", new Integer(230));
htmlEntities.put("c"+"c"+"e"+"d"+"i"+"l", new Integer(231));
htmlEntities.put("e"+"grave", new Integer(232));
htmlEntities.put("e"+"a"+"cute", new Integer(233));
htmlEntities.put("e"+"c"+"i"+"r"+"c", new Integer(234));
htmlEntities.put("e"+"u"+"m"+"l", new Integer(235));
htmlEntities.put("i"+"grave", new Integer(236));
htmlEntities.put("i"+"a"+"cute", new Integer(237));
htmlEntities.put("i"+"c"+"i"+"r"+"c", new Integer(238));
htmlEntities.put("i"+"u"+""+"m"+"l", new Integer(239));
htmlEntities.put("e"+"t"+"h", new Integer(240));
htmlEntities.put("n"+"tilde", new Integer(241));
htmlEntities.put("o"+"grave", new Integer(242));
htmlEntities.put("o"+"a"+"cute", new Integer(243));
htmlEntities.put("o"+"c"+"i"+"r"+"c", new Integer(244));
htmlEntities.put("o"+"tilde", new Integer(245));
htmlEntities.put("o"+"u"+"m"+"l", new Integer(246));
htmlEntities.put("divide", new Integer(247));
htmlEntities.put("o"+"slash", new Integer(248));
htmlEntities.put("u"+"grave", new Integer(249));
htmlEntities.put("u"+"a"+"cute", new Integer(250));
htmlEntities.put("u"+"c"+"i"+"r"+"c", new Integer(251));
htmlEntities.put("u"+"u"+"m"+"l", new Integer(252));
htmlEntities.put("y"+"a"+"cute", new Integer(253));
htmlEntities.put("thorn", new Integer(254));
htmlEntities.put("y"+"u"+"m"+"l", new Integer(255));
htmlEntities.put("f"+"no"+"f", new Integer(402));
htmlEntities.put("Alpha", new Integer(913));
htmlEntities.put("Beta", new Integer(914));
htmlEntities.put("Gamma", new Integer(915));
htmlEntities.put("Delta", new Integer(916));
htmlEntities.put("Epsilon", new Integer(917));
htmlEntities.put("Z"+"e"+"t"+"a", new Integer(918));
htmlEntities.put("E"+"t"+"a", new Integer(919));
htmlEntities.put("T"+"h"+"e"+"t"+"a", new Integer(920));
htmlEntities.put("I"+"o"+"t"+"a", new Integer(921));
htmlEntities.put("K"+"a"+"p"+"pa", new Integer(922));
htmlEntities.put("Lambda", new Integer(923));
htmlEntities.put("M"+"u", new Integer(924));
htmlEntities.put("N"+"u", new Integer(925));
htmlEntities.put("Xi", new Integer(926));
htmlEntities.put("O"+"m"+"i"+"c"+"r"+"on", new Integer(927));
htmlEntities.put("Pi", new Integer(928));
htmlEntities.put("R"+"h"+"o", new Integer(929));
htmlEntities.put("S"+"i"+"g"+"m"+"a", new Integer(931));
htmlEntities.put("Tau", new Integer(932));
htmlEntities.put("Up"+"s"+"i"+"l"+"on", new Integer(933));
htmlEntities.put("P"+"h"+"i", new Integer(934));
htmlEntities.put("C"+"h"+"i", new Integer(935));
htmlEntities.put("P"+"s"+"i", new Integer(936));
htmlEntities.put("O"+"m"+"e"+"g"+"a", new Integer(937));
htmlEntities.put("alpha", new Integer(945));
htmlEntities.put("beta", new Integer(946));
htmlEntities.put("gamma", new Integer(947));
htmlEntities.put("delta", new Integer(948));
htmlEntities.put("epsilon", new Integer(949));
htmlEntities.put("z"+"e"+"t"+"a", new Integer(950));
htmlEntities.put("e"+"t"+"a", new Integer(951));
htmlEntities.put("the"+"t"+"a", new Integer(952));
htmlEntities.put("i"+"o"+"t"+"a", new Integer(953));
htmlEntities.put("k"+"a"+"p"+"pa", new Integer(954));
htmlEntities.put("lambda", new Integer(955));
htmlEntities.put("m"+"u", new Integer(956));
htmlEntities.put("n"+"u", new Integer(957));
htmlEntities.put("xi", new Integer(958));
htmlEntities.put("o"+"m"+"i"+""+"c"+"r"+"on", new Integer(959));
htmlEntities.put("pi", new Integer(960));
htmlEntities.put("r"+"h"+"o", new Integer(961));
htmlEntities.put("s"+"i"+"g"+"m"+"a"+"f", new Integer(962));
htmlEntities.put("s"+"i"+"g"+"m"+"a", new Integer(963));
htmlEntities.put("tau", new Integer(964));
htmlEntities.put("up"+"s"+"i"+"l"+"on", new Integer(965));
htmlEntities.put("p"+"h"+"i", new Integer(966));
htmlEntities.put("c"+"h"+"i", new Integer(967));
htmlEntities.put("p"+"s"+"i", new Integer(968));
htmlEntities.put("o"+"m"+"e"+"g"+"a", new Integer(969));
htmlEntities.put("the"+"t"+"a"+"s"+"y"+"m", new Integer(977));
htmlEntities.put("up"+"s"+"i"+"h", new Integer(978));
htmlEntities.put("pi"+"v", new Integer(982));
htmlEntities.put("bull", new Integer(8226));
htmlEntities.put("hell"+"i"+"p", new Integer(8230));
htmlEntities.put("prime", new Integer(8242));
htmlEntities.put("Prime", new Integer(8243));
htmlEntities.put("o"+"line", new Integer(8254));
htmlEntities.put("f"+"r"+""+"a"+"s"+"l", new Integer(8260));
htmlEntities.put("we"+"i"+"e"+"r"+"p", new Integer(8472));
htmlEntities.put("image", new Integer(8465));
htmlEntities.put("real", new Integer(8476));
htmlEntities.put("trade", new Integer(8482));
htmlEntities.put("ale"+"f"+"s"+"y"+"m", new Integer(8501));
htmlEntities.put("l"+"a"+"r"+"r", new Integer(8592));
htmlEntities.put("u"+"a"+"r"+"r", new Integer(8593));
htmlEntities.put("r"+"a"+"r"+"r", new Integer(8594));
htmlEntities.put("d"+"a"+"r"+"r", new Integer(8595));
htmlEntities.put("ha"+"r"+"r", new Integer(8596));
htmlEntities.put("c"+"r"+""+"a"+"r"+"r", new Integer(8629));
htmlEntities.put("lArr", new Integer(8656));
htmlEntities.put("uArr", new Integer(8657));
htmlEntities.put("rArr", new Integer(8658));
htmlEntities.put("dArr", new Integer(8659));
htmlEntities.put("hArr", new Integer(8660));
htmlEntities.put("for"+"all", new Integer(8704));
htmlEntities.put("part", new Integer(8706));
htmlEntities.put("exist", new Integer(8707));
htmlEntities.put("empty", new Integer(8709));
htmlEntities.put("n"+"a"+"b"+"l"+"a", new Integer(8711));
htmlEntities.put("is"+"in", new Integer(8712));
htmlEntities.put("not"+"in", new Integer(8713));
htmlEntities.put("n"+"i", new Integer(8715));
htmlEntities.put("p"+"rod", new Integer(8719));
htmlEntities.put("sum", new Integer(8721));
htmlEntities.put("minus", new Integer(8722));
htmlEntities.put("low"+"as"+"t", new Integer(8727));
htmlEntities.put("r"+"a"+"d"+"i"+"c", new Integer(8730));
htmlEntities.put("prop", new Integer(8733));
htmlEntities.put("in"+"fin", new Integer(8734));
htmlEntities.put("an"+"g", new Integer(8736));
htmlEntities.put("and", new Integer(8743));
htmlEntities.put("or", new Integer(8744));
htmlEntities.put("cap", new Integer(8745));
htmlEntities.put("cup", new Integer(8746));
htmlEntities.put("int", new Integer(8747));
htmlEntities.put("there4", new Integer(8756));
htmlEntities.put("s"+"i"+"m", new Integer(8764));
htmlEntities.put("c"+"on"+"g", new Integer(8773));
htmlEntities.put("a"+"s"+"y"+"m"+"p", new Integer(8776));
htmlEntities.put("n"+"e", new Integer(8800));
htmlEntities.put("e"+"q"+"u"+"i"+"v", new Integer(8801));
htmlEntities.put("l"+"e", new Integer(8804));
htmlEntities.put("g"+"e", new Integer(8805));
htmlEntities.put("sub", new Integer(8834));
htmlEntities.put("sup", new Integer(8835));
htmlEntities.put("n"+"sub", new Integer(8836));
htmlEntities.put("sub"+"e", new Integer(8838));
htmlEntities.put("sup"+"e", new Integer(8839));
htmlEntities.put("o"+"plus", new Integer(8853));
htmlEntities.put("o"+"times", new Integer(8855));
htmlEntities.put("per"+"p", new Integer(8869));
htmlEntities.put("s"+"dot", new Integer(8901));
htmlEntities.put("l"+"c"+"e"+"i"+"l", new Integer(8968));
htmlEntities.put("r"+"c"+"e"+"i"+"l", new Integer(8969));
htmlEntities.put("l"+"floor", new Integer(8970));
htmlEntities.put("r"+"floor", new Integer(8971));
htmlEntities.put("lang", new Integer(9001));
htmlEntities.put("rang", new Integer(9002));
htmlEntities.put("l"+"o"+"z", new Integer(9674));
htmlEntities.put("spades", new Integer(9824));
htmlEntities.put("clubs", new Integer(9827));
htmlEntities.put("hearts", new Integer(9829));
htmlEntities.put("d"+"i"+"am"+"s", new Integer(9830));
htmlEntities.put("quot", new Integer(34));
htmlEntities.put("amp", new Integer(38));
htmlEntities.put("lt", new Integer(60));
htmlEntities.put("gt", new Integer(62));
htmlEntities.put("OElig", new Integer(338));
htmlEntities.put("o"+"e"+"l"+"i"+"g", new Integer(339));
htmlEntities.put("Scar"+"on", new Integer(352));
htmlEntities.put("scar"+"on", new Integer(353));
htmlEntities.put("Y"+"u"+"m"+"l", new Integer(376));
htmlEntities.put("c"+"i"+"r"+"c", new Integer(710));
htmlEntities.put("tilde", new Integer(732));
htmlEntities.put("e"+"n"+"s"+"p", new Integer(8194));
htmlEntities.put("e"+"m"+"s"+"p", new Integer(8195));
htmlEntities.put("thin"+"s"+"p", new Integer(8201));
htmlEntities.put("z"+"w"+"n"+"j", new Integer(8204));
htmlEntities.put("z"+"w"+"j", new Integer(8205));
htmlEntities.put("l"+"r"+"m", new Integer(8206));
htmlEntities.put("r"+"l"+"m", new Integer(8207));
htmlEntities.put("n"+"dash", new Integer(8211));
htmlEntities.put("m"+"dash", new Integer(8212));
htmlEntities.put("l"+"s"+"quo", new Integer(8216));
htmlEntities.put("r"+"s"+"quo", new Integer(8217));
htmlEntities.put("s"+"b"+"quo", new Integer(8218));
htmlEntities.put("l"+"d"+"quo", new Integer(8220));
htmlEntities.put("r"+"d"+"quo", new Integer(8221));
htmlEntities.put("b"+"d"+"quo", new Integer(8222));
htmlEntities.put("dagger", new Integer(8224));
htmlEntities.put("Dagger", new Integer(8225));
htmlEntities.put("p"+"e"+"r"+"m"+"i"+"l", new Integer(8240));
htmlEntities.put("l"+"s"+"a"+"quo", new Integer(8249));
htmlEntities.put("r"+"s"+"a"+"quo", new Integer(8250));
htmlEntities.put("euro", new Integer(8364));
}
/**
* Turn any HTML escape entities in the string into
* characters and return the resulting string.
*
* @param s String to be un-escaped.
* @return un-escaped String.
* @throws NullPointerException if s is null.
*
* @since ostermillerutils 1.00.00
*/
public static String unescapeHTML(String s){
StringBuffer result = new StringBuffer(s.length());
int ampInd = s.indexOf("&");
int lastEnd = 0;
while (ampInd >= 0){
int nextAmp = s.indexOf("&", ampInd+1);
int nextSemi = s.indexOf(";", ampInd+1);
if (nextSemi != -1 && (nextAmp == -1 || nextSemi < nextAmp)){
int value = -1;
String escape = s.substring(ampInd+1,nextSemi);
try {
if (escape.startsWith("#")){
value = Integer.parseInt(escape.substring(1), 10);
} else {
if (htmlEntities.containsKey(escape)){
value = htmlEntities.get(escape).intValue();
}
}
} catch (NumberFormatException x){
// Could not parse the entity,
// output it verbatim
}
result.append(s.substring(lastEnd, ampInd));
lastEnd = nextSemi + 1;
if (value >= 0 && value <= 0xffff){
result.append((char)value);
} else {
result.append("&").append(escape).append(";");
}
}
ampInd = nextAmp;
}
result.append(s.substring(lastEnd));
return result.toString();
}
/**
* Escapes characters that have special meaning to
* regular expressions
*
* @param s String to be escaped
* @return escaped String
* @throws NullPointerException if s is null.
*
* @since ostermillerutils 1.02.25
*/
public static String escapeRegularExpressionLiteral(String s){
// According to the documentation in the Pattern class:
//
// The backslash character ('\') serves to introduce escaped constructs,
// as defined in the table above, as well as to quote characters that
// otherwise would be interpreted as un-escaped constructs. Thus the
// expression \\ matches a single backslash and \{ matches a left brace.
//
// It is an error to use a backslash prior to any alphabetic character
// that does not denote an escaped construct; these are reserved for future
// extensions to the regular-expression language. A backslash may be used
// prior to a non-alphabetic character regardless of whether that character
// is part of an un-escaped construct.
//
// As a result, escape everything except [0-9a-zA-Z]
int length = s.length();
int newLength = length;
// first check for characters that might
// be dangerous and calculate a length
// of the string that has escapes.
for (int i=0; i='0' && c<='9') || (c>='A' && c<='Z') || (c>='a' && c<='z'))){
newLength += 1;
}
}
if (length == newLength){
// nothing to escape in the string
return s;
}
StringBuffer sb = new StringBuffer(newLength);
for (int i=0; i='0' && c<='9') || (c>='A' && c<='Z') || (c>='a' && c<='z'))){
sb.append('\\');
}
sb.append(c);
}
return sb.toString();
}
/**
* Build a regular expression that is each of the terms or'd together.
*
* @param terms a list of search terms.
* @param sb place to build the regular expression.
* @throws IllegalArgumentException if the length of terms is zero.
*
* @since ostermillerutils 1.02.25
*/
private static void buildFindAnyPattern(String[] terms, StringBuffer sb){
if (terms.length == 0) throw new IllegalArgumentException("There must be at least one term to find.");
sb.append("(?:");
for (int i=0; i0) sb.append("|");
sb.append("(?:");
sb.append(escapeRegularExpressionLiteral(terms[i]));
sb.append(")");
}
sb.append(")");
}
/**
* Compile a pattern that can will match a string if the string
* contains any of the given terms.
*
* Usage:
* boolean b = getContainsAnyPattern(terms).matcher(s).matches();
*
* If multiple strings are matched against the same set of terms,
* it is more efficient to reuse the pattern returned by this function.
*
* @param terms Array of search strings.
* @return Compiled pattern that can be used to match a string to see if it contains any of the terms.
*
* @since ostermillerutils 1.02.25
*/
public static Pattern getContainsAnyPattern(String[] terms){
StringBuffer sb = new StringBuffer();
sb.append("(?s).*");
buildFindAnyPattern(terms, sb);
sb.append(".*");
return Pattern.compile(sb.toString());
}
/**
* Compile a pattern that can will match a string if the string
* equals any of the given terms.
*
* Usage:
* boolean b = getEqualsAnyPattern(terms).matcher(s).matches();
*
* If multiple strings are matched against the same set of terms,
* it is more efficient to reuse the pattern returned by this function.
*
* @param terms Array of search strings.
* @return Compiled pattern that can be used to match a string to see if it equals any of the terms.
*
* @since ostermillerutils 1.02.25
*/
public static Pattern getEqualsAnyPattern(String[] terms){
StringBuffer sb = new StringBuffer();
sb.append("(?s)\\A");
buildFindAnyPattern(terms, sb);
sb.append("\\z");
return Pattern.compile(sb.toString());
}
/**
* Compile a pattern that can will match a string if the string
* starts with any of the given terms.
*
* Usage:
* boolean b = getStartsWithAnyPattern(terms).matcher(s).matches();
*
* If multiple strings are matched against the same set of terms,
* it is more efficient to reuse the pattern returned by this function.
*
* @param terms Array of search strings.
* @return Compiled pattern that can be used to match a string to see if it starts with any of the terms.
*
* @since ostermillerutils 1.02.25
*/
public static Pattern getStartsWithAnyPattern(String[] terms){
StringBuffer sb = new StringBuffer();
sb.append("(?s)\\A");
buildFindAnyPattern(terms, sb);
sb.append(".*");
return Pattern.compile(sb.toString());
}
/**
* Compile a pattern that can will match a string if the string
* ends with any of the given terms.
*
* Usage:
* boolean b = getEndsWithAnyPattern(terms).matcher(s).matches();
*
* If multiple strings are matched against the same set of terms,
* it is more efficient to reuse the pattern returned by this function.
*
* @param terms Array of search strings.
* @return Compiled pattern that can be used to match a string to see if it ends with any of the terms.
*
* @since ostermillerutils 1.02.25
*/
public static Pattern getEndsWithAnyPattern(String[] terms){
StringBuffer sb = new StringBuffer();
sb.append("(?s).*");
buildFindAnyPattern(terms, sb);
sb.append("\\z");
return Pattern.compile(sb.toString());
}
/**
* Compile a pattern that can will match a string if the string
* contains any of the given terms.
*
* Case is ignored when matching using Unicode case rules.
*
* Usage:
* boolean b = getContainsAnyPattern(terms).matcher(s).matches();
*
* If multiple strings are matched against the same set of terms,
* it is more efficient to reuse the pattern returned by this function.
*
* @param terms Array of search strings.
* @return Compiled pattern that can be used to match a string to see if it contains any of the terms.
*
* @since ostermillerutils 1.02.25
*/
public static Pattern getContainsAnyIgnoreCasePattern(String[] terms){
StringBuffer sb = new StringBuffer();
sb.append("(?i)(?u)(?s).*");
buildFindAnyPattern(terms, sb);
sb.append(".*");
return Pattern.compile(sb.toString());
}
/**
* Compile a pattern that can will match a string if the string
* equals any of the given terms.
*
* Case is ignored when matching using Unicode case rules.
*
* Usage:
* boolean b = getEqualsAnyPattern(terms).matcher(s).matches();
*
* If multiple strings are matched against the same set of terms,
* it is more efficient to reuse the pattern returned by this function.
*
* @param terms Array of search strings.
* @return Compiled pattern that can be used to match a string to see if it equals any of the terms.
*
* @since ostermillerutils 1.02.25
*/
public static Pattern getEqualsAnyIgnoreCasePattern(String[] terms){
StringBuffer sb = new StringBuffer();
sb.append("(?i)(?u)(?s)\\A");
buildFindAnyPattern(terms, sb);
sb.append("\\z");
return Pattern.compile(sb.toString());
}
/**
* Compile a pattern that can will match a string if the string
* starts with any of the given terms.
*
* Case is ignored when matching using Unicode case rules.
*
* Usage:
* boolean b = getStartsWithAnyPattern(terms).matcher(s).matches();
*
* If multiple strings are matched against the same set of terms,
* it is more efficient to reuse the pattern returned by this function.
*
* @param terms Array of search strings.
* @return Compiled pattern that can be used to match a string to see if it starts with any of the terms.
*
* @since ostermillerutils 1.02.25
*/
public static Pattern getStartsWithAnyIgnoreCasePattern(String[] terms){
StringBuffer sb = new StringBuffer();
sb.append("(?i)(?u)(?s)\\A");
buildFindAnyPattern(terms, sb);
sb.append(".*");
return Pattern.compile(sb.toString());
}
/**
* Compile a pattern that can will match a string if the string
* ends with any of the given terms.
*
* Case is ignored when matching using Unicode case rules.
*
* Usage:
* boolean b = getEndsWithAnyPattern(terms).matcher(s).matches();
*
* If multiple strings are matched against the same set of terms,
* it is more efficient to reuse the pattern returned by this function.
*
* @param terms Array of search strings.
* @return Compiled pattern that can be used to match a string to see if it ends with any of the terms.
*
* @since ostermillerutils 1.02.25
*/
public static Pattern getEndsWithAnyIgnoreCasePattern(String[] terms){
StringBuffer sb = new StringBuffer();
sb.append("(?i)(?u)(?s).*");
buildFindAnyPattern(terms, sb);
sb.append("\\z");
return Pattern.compile(sb.toString());
}
/**
* Tests to see if the given string contains any of the given terms.
*
* This implementation is more efficient than the brute force approach
* of testing the string against each of the terms. It instead compiles
* a single regular expression that can test all the terms at once, and
* uses that expression against the string.
*
* This is a convenience method. If multiple strings are tested against
* the same set of terms, it is more efficient not to compile the regular
* expression multiple times.
* @see #getContainsAnyPattern(String[])
*
* @param s String that may contain any of the given terms.
* @param terms list of substrings that may be contained in the given string.
* @return true iff one of the terms is a substring of the given string.
*
* @since ostermillerutils 1.02.25
*/
public static boolean containsAny(String s, String[] terms){
return getContainsAnyPattern(terms).matcher(s).matches();
}
/**
* Tests to see if the given string equals any of the given terms.
*
* This implementation is more efficient than the brute force approach
* of testing the string against each of the terms. It instead compiles
* a single regular expression that can test all the terms at once, and
* uses that expression against the string.
*
* This is a convenience method. If multiple strings are tested against
* the same set of terms, it is more efficient not to compile the regular
* expression multiple times.
* @see #getEqualsAnyPattern(String[])
*
* @param s String that may equal any of the given terms.
* @param terms list of strings that may equal the given string.
* @return true iff one of the terms is equal to the given string.
*
* @since ostermillerutils 1.02.25
*/
public static boolean equalsAny(String s, String[] terms){
return getEqualsAnyPattern(terms).matcher(s).matches();
}
/**
* Tests to see if the given string starts with any of the given terms.
*
* This implementation is more efficient than the brute force approach
* of testing the string against each of the terms. It instead compiles
* a single regular expression that can test all the terms at once, and
* uses that expression against the string.
*
* This is a convenience method. If multiple strings are tested against
* the same set of terms, it is more efficient not to compile the regular
* expression multiple times.
* @see #getStartsWithAnyPattern(String[])
*
* @param s String that may start with any of the given terms.
* @param terms list of strings that may start with the given string.
* @return true iff the given string starts with one of the given terms.
*
* @since ostermillerutils 1.02.25
*/
public static boolean startsWithAny(String s, String[] terms){
return getStartsWithAnyPattern(terms).matcher(s).matches();
}
/**
* Tests to see if the given string ends with any of the given terms.
*
* This implementation is more efficient than the brute force approach
* of testing the string against each of the terms. It instead compiles
* a single regular expression that can test all the terms at once, and
* uses that expression against the string.
*
* This is a convenience method. If multiple strings are tested against
* the same set of terms, it is more efficient not to compile the regular
* expression multiple times.
* @see #getEndsWithAnyPattern(String[])
*
* @param s String that may end with any of the given terms.
* @param terms list of strings that may end with the given string.
* @return true iff the given string ends with one of the given terms.
*
* @since ostermillerutils 1.02.25
*/
public static boolean endsWithAny(String s, String[] terms){
return getEndsWithAnyPattern(terms).matcher(s).matches();
}
/**
* Tests to see if the given string contains any of the given terms.
*
* Case is ignored when matching using Unicode case rules.
*
* This implementation is more efficient than the brute force approach
* of testing the string against each of the terms. It instead compiles
* a single regular expression that can test all the terms at once, and
* uses that expression against the string.
*
* This is a convenience method. If multiple strings are tested against
* the same set of terms, it is more efficient not to compile the regular
* expression multiple times.
* @see #getContainsAnyIgnoreCasePattern(String[])
*
* @param s String that may contain any of the given terms.
* @param terms list of substrings that may be contained in the given string.
* @return true iff one of the terms is a substring of the given string.
*
* @since ostermillerutils 1.02.25
*/
public static boolean containsAnyIgnoreCase(String s, String[] terms){
return getContainsAnyIgnoreCasePattern(terms).matcher(s).matches();
}
/**
* Tests to see if the given string equals any of the given terms.
*
* Case is ignored when matching using Unicode case rules.
*
* This implementation is more efficient than the brute force approach
* of testing the string against each of the terms. It instead compiles
* a single regular expression that can test all the terms at once, and
* uses that expression against the string.
*
* This is a convenience method. If multiple strings are tested against
* the same set of terms, it is more efficient not to compile the regular
* expression multiple times.
* @see #getEqualsAnyIgnoreCasePattern(String[])
*
* @param s String that may equal any of the given terms.
* @param terms list of strings that may equal the given string.
* @return true iff one of the terms is equal to the given string.
*
* @since ostermillerutils 1.02.25
*/
public static boolean equalsAnyIgnoreCase(String s, String[] terms){
return getEqualsAnyIgnoreCasePattern(terms).matcher(s).matches();
}
/**
* Tests to see if the given string starts with any of the given terms.
*
* Case is ignored when matching using Unicode case rules.
*
* This implementation is more efficient than the brute force approach
* of testing the string against each of the terms. It instead compiles
* a single regular expression that can test all the terms at once, and
* uses that expression against the string.
*
* This is a convenience method. If multiple strings are tested against
* the same set of terms, it is more efficient not to compile the regular
* expression multiple times.
* @see #getStartsWithAnyIgnoreCasePattern(String[])
*
* @param s String that may start with any of the given terms.
* @param terms list of strings that may start with the given string.
* @return true iff the given string starts with one of the given terms.
*
* @since ostermillerutils 1.02.25
*/
public static boolean startsWithAnyIgnoreCase(String s, String[] terms){
return getStartsWithAnyIgnoreCasePattern(terms).matcher(s).matches();
}
/**
* Tests to see if the given string ends with any of the given terms.
*
* Case is ignored when matching using Unicode case rules.
*
* This implementation is more efficient than the brute force approach
* of testing the string against each of the terms. It instead compiles
* a single regular expression that can test all the terms at once, and
* uses that expression against the string.
*
* This is a convenience method. If multiple strings are tested against
* the same set of terms, it is more efficient not to compile the regular
* expression multiple times.
* @see #getEndsWithAnyIgnoreCasePattern(String[])
*
* @param s String that may end with any of the given terms.
* @param terms list of strings that may end with the given string.
* @return true iff the given string ends with one of the given terms.
*
* @since ostermillerutils 1.02.25
*/
public static boolean endsWithAnyIgnoreCase(String s, String[] terms){
return getEndsWithAnyIgnoreCasePattern(terms).matcher(s).matches();
}
}