com.cohort.util

Class ScriptString2

java.lang.Object

com.cohort.util.ScriptString2

public class ScriptString2
extends java.lang.Object

This class makes about half of the static methods in com.cohort.String2 accessible to JexlScript scripts as "String2.name()" methods. All of the constants and methods related to files, system information, ArrayList, Enumeration, Vector, BitSet, Map, interactive computing, etc., are not included here.

The underlying String2 class is Copyright (c) 2005 Robert Simons (CoHortSoftware@gmail.com). See the MIT/X-like license in com/cohort/util/LICENSE.txt.

Constructor Summary

Constructors

Constructor and Description
ScriptString2()

Method Summary

Modifier and Type	Method and Description
static boolean	allDigits(java.lang.String s) 0..9.
static java.lang.String	annotatedString(java.lang.String s) This converts non-isPrintable characters to "[#]".
static java.lang.String	arrayToCSSVString(java.lang.Object value) This returns a nice String representation of the attribute value (which should be a String or an array of primitives).
static int	binaryFindClosest(java.lang.String[] sar, java.lang.String s) Find the closest element to s in an ascending sorted array.
static int	binaryFindFirstGE(java.lang.String[] sar, java.lang.String s) Find the first element which is >= s in an ascending sorted array.
static int	binaryFindLastLE(java.lang.String[] sar, java.lang.String s) Find the last element which is <= s in an ascending sorted array.
static java.lang.String	camelCaseToTitleCase(java.lang.String s) This converts "camelCase99String" to "Camel Case 99 String"
static int	caseInsensitiveIndexOf(java.lang.Object[] ar, java.lang.String s) This finds the first element in Object[] where ar[i].toString().toLowerCase() equals to s.toLowerCase().
static java.lang.String	center(java.lang.String s, int length) Returns a String 'length' long, with 's' centered (using spaces as the added characters) within the resulting String.
static java.lang.String	charToJsonString(char ch, int firstUEncodedChar, boolean encodeNewline) This encodes one char to the Json encoding.
static java.lang.String	combineSpaces(java.lang.String s) Returns a string where all cases of more than one space are replaced by one space.
static java.lang.String	commonUnicodeToPlainText(java.lang.String s)
static int	countAll(java.lang.String s, char findS) This counts all occurrences of findS in s.
static int	countAll(java.lang.String s, java.lang.String findS) This counts all occurrences of findS in s.
static double[]	csvToDoubleArray(java.lang.String csv) This converts a comma-separated-value String into a double[].
static int[]	csvToIntArray(java.lang.String csv) This converts a comma-separated-value String into an int[].
static java.lang.String	differentLine(java.lang.String oldS, java.lang.String newS) Given two strings with internal newlines, oldS and newS, this a message indicating where they differ.
static java.lang.String	encodeFileNameSafe(java.lang.String s) This is different from String2.modifyToBeFileNameSafe -- this encodes non-fileNameSafe characters so little or no information is lost.
static java.lang.String	encodeMatlabNameSafe(java.lang.String s) This is like encodeFileNameSafe, but further restricts the name to first character must be A-Z, a-z.
static java.lang.String[]	extractAllCaptureGroupsAsStringArray(java.lang.String s, java.lang.String regex, int captureGroupNumber) This repeatedly finds the regex and extracts the specified captureGroup.
static java.lang.String[]	extractAllRegexes(java.lang.String s, java.lang.String regex) This returns all the sections of s that match regex.
static java.lang.String	extractCaptureGroup(java.lang.String s, java.lang.String regex, int captureGroupNumber) This returns the specified capture group from s.
static java.lang.String	extractRegex(java.lang.String s, java.lang.String regex, int fromIndex) This returns the first section of s (starting at fromIndex) which matches regex.
static int	findInvalidUnicode(java.lang.String s, java.lang.String alsoOK) This returns the index of the first non-Unicode character.
static int	findNth(java.lang.String s, char findS, int nth) This returns the index of the nth occurrence of findS in s.
static java.lang.String	findPrefix(java.lang.String[] prefixes, java.lang.String longerString, int startAt) This is like whichPrefix, but returns the found prefix (or null).
static int	findWholeWord(java.lang.String s, java.lang.String word) This finds (case-sensitive) the first whole word instance of 'word' in s.
static java.lang.String	fromJson(java.lang.String s) This returns the unJSON version of a JSON string (surrounding "'s (if any) are removed and \\, \f, \n, \r, \t, \/, and \" are unescaped).
static java.lang.String	fromJsonNotNull(java.lang.String s) This is like the other fromJson, but returns "" instead of null.
static char	fromNccsvChar(java.lang.String s) This converts an NCCSV encoded char to a true char (surrounding "'s and ''s (if any) are removed and \\, \f, \n, \r, \t, \/, and \" are unescaped).
static java.lang.String	fromNccsvString(java.lang.String s) This converts an NCCSV string to a true string (surrounding "'s (if any) are removed and \\, \f, \n, \r, \t, \/, and \" are unescaped).
static java.lang.String	genEFormat10(double d) This returns the number formatted with up to 10 digits to the left and right of the decimal and trailing decimal 0's removed.
static java.lang.String	genEFormat6(double d) This returns the number formatted with up to 6 digits to the left and right of the decimal and trailing decimal 0's removed.
static java.lang.String	genHTMLFormat10(double d) This is like genEFormat10, but the scientific notation format is, e.g., 8.9509244321x10-5.
static java.lang.String	genHTMLFormat6(double d) This is like genEFormat6, but the scientific notation format is, e.g., 8.954321x10-5.
static java.lang.String	genX10Format10(double d) This is like genEFormat10, but the scientific notation format is, e.g., 8.9509484321x10^-5.
static java.lang.String	genX10Format6(double d) This is like genEFormat6, but the scientific notation format is, e.g., 8.954321x10^-5.
static int	getNMatchingCharacters(java.lang.String s1, java.lang.String s2) This determines the number of initial characters that match.
static java.lang.String	ifJsonFromJson(java.lang.String s) If the String is surrounded by ", this returns fromJson(s), else it returns s.
static java.lang.String	ifSomethingConcat(java.lang.String a, java.lang.String separator, java.lang.String b) This cleverly concatenates the 2 strings (with separator, as appropriate).
static int	indexOf(char[] cArray, char c) Finds the first instance of c in cArray.
static int	indexOf(char[] cArray, char c, int fromIndex) Finds the first instance of c at or after fromIndex (0..
static int	indexOf(double[] dArray, double d) Finds the first instance of d in dArray (tested with Math2.almostEqual5).
static int	indexOf(double[] dArray, double d, int fromIndex) Finds the first instance of d at or after fromIndex (0..
static int	indexOf(int[] iArray, int i) Finds the first instance of i in iArray.
static int	indexOf(int[] iArray, int i, int fromIndex) Finds the first instance of i at or after fromIndex (0..
static int	indexOf(java.lang.Object[] ar, java.lang.String s) This finds the first element in Object[] where the ar[i].toString value equals to s.
static int	indexOf(java.lang.Object[] ar, java.lang.String s, int startAt) This finds the first element in Object[] (starting at element startAt) where the ar[i].toString value equals s.
static int	indexOf(java.lang.String s, java.lang.String car, int fromIndex) This indexOf is a little different: it finds the first instance in s of any char in car.
static int	indexOfChar(java.lang.String s, char[] car, int fromIndex) This indexOf is a little different: it finds the first instance in s of any char in car.
static int	indexOfIgnoreCase(java.lang.String s, java.lang.String find) Finds the first instance of 'find' at or after fromIndex (0..), ignoring case.
static int	indexOfIgnoreCase(java.lang.String s, java.lang.String find, int fromIndex) Finds the first instance of 'find' at or after fromIndex (0..), ignoring case.
static int	indexOfObject(java.lang.Object[] ar, java.lang.Object o) A variant of indexOfObject() that uses startAt=0.
static int	indexOfObject(java.lang.Object[] ar, java.lang.Object o, int startAt) This finds the first element in Object[] (starting at element startAt) where ar[i]==o.
static boolean	isAsciiLetter(int c) This returns true for A..Z, a..z.
static boolean	isAsciiPrintable(int ch) returns true if ch is 32..126.
static boolean	isAsciiPrintable(java.lang.String s) Returns true if all of the characters in s are 32..126
static boolean	isDigit(int c) 0..9.
static boolean	isDigitLetter(int c) Determines if the character is a digit or a letter.
static boolean	isDoubleTrouble(java.lang.String s) DON'T USE THIS; RELY ON THE FIXES AVAILABLE FOR JAVA: EITHER THE LATEST VERSION OF JAVA OR THE JAVA UPDATER TO FIX THE BUG ON EXISTING OLDER JAVA INSTALLATIONS https://www.oracle.com/technetwork/java/javase/fpupdater-tool-readme-305936.html
static boolean	isEmailAddress(java.lang.String email) This indicates if 'email' is a valid email address.
static boolean	isFileNameSafe(char ch) This indicates if ch is a file-name-safe character (A-Z, a-z, 0-9, _, -, or .).
static boolean	isFileNameSafe(java.lang.String s) This indicates if s has length >= 1 and has just file-name-safe characters (0-9, A-Z, a-z, _, -, .).
static boolean	isHexDigit(int c) 0..9, a..f, A..F Hex numbers are 0x followed by hexDigits.
static boolean	isHexString(java.lang.String s) Returns true if all of the characters in s are hex digits.
static boolean	isIDFirstLetter(int c) First letters for identifiers (e.g., variable names, method names) can be all isLetter()'s plus $ and _.
static boolean	isIso8859(java.lang.String s) This returns true if the string contains only ISO 8859-1 characters (i.e., 0 - 255).
static boolean	isJsonpNameSafe(java.lang.String s) This tests if s is a valid jsonp function name.
static boolean	isLetter(int c) This includes hiASCII/ISO Latin 1/ISO 8859-1, but not extensive unicode characters.
static boolean	isNumber(java.lang.String s) This tries to quickly determine if the string is a correctly formatted number (including decimal, hexadecimal, octal, and "NaN" (any case)).
static boolean	isPrintable(int ch) This indicates if ch is printable with System.err.println() and Graphics.drawString(); hence, it is a subset of 0..255.
static boolean	isPrintable(java.lang.String s) Returns true if all of the characters in s are printable
static boolean	isRemote(java.lang.String dir) This returns true if the dir starts with http://, https://, ftp://, sftp://, or smb://.
static boolean	isSomething(java.lang.String s) This returns true if s isn't null and s.trim().length() > 0.
static boolean	isSomething2(java.lang.String s) This returns true if s isn't null, "", "-", "null", "nd", "N/A", "...", "???", etc.
static boolean	isUrl(java.lang.String url) This indicates if 'url' is probably a valid url.
static boolean	isVariableNameSafe(java.lang.String s) This tests if s is a valid variableName: first character must be (iso8859Letter|_).
static boolean	isWhite(int c) Whitespace characters are u0001 ..
static double[]	justFiniteValues(double[] dar) This returns a double[] with just the finite values from the original array.
static int[]	justFiniteValues(int[] iar) This returns an int[] with just the non-Integer.MAX_VALUE values from the original array.
static java.lang.String	justPrintable(java.lang.String s) This returns the string with all non-isPrintable characters removed.
static java.lang.String	left(java.lang.String s, int length) Returns a String 'length' long, with 's' left-justified (using spaces as the added characters) within the resulting String.
static int	lineContaining(java.lang.Object[] ar, java.lang.String s) This finds the first element in Object[] where the ar[i].toString value contains the substring s.
static int	lineContaining(java.lang.Object[] ar, java.lang.String s, int startAt) This finds the first element in Object[] (starting at element startAt) where the ar[i].toString value contains the substring s.
static int	lineContainingIgnoreCase(java.lang.Object[] ar, java.lang.String s, int startAt) This finds the first element in Object[] (starting at element startAt) where the ar[i].toString value contains the substring s (ignoring the case of ar and s).
static int	lineStartsWith(java.lang.Object[] ar, java.lang.String s) This finds the first element in Object[] (starting at element 0) where the ar[i].toString value starts with s.
static int	lineStartsWith(java.lang.Object[] ar, java.lang.String s, int startAt) This finds the first element in Object[] (starting at element startAt) where the ar[i].toString value starts with s.
static int	lineStartsWithIgnoreCase(java.lang.Object[] ar, java.lang.String s) This variant of lineStartsWith startsAt index=0.
static int	lineStartsWithIgnoreCase(java.lang.Object[] ar, java.lang.String s, int startAt) This is like lineStartsWith, but ignores case.
static boolean	looselyContains(java.lang.String s, java.lang.String find) This goes beyond indexOfIgnoreCase by looking after punctuation removed.
static boolean	looselyEquals(java.lang.String s1, java.lang.String s2) This goes beyond equalsIgnoreCase by looking after punctuation removed.
static java.lang.String	makeString(char ch, int length) This makes a new String of specified length, filled with ch.
static java.lang.String	makeValidUnicode(java.lang.String s, java.lang.String alsoOK) This makes s valid Unicode by converting invalid characters (e.g., #128) with \\uhhhh (literally 2 backslashes, so no info is lost).
static java.lang.String	max(java.lang.String s1, java.lang.String s2) This returns the string which sorts higher.
static java.lang.String	md5Hex(java.lang.String password) This returns the MD5 hash digest of stringToUtf8Bytes(password) as a String of 32 lowercase hex digits.
static java.lang.String	md5Hex12(java.lang.String password) This returns the last 12 hex digits from md5Hex (or null if md5 is null), broken into 3 blocks of 4 digits, separated by '_'.
static java.lang.String	min(java.lang.String s1, java.lang.String s2) This returns the string which sorts lower.
static java.lang.String	modifyToBeASCII(java.lang.String s) This converts the string to plain ascii (0..127).
static java.lang.String	modifyToBeFileNameSafe(java.lang.String s) This returns the string with just file-name-safe characters (0-9, A-Z, a-z, _, -, .).
static java.lang.String	modifyToBeVariableNameSafe(java.lang.String s) This is like modifyToBeFileNameSafe, but restricts the name to: first character must be (iso8859Letter|_).
static java.lang.String	noLongerThan(java.lang.String s, int max) This returns a string no more than max characters long, throwing away the excess.
static java.lang.String	noLongerThanDots(java.lang.String s, int max) This is like noLongerThan, but if truncated, s.substring(0, max-3) + "..." is returned.
static java.lang.String	noLongLines(java.lang.String s, int maxLength, java.lang.String spaces) If lines in s are >=maxLength characters, this inserts "\n"+spaces at the previous non-DigitLetter + DigitLetter; or if none, this inserts "\n"+spaces at maxLength.
static java.lang.String	noLongLinesAtSpace(java.lang.String s, int maxLength, java.lang.String spaces) This is like noLongLines, but will only break at spaces.
static boolean	parseBoolean(java.lang.String s) This converts a string to a boolean.
static byte	parseBooleanToInt(java.lang.String s) This converts a string to a boolean and then an int.
static double	parseDouble(java.lang.String s) Convert a string to a double.
static float	parseFloat(java.lang.String s) Parse as a float with either "." or "," as the decimal point.
static int	parseInt(java.lang.String s) Convert a string to an int.
static int	parseInt(java.lang.String s, int def) Like parseInt(s), but returns def if error).
static long	parseLong(java.lang.String s) This converts String representation of a long.
static java.lang.String	passwordDigest(java.lang.String algorithm, java.lang.String password) This returns the hash digest of stringToUtf8Bytes(password) as a String of lowercase hex digits.
static java.lang.String	periodSpaceConcat(java.lang.String a, java.lang.String b) This cleverly concatenates the 2 strings (with "", ".
static java.lang.String	quoteParameterIfNeeded(java.lang.String s) For command line parameters, this returns toJson(s) if the string is empty or contains special characters or single or double quotes or backslash; otherwise it return s.
static java.lang.String	removeLeading(java.lang.String s, char ch) This removes leading ch's.
static java.lang.String[]	removeNull(java.lang.String[] sar) This returns a String[] with just non-null strings from the original array.
static java.lang.String[]	removeNullOrEmpty(java.lang.String[] sar) This returns a String[] with just non-null and non-"" strings from the original array.
static java.lang.String	repeatedlyReplaceAll(java.lang.String s, java.lang.String oldS, java.lang.String newS, boolean ignoreCase) This repeatedly replaces all oldS with newS.
static java.lang.String	replaceAll(java.lang.String s, char oldCh, char newCh) Returns a string where all occurences of oldCh have been replaced with newCh.
static java.lang.String	replaceAll(java.lang.String s, java.lang.String oldS, java.lang.String newS) Returns a string where all occurences of oldS have been replaced with newS.
static java.lang.String	replaceAllIgnoreCase(java.lang.String s, java.lang.String oldS, java.lang.String newS) Returns a string where all occurences of oldS have been replaced with newS.
static java.lang.String	right(java.lang.String s, int length) Returns a String 'length' long, with 's' right-justified (using spaces as the added characters) within the resulting String.
static double	roundingParseInt(java.lang.String s) Convert a string to an int, with rounding.
static java.lang.String	simpleMatlabNameSafe(java.lang.String s) This is like encodeMatlabNameSafe, but simpler and won't always retain all the info.
static java.lang.String[]	split(java.lang.String s, char separator) This splits the string at the specified character.
static java.lang.String[]	splitNoTrim(java.lang.String s, char separator) This splits the string at the specified character.
static java.lang.String	stringStartsWith(java.lang.Object[] ar, java.lang.String s) This returns the first element in Object[] (starting at element 0) where the ar[i].toString value starts with s.
static byte[]	stringToUtf8Bytes(java.lang.String s) This returns the UTF-8 encoding of the string (or null if trouble).
static java.lang.String	substitute(java.lang.String msg, java.lang.String s0, java.lang.String s1, java.lang.String s2) This replaces "{0}", "{1}", and "{2}" in msg with s0, s1, s2.
static java.lang.String	to0xHexString(int i, int nHexDigits) This returns the int formatted as a 0x hex String with at least nHexDigits, e.g., 0x00FF00.
static byte[]	toByteArray(java.lang.String s) This extracts the lower 8 bits of each char to form a byte array.
static java.lang.String	toCSSVString(boolean[] ar) This generates a Comma-Space-Separated-Value (CSSV) String from the array.
static java.lang.String	toCSSVString(byte[] ar) This generates a Comma-Space-Separated-Value (CSSV) String from the array.
static java.lang.String	toCSSVString(char[] ar) This generates a Comma-Space-Separated-Value (CSSV) String from the array.
static java.lang.String	toCSSVString(double[] ar) This generates a Comma-Space-Separated-Value (CSSV) String from the array.
static java.lang.String	toCSSVString(float[] ar) This generates a Comma-Space-Separated-Value (CSSV) String from the array.
static java.lang.String	toCSSVString(int[] ar) This generates a Comma-Space-Separated-Value (CSSV) String from the array.
static java.lang.String	toCSSVString(long[] ar) This generates a Comma-Space-Separated-Value (CSSV) String from the array.
static java.lang.String	toCSSVString(java.lang.Object[] ar) Generates a Comma-Space-Separated-Value (CSSV) string.
static java.lang.String	toCSSVString(short[] ar) This generates a Comma-Space-Separated-Value (CSSV) String from the array.
static java.lang.String	toCSVString(java.lang.Object[] ar) This returns a CSV (not CSSV) String.
static double[]	toDoubleArray(java.lang.Object[] oar) This converts an Object[] (for example, where objects are Strings or Doubles) into a double[].
static float[]	toFloatArray(java.lang.Object[] oar) This converts an Object[] (for example, where objects are Strings or Floats) into a float[].
static java.lang.String	toHexCSSVString(byte[] ar) This generates a hexadecimal Comma-Space-Separated-Value (CSSV) String from the array.
static java.lang.String	toHexCSSVString(int[] ar) This generates a hexadecimal Comma-Space-Separated-Value (CSSV) String from the array.
static java.lang.String	toHexCSSVString(short[] ar) This generates a hexadecimal Comma-Space-Separated-Value (CSSV) String from the array.
static int[]	toIntArray(java.lang.Object[] oar) This converts an Object[] (for example, where objects are Strings or Integers) into an int[].
static char	toIso88591Char(char ch) This converts the char to an ISO-8859-1 (ISO_8859_1) char.
static char[]	toIso88591Chars(char[] car) This converts the chars to ISO-8859-1 (ISO_8859_1) chars.
static java.lang.String	toJson(double d) This makes a JSON version of a number.
static java.lang.String	toJson(float f) This makes a JSON version of a float.
static java.lang.String	toJson(java.lang.String s) This makes a JSON version of a string (\\, \f, \n, \r, \t and \" are escaped with a backslash character and double quotes are added before and after).
static java.lang.String	toJson(java.lang.String s, int firstUEncodedChar) This makes a JSON version of a string (\\, \f, \n, \r, \t and \" are escaped with a backslash character and double quotes are added before and after).
static java.lang.String	toJson(java.lang.String s, int firstUEncodedChar, boolean encodeNewline) This is a variant of toJson that lets you encode newlines or not.
static java.lang.String	toJson65536(java.lang.String s) This variant doesn't encode high characters.
static java.lang.String	toJsonArray(java.lang.String[] sa) The converts a string[] into a JSON array of strings.
static java.lang.String[]	tokenize(java.lang.String s) This converts a multiple-space-separated string into a String[] of separate tokens.
static java.lang.String	toNccsvAttString(java.lang.String s) This encodes one String as an NCCSV att String, with surrounding double quotes only if necessary.
static java.lang.String	toNccsvChar(char ch) This encodes one char for an NCCSV char or String, without surrounding quotes.
static java.lang.String	toNccsvDataString(java.lang.String s) This encodes one String as an NCCSV data String, with surrounding double quotes only if necessary.
static java.lang.String	toNewlineString(double[] ar) This generates a newline-separated (always '\n') String from the array.
static java.lang.String	toNewlineString(int[] ar) This generates a newline-separated (always '\n') String from the array.
static java.lang.String	toNewlineString(java.lang.Object[] ar) Generates a newline-separated string, with a newline at the end.
static int[]	toRational(double d) This converts a double to a rational number (m * 10^t).
static java.lang.String	toSentenceCase(java.lang.String s) This changes the character's case to sentence case (first letter and first letter after each period capitalized).
static java.lang.String	toSSVString(java.lang.Object[] ar) Generates a space-separated-value string.
static java.lang.String[]	toStringArray(java.lang.Object[] aa) This converts an Object[] into a String[].
static java.lang.String	toSVString(java.lang.Object[] ar, java.lang.String separator, boolean finalSeparator) This is used at a low level to generate a 'separator'-separated-value string (without newlines) with the element.toString()'s from the array.
static java.lang.String	toTitleCase(java.lang.String s) This changes the characters case to title case (only letters after non-letters are capitalized).
static java.lang.String	toSVString(java.lang.String s) This encodes special characters in s if needed so that s can be stored as an item in a tsv string.
static java.lang.String	toVariableName(java.lang.String s) This suggests a camel-case variable name.
static java.lang.String	trimEnd(java.lang.String s) This trims just the end of the string.
static java.lang.String	trimStart(java.lang.String s) This trims just the start of the string.
static java.lang.String	utf8BytesToString(byte[] bar) This returns a string from the UTF-8 encoded byte[] (or ERROR if trouble).
static int	whichPrefix(java.lang.String[] prefixes, java.lang.String longerString, int startAt) This finds the first element in prefixes (starting at element startAt) where the longerString starts with prefixes[i].
static int	whichSuffix(java.lang.String[] suffixes, java.lang.String longerString, int startAt) This finds the first element in suffixes (starting at element startAt) where the longerString ends with suffixes[i].
static int	whichWord(java.lang.String longerString, java.lang.String[] words) This tries to find the first one of the words in the longerString.
static java.lang.String	whitespacesToSpace(java.lang.String s)
static java.lang.String	zeroPad(java.lang.String number, int nDigits) This adds 0's to the left of the string until there are nDigits to the left of the decimal point (or nDigits total if there isn't a decimal point).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScriptString2

public ScriptString2()

Method Detail

max

public static java.lang.String max(java.lang.String s1,
                                   java.lang.String s2)

This returns the string which sorts higher. null sorts low.

Parameters:

s1 -

s2 -

Returns:

the string which sorts higher.

min

public static java.lang.String min(java.lang.String s1,
                                   java.lang.String s2)

This returns the string which sorts lower. null sorts low.

Parameters:

s1 -

s2 -

Returns:

the string which sorts lower.

makeString

public static java.lang.String makeString(char ch,
                                          int length)

This makes a new String of specified length, filled with ch. For safety, if length>=1000000, it returns "".

Parameters:

ch - the character to fill the string

length - the length of the string

Returns:

a String 'length' long, filled with ch. If length < 0 or >= 1000000, this returns "".

right

public static java.lang.String right(java.lang.String s,
                                     int length)

Returns a String 'length' long, with 's' right-justified (using spaces as the added characters) within the resulting String. If s is already longer, then there will be no change.

Parameters:

s - is the string to be right-justified.

length - is desired length of the resulting string.

Returns:

's' right-justified to make the result 'length' long.

left

public static java.lang.String left(java.lang.String s,
                                    int length)

Returns a String 'length' long, with 's' left-justified (using spaces as the added characters) within the resulting String. If s is already longer, then there will be no change.

Parameters:

s - is the string to be left-justified.

length - is desired length of the resulting string.

Returns:

's' left-justified to make the result 'length' long.

center

public static java.lang.String center(java.lang.String s,
                                      int length)

Returns a String 'length' long, with 's' centered (using spaces as the added characters) within the resulting String. If s is already longer, then there will be no change.

Parameters:

s - is the string to be centered.

length - is desired length of the resulting string.

Returns:

's' centered to make the result 'length' long.

noLongerThan

public static java.lang.String noLongerThan(java.lang.String s,
                                            int max)

This returns a string no more than max characters long, throwing away the excess. If you want to keep the whole string and just insert newlines periodically, use noLongLines() instead.

Parameters:

s -

max -

Returns:

s (if it is short) or the first max characters of s. If s==null, this returns "".

noLongerThanDots

public static java.lang.String noLongerThanDots(java.lang.String s,
                                                int max)

This is like noLongerThan, but if truncated, s.substring(0, max-3) + "..." is returned.

Parameters:

s -

max -

Returns:

s (if it is short) or the first max characters of s

annotatedString

public static java.lang.String annotatedString(java.lang.String s)

This converts non-isPrintable characters to "[#]". \\n generates both [10] and a newline character.

Parameters:

s - the string

Returns:

s, but with non-32..126 characters replaced by [#]. The result ends with "[end]". null returns "[null][end]".

getNMatchingCharacters

public static int getNMatchingCharacters(java.lang.String s1,
                                         java.lang.String s2)

This determines the number of initial characters that match.

Parameters:

s1 -

s2 -

Returns:

the number of characters that are the same at the start of both strings.

indexOfIgnoreCase

public static int indexOfIgnoreCase(java.lang.String s,
                                    java.lang.String find)

Finds the first instance of 'find' at or after fromIndex (0..), ignoring case.

Parameters:

s -

find -

Returns:

the first instance of 'find' at or after fromIndex (0..), ignoring case.

indexOfIgnoreCase

public static int indexOfIgnoreCase(java.lang.String s,
                                    java.lang.String find,
                                    int fromIndex)

Finds the first instance of 'find' at or after fromIndex (0..), ignoring case.

Parameters:

s -

find -

fromIndex -

Returns:

the first instance of 'find' at or after fromIndex (0..), ignoring case.

looselyContains

public static boolean looselyContains(java.lang.String s,
                                      java.lang.String find)

This goes beyond indexOfIgnoreCase by looking after punctuation removed.

Parameters:

s -

find -

Returns:

true if find is loosely in s. Return false if s or find !isSomething.

looselyEquals

public static boolean looselyEquals(java.lang.String s1,
                                    java.lang.String s2)

This goes beyond equalsIgnoreCase by looking after punctuation removed.

Parameters:

s1 -

s2 -

Returns:

true if find is loosely in s. Return false if s or find !isSomething.

findWholeWord

public static int findWholeWord(java.lang.String s,
                                java.lang.String word)

This finds (case-sensitive) the first whole word instance of 'word' in s. It will find 'word' at the start or end of s. I.e., the character before and after (if any) mustn't be a letter or digit or '_'.

Parameters:

word - must be a simple word (without regex special characters)

Returns:

-1 if not found (or trouble, e.g., find=null)

extractRegex

public static java.lang.String extractRegex(java.lang.String s,
                                            java.lang.String regex,
                                            int fromIndex)

This returns the first section of s (starting at fromIndex) which matches regex. !!! Note that . in the regex doesn't match line terminators in s !!!

Parameters:

s - the source String.

regex - the regular expression, see java.util.regex.Pattern.

fromIndex - the starting index in s

Returns:

the section of s which matches regex, or null if not found

Throws:

java.lang.RuntimeException - if trouble

extractAllRegexes

public static java.lang.String[] extractAllRegexes(java.lang.String s,
                                                   java.lang.String regex)

This returns all the sections of s that match regex. It assumes that the extracted parts don't overlap. !!! Note that . in the regex doesn't match line terminators in s !!!

Parameters:

s - the source String

regex - the regular expression, see java.util.regex.Pattern. Note that you often want to use the "reluctant" qualifiers which match as few chars as possible (e.g., ??, *?, +?) not the "greedy" qualifiers which match as many chars as possible (e.g., ?, *, +).

Returns:

a String[] with all the matching sections of s (or String[0] if none)

Throws:

java.lang.RuntimeException - if trouble

extractAllCaptureGroupsAsStringArray

public static java.lang.String[] extractAllCaptureGroupsAsStringArray(java.lang.String s,
                                                                      java.lang.String regex,
                                                                      int captureGroupNumber)

This repeatedly finds the regex and extracts the specified captureGroup.

Parameters:

s - the source String

regex - the regular expression, see java.util.regex.Pattern. Note that you often want to use the "reluctant" qualifiers which match as few chars as possible (e.g., ??, *?, +?) not the "greedy" qualifiers which match as many chars as possible (e.g., ?, *, +).

Returns:

a String[] with the found strings in their original order.

extractCaptureGroup

public static java.lang.String extractCaptureGroup(java.lang.String s,
                                                   java.lang.String regex,
                                                   int captureGroupNumber)

This returns the specified capture group from s.

Parameters:

s - the source String

regex - the regular expression which probably matches part of s. See java.util.regex.Pattern.

captureGroupNumber - the number of the capture group (0 for entire regex, 1 for first capture group, 2 for second, etc.)

Returns:

the value of the specified capture group in the first match of the regex, or null if the s doesn't match the regex

Throws:

java.lang.RuntimeException - if trouble, e.g., invalid regex syntax

indexOf

public static int indexOf(int[] iArray,
                          int i,
                          int fromIndex)

Finds the first instance of i at or after fromIndex (0.. ) in iArray.

Parameters:

iArray -

i - the int you want to find

fromIndex - the index number of the position to start the search

Returns:

The first instance of i. If not found, it returns -1.

indexOf

public static int indexOf(int[] iArray,
                          int i)

Finds the first instance of i in iArray.

Parameters:

iArray -

i - the int you want to find

Returns:

The first instance of i. If not found, it returns -1.

indexOf

public static int indexOf(char[] cArray,
                          char c,
                          int fromIndex)

Finds the first instance of c at or after fromIndex (0.. ) in cArray.

Parameters:

cArray -

c - the char you want to find

fromIndex - the index number of the position to start the search

Returns:

The first instance of c. If not found, it returns -1.

indexOf

public static int indexOf(char[] cArray,
                          char c)

Finds the first instance of c in cArray.

Parameters:

cArray -

c - the char you want to find

Returns:

The first instance of c. If not found, it returns -1.

indexOfChar

public static int indexOfChar(java.lang.String s,
                              char[] car,
                              int fromIndex)

This indexOf is a little different: it finds the first instance in s of any char in car.

Parameters:

s - a string

car - the chars you want to find any of

fromIndex - the index number of the position to start the search

Returns:

The first instance in s of any char in car. If not found, it returns -1.

indexOf

public static int indexOf(java.lang.String s,
                          java.lang.String car,
                          int fromIndex)

This indexOf is a little different: it finds the first instance in s of any char in car.

Parameters:

s - a string

car - the chars you want to find any of

fromIndex - the index number of the position to start the search

Returns:

The first instance in s of any char in car. If not found, it returns -1.

indexOf

public static int indexOf(double[] dArray,
                          double d,
                          int fromIndex)

Finds the first instance of d at or after fromIndex (0.. ) in dArray (tested with Math2.almostEqual5).

Parameters:

dArray -

d - the double you want to find

fromIndex - the index number of the position to start the search

Returns:

The first instance of d. If not found, it returns -1.

whichWord

public static int whichWord(java.lang.String longerString,
                            java.lang.String[] words)

This tries to find the first one of the words in the longerString. This is case-sensitive.

Returns:

index of the matching word (or -1 if no match or other trouble)

indexOf

public static int indexOf(double[] dArray,
                          double d)

Finds the first instance of d in dArray (tested with Math2.almostEqual5).

Parameters:

dArray -

d - the double you want to find

Returns:

The first instance of d. If not found, it returns -1.

isAsciiLetter

public static final boolean isAsciiLetter(int c)

This returns true for A..Z, a..z.

Parameters:

c - a char

Returns:

true if c is a letter

isLetter

public static final boolean isLetter(int c)

This includes hiASCII/ISO Latin 1/ISO 8859-1, but not extensive unicode characters. Letters are A..Z, a..z, and #192..#255 (except #215 and #247). For unicode characters, see Java Lang Spec pg 14.

Parameters:

c - a char

Returns:

true if c is a letter

isIDFirstLetter

public static final boolean isIDFirstLetter(int c)

First letters for identifiers (e.g., variable names, method names) can be all isLetter()'s plus $ and _.

Parameters:

c - a char

Returns:

true if c is a valid character for the first character if a Java ID

isHexDigit

public static final boolean isHexDigit(int c)

0..9, a..f, A..F Hex numbers are 0x followed by hexDigits.

Parameters:

c - a char

Returns:

true if c is a valid hex digit

isHexString

public static final boolean isHexString(java.lang.String s)

Returns true if all of the characters in s are hex digits. A 0-length string returns false.

isDigit

public static final boolean isDigit(int c)

0..9. Non-Latin numeric characters are not included (see Java Lang Spec pg 14).

Parameters:

c - a char

Returns:

true if c is a digit

allDigits

public static final boolean allDigits(java.lang.String s)

0..9. Non-Latin numeric characters are not included (see Java Lang Spec pg 14).

Parameters:

s - a string

Returns:

true if c is a digit

isDigitLetter

public static final boolean isDigitLetter(int c)

Determines if the character is a digit or a letter.

Parameters:

c - a char

Returns:

true if c is a letter or a digit

isNumber

public static final boolean isNumber(java.lang.String s)

This tries to quickly determine if the string is a correctly formatted number (including decimal, hexadecimal, octal, and "NaN" (any case)).

This may not be perfect. In the future, this may be changed to be perfect. That shouldn't affect its use.

Parameters:

s - usually already trimmed, since any space in s will return false.

Returns:

true if s is *probably* a number. This returns false if s is *definitely* not a number. "NaN" (case insensitive) returns true. (It is a numeric value of sorts.) null and "" return false.

isWhite

public static final boolean isWhite(int c)

Whitespace characters are u0001 .. ' '. Java just considers a few of these (sp HT FF) as white space, see the Java Lang Specification. u0000 is not whitespace. Some methods count on this fact.

Parameters:

c - a char

Returns:

true if c is a whitespace character

isPrintable

public static final boolean isPrintable(int ch)

This indicates if ch is printable with System.err.println() and Graphics.drawString(); hence, it is a subset of 0..255.

• This is used, for example, to limit characters entering CoText.
• Currently, this accepts the ch if (ch>=32 && ch<127) || (ch>=161 && ch<=255).
• tab(#9) is not included. It should be caught separately and dealt with (expand to spaces?). The problem is that tabs are printed with a wide box (non-character symbol) in Windows Courier font. Thus, they mess up the positioning of characters in CoText.
• newline is not included. It should be caught separately and dealt with.
• This requires further study into all standard fonts on all platforms to see if other characters can be accepted.

Parameters:

ch - a char

Returns:

true if ch is a printable character

isPrintable

public static final boolean isPrintable(java.lang.String s)

Returns true if all of the characters in s are printable

isAsciiPrintable

public static final boolean isAsciiPrintable(int ch)

returns true if ch is 32..126.

isAsciiPrintable

public static final boolean isAsciiPrintable(java.lang.String s)

Returns true if all of the characters in s are 32..126

justPrintable

public static java.lang.String justPrintable(java.lang.String s)

This returns the string with all non-isPrintable characters removed.

Parameters:

s -

Returns:

s with all the non-isPrintable characters removed. If s is null, this throws null pointer exception.

modifyToBeASCII

public static java.lang.String modifyToBeASCII(java.lang.String s)

This converts the string to plain ascii (0..127). Diacritics are stripped off high ASCII characters. Some high ASCII characters are crudely converted to similar characters (the conversion is always character-for-character, so the string length will be unchanged). Other characters become '?'. The result will be the same length as s.

Parameters:

s -

Returns:

the string converted to plain ascii (0..127).

isFileNameSafe

public static boolean isFileNameSafe(char ch)

This indicates if ch is a file-name-safe character (A-Z, a-z, 0-9, _, -, or .).

Parameters:

ch -

Returns:

true if ch is a file-name-safe character (A-Z, a-z, 0-9, _, -, .).

isEmailAddress

public static boolean isEmailAddress(java.lang.String email)

This indicates if 'email' is a valid email address.

Parameters:

email - a possible email address

Returns:

true if 'email' is a valid email address.

isUrl

public static boolean isUrl(java.lang.String url)

This indicates if 'url' is probably a valid url. This is like isRemote, but returns true for "file://...".

Parameters:

url - a possible url

Returns:

true if 'url' is probably a valid url. false if 'url' is not a valid url. Note that "file://..." is a url.

isRemote

public static boolean isRemote(java.lang.String dir)

This returns true if the dir starts with http://, https://, ftp://, sftp://, or smb://. This is like isRemote, but returns false for "file://...".

Returns:

true if the dir is remote (e.g., a URL other than file://) If dir is null or "", this returns false.

isFileNameSafe

public static boolean isFileNameSafe(java.lang.String s)

This indicates if s has length >= 1 and has just file-name-safe characters (0-9, A-Z, a-z, _, -, .). Note, this does not check for filenames that are too long (Windows has a path+fileName max length of 255 chars).

Parameters:

s - a string, usually a file name

Returns:

true if s has just file-name-safe characters (0-9, A-Z, a-z, _, -, .). It returns false if s is null or "".

modifyToBeFileNameSafe

public static java.lang.String modifyToBeFileNameSafe(java.lang.String s)

This returns the string with just file-name-safe characters (0-9, A-Z, a-z, _, -, .). This is different from String2.encodeFileNameSafe -- this emphasizes readability, not avoiding losing information. Non-safe characters are converted to '_'. Adjacent '_' are collapsed into '_'. See posix fully portable file names at https://en.wikipedia.org/wiki/Filename . See javadocs for java.net.URLEncoder, which describes valid characters (but deals with encoding, whereas this method alters or removes). The result may be shorter than s. Note, this does not check for filenames that are too long (Windows has a path+fileName max length of 255 chars).

Parameters:

s - If s is null, this returns "_null". If s is "", this returns "_".

Returns:

s with all of the non-fileNameSafe characters removed or changed

isVariableNameSafe

public static boolean isVariableNameSafe(java.lang.String s)

This tests if s is a valid variableName:

• first character must be (iso8859Letter|_).
• optional subsequent characters must be (iso8859Letter|_|0-9).

Note that Java allows Unicode characters, but this does not.

Parameters:

s - a possible variable name

Returns:

true if s is a valid variableName.

isJsonpNameSafe

public static boolean isJsonpNameSafe(java.lang.String s)

This tests if s is a valid jsonp function name. The functionName MUST be a series of 1 or more (period-separated) words. For each word:

• The first character must be (iso8859Letter|_).
• The optional subsequent characters must be (iso8859Letter|_|0-9).
• s must not be longer than 255 characters.

Note that JavaScript allows Unicode characters, but this does not.

Parameters:

s - a possible jsonp function name

Returns:

true if s is a valid jsonp function name.

modifyToBeVariableNameSafe

public static java.lang.String modifyToBeVariableNameSafe(java.lang.String s)

This is like modifyToBeFileNameSafe, but restricts the name to:

• first character must be (iso8859Letter|_).
• subsequent characters must be (iso8859Letter|_|0-9).

Note that Java allows Unicode characters, but this does not. See also the safer encodeMatlabNameSafe(String s). Note, this does not check for names that are too long (many system have an 80 or 255 char limit).

Parameters:

s -

Returns:

a safe variable name (but perhaps two s's lead to the same result)

countAll

public static int countAll(java.lang.String s,
                           java.lang.String findS)

This counts all occurrences of findS in s. if (s == null || findS == null || findS.length() == 0) return 0;

Parameters:

s - the source string

findS - the string to be searched for

countAll

public static int countAll(java.lang.String s,
                           char findS)

This counts all occurrences of findS in s. if (s == null || findS == null || findS.length() == 0) return 0;

Parameters:

s - the source string

findS - the char to be searched for

findNth

public static int findNth(java.lang.String s,
                          char findS,
                          int nth)

This returns the index of the nth occurrence of findS in s. If s == null, or "", or nth <0, or nth occurence not found, return -1. If s.length()==0 or nth==0, return -1;

Parameters:

s - the source string

findS - the char to be searched for

nth - 1+

Returns:

This returns the index of the nth occurrence of findS in s.

repeatedlyReplaceAll

public static java.lang.String repeatedlyReplaceAll(java.lang.String s,
                                                    java.lang.String oldS,
                                                    java.lang.String newS,
                                                    boolean ignoreCase)

This repeatedly replaces all oldS with newS. e.g., replace "++" with "+" in "++++" will yield "+".

replaceAll

public static java.lang.String replaceAll(java.lang.String s,
                                          java.lang.String oldS,
                                          java.lang.String newS)

Returns a string where all occurences of oldS have been replaced with newS. If oldS occurs inside newS, it won't be replaced recursively (obviously).

Parameters:

s - the main string

oldS - the string to be searched for

newS - the string to replace oldS

Returns:

a modified version of s, with newS in place of all the olds.

Throws:

java.lang.RuntimeException - if s is null.

replaceAllIgnoreCase

public static java.lang.String replaceAllIgnoreCase(java.lang.String s,
                                                    java.lang.String oldS,
                                                    java.lang.String newS)

Returns a string where all occurences of oldS have been replaced with newS. If oldS occurs inside newS, it won't be replaced recursively (obviously). When finding oldS in s, their case is irrelevant.

Parameters:

s - the main string

oldS - the string to be searched for

newS - the string to replace oldS

Returns:

a modified version of s, with newS in place of all the olds. throws RuntimeException if s is null.

combineSpaces

public static java.lang.String combineSpaces(java.lang.String s)

Returns a string where all cases of more than one space are replaced by one space. The string is also trim'd to remove leading and trailing spaces. Also, spaces after { or ( and before ) or } will be removed.

Parameters:

s -

Returns:

s, but with the spaces combined (or null if s is null)

whitespacesToSpace

public static java.lang.String whitespacesToSpace(java.lang.String s)

replaceAll

public static java.lang.String replaceAll(java.lang.String s,
                                          char oldCh,
                                          char newCh)

Returns a string where all occurences of oldCh have been replaced with newCh. This doesn't throw exceptions if bad values.

commonUnicodeToPlainText

public static java.lang.String commonUnicodeToPlainText(java.lang.String s)

zeroPad

public static java.lang.String zeroPad(java.lang.String number,
                                       int nDigits)

This adds 0's to the left of the string until there are nDigits to the left of the decimal point (or nDigits total if there isn't a decimal point). If the number is too big, nothing is added or taken away.

Parameters:

number - a positive number. This doesn't handle negative numbers.

nDigits - the desired number of digits to the left of the decimal point (or total, if no decimal point)

Returns:

the number, left-padded with 0's so there are nDigits to the left of the decimal point

toJsonArray

public static java.lang.String toJsonArray(java.lang.String[] sa)

The converts a string[] into a JSON array of strings.

Parameters:

sa -

Returns:

e.g., ["aa", "bb", "cc"]. If sa is null, this returns null (as a String).

toJson

public static java.lang.String toJson(float f)

This makes a JSON version of a float.

Parameters:

f -

Returns:

"null" if not finite. Return an integer if it ends with ".0". Else returns the number as a string.

toJson

public static java.lang.String toJson(double d)

This makes a JSON version of a number.

Parameters:

d -

Returns:

"null" if not finite. Return an integer if it ends with ".0". Else returns the number as a string.

toJson

public static java.lang.String toJson(java.lang.String s)

This makes a JSON version of a string (\\, \f, \n, \r, \t and \" are escaped with a backslash character and double quotes are added before and after). null is returned as null. This variant encodes char #127 and above.

Parameters:

s -

Returns:

the JSON-encoded string surrounded by "'s.

toJson65536

public static java.lang.String toJson65536(java.lang.String s)

This variant doesn't encode high characters.

Parameters:

s -

Returns:

the JSON-encoded string surrounded by "'s.

toJson

public static java.lang.String toJson(java.lang.String s,
                                      int firstUEncodedChar)

This makes a JSON version of a string (\\, \f, \n, \r, \t and \" are escaped with a backslash character and double quotes are added before and after). null is returned as null. This variant encodes char #127 and above as \\uhhhh.

Parameters:

s - The String to be encoded.

firstUEncodedChar - The first char to be \\uhhhh encoded, commonly 127, 256, or 65536.

Returns:

the JSON-encoded string surrounded by "'s.

toJson

public static java.lang.String toJson(java.lang.String s,
                                      int firstUEncodedChar,
                                      boolean encodeNewline)

This is a variant of toJson that lets you encode newlines or not.

Parameters:

s - The String to be encoded.

firstUEncodedChar - The first char to be \\uhhhh encoded, commonly 127, 256, or 65536.

Returns:

the JSON-encoded string surrounded by "'s.

charToJsonString

public static java.lang.String charToJsonString(char ch,
                                                int firstUEncodedChar,
                                                boolean encodeNewline)

This encodes one char to the Json encoding.

fromJsonNotNull

public static java.lang.String fromJsonNotNull(java.lang.String s)

This is like the other fromJson, but returns "" instead of null.

ifJsonFromJson

public static java.lang.String ifJsonFromJson(java.lang.String s)

If the String is surrounded by ", this returns fromJson(s), else it returns s.

fromJson

public static java.lang.String fromJson(java.lang.String s)

This returns the unJSON version of a JSON string (surrounding "'s (if any) are removed and \\, \f, \n, \r, \t, \/, and \" are unescaped). This is very liberal in what it accepts, including all common C escaped characters: http://msdn.microsoft.com/en-us/library/h21280bw%28v=vs.80%29.aspx "null" returns the String "null". null returns null. This won't throw an exception.

Parameters:

s - it may be enclosed by "'s, or not.

Returns:

the decoded string

fromNccsvChar

public static char fromNccsvChar(java.lang.String s)

This converts an NCCSV encoded char to a true char (surrounding "'s and ''s (if any) are removed and \\, \f, \n, \r, \t, \/, and \" are unescaped). This is very liberal in what it accepts, including all common C escaped characters: http://msdn.microsoft.com/en-us/library/h21280bw%28v=vs.80%29.aspx

Parameters:

s - it may be enclosed by "'s and ''s, or not.

Returns:

the decoded char (or '?' if trouble) as a 1-char string.

fromNccsvString

public static java.lang.String fromNccsvString(java.lang.String s)

This converts an NCCSV string to a true string (surrounding "'s (if any) are removed and \\, \f, \n, \r, \t, \/, and \" are unescaped). This is very liberal in what it accepts, including all common C escaped characters: http://msdn.microsoft.com/en-us/library/h21280bw%28v=vs.80%29.aspx This won't throw an exception.

Parameters:

s - it may be enclosed by "'s, or not.

Returns:

the decoded string

toNccsvChar

public static java.lang.String toNccsvChar(char ch)

This encodes one char for an NCCSV char or String, without surrounding quotes.

toNccsvDataString

public static java.lang.String toNccsvDataString(java.lang.String s)

This encodes one String as an NCCSV data String, with surrounding double quotes only if necessary.

toNccsvAttString

public static java.lang.String toNccsvAttString(java.lang.String s)

This encodes one String as an NCCSV att String, with surrounding double quotes only if necessary.

toSVString

public static java.lang.String toSVString(java.lang.String s)

This encodes special characters in s if needed so that s can be stored as an item in a csv or tsv string.

substitute

public static java.lang.String substitute(java.lang.String msg,
                                          java.lang.String s0,
                                          java.lang.String s1,
                                          java.lang.String s2)

This replaces "{0}", "{1}", and "{2}" in msg with s0, s1, s2.

Parameters:

msg - a string which may contain "{0}", "{1}", and/or "{2}".

s0 - the first substitution string. If null, that substitution won't be attempted.

s1 - the second substitution string. If null, that substitution won't be attempted.

s2 - the third substitution string. If null, that substitution won't be attempted.

Returns:

the modified msg

toCSVString

public static java.lang.String toCSVString(java.lang.Object[] ar)

This returns a CSV (not CSSV) String.

toCSSVString

public static java.lang.String toCSSVString(java.lang.Object[] ar)

Generates a Comma-Space-Separated-Value (CSSV) string.

CHANGED: before 2011-03-06, this didn't do anything special for strings with internal commas or quotes. Now it uses toJson for that string.

CHANGED: before 2011-09-04, this was called toCSVString.

Parameters:

ar - an array of objects

Returns:

a CSSV String with the values with ", " after all but the last value. Returns null if ar is null. null elements are represented as "[null]".

toSSVString

public static java.lang.String toSSVString(java.lang.Object[] ar)

Generates a space-separated-value string.

WARNING: This is simplistic. It doesn't do anything special for strings with internal spaces.

Parameters:

ar - an array of objects (for an ArrayList or Vector, use o.toArray())

Returns:

a SSV String with the values with " " after all but the last value. Returns null if ar is null. null elements are represented as "[null]".

toNewlineString

public static java.lang.String toNewlineString(java.lang.Object[] ar)

Generates a newline-separated string, with a newline at the end.

WARNING: This is simplistic. It doesn't do anything special for strings with internal newlines.

Parameters:

ar - an array of objects (for an ArrayList or Vector, use o.toArray())

Returns:

a String with the values, with a '\n' after each value, even the last. Returns null if ar is null. null elements are represented as "[null]".

toSVString

public static java.lang.String toSVString(java.lang.Object[] ar,
                                          java.lang.String separator,
                                          boolean finalSeparator)

This is used at a low level to generate a 'separator'-separated-value string (without newlines) with the element.toString()'s from the array.

Parameters:

ar - an array of objects (for an ArrayList or Vector, use o.toArray())

separator - the separator string

finalSeparator - if true, a separator will be added to the end of the resulting string (if it isn't "").

Returns:

a separator-separated-value String. Returns null if ar is null. null elements are represented as "[null]".

toCSSVString

public static java.lang.String toCSSVString(boolean[] ar)

This generates a Comma-Space-Separated-Value (CSSV) String from the array.

CHANGED: before 2011-09-04, this was called toCSVString.

Parameters:

ar - an array of boolean

Returns:

a CSSV String (or null if ar is null)

toCSSVString

public static java.lang.String toCSSVString(byte[] ar)

This generates a Comma-Space-Separated-Value (CSSV) String from the array.

CHANGED: before 2011-09-04, this was called toCSVString.

Parameters:

ar - an array of bytes

Returns:

a CSSV String (or null if ar is null)

toCSSVString

public static java.lang.String toCSSVString(char[] ar)

This generates a Comma-Space-Separated-Value (CSSV) String from the array. (chars are treated as unsigned shorts).

CHANGED: before 2011-09-04, this was called toCSVString.

Parameters:

ar - an array of char

Returns:

a CSSV String (or null if ar is null)

to0xHexString

public static java.lang.String to0xHexString(int i,
                                             int nHexDigits)

This returns the int formatted as a 0x hex String with at least nHexDigits, e.g., 0x00FF00. Negative numbers are twos compliment, e.g., -4 -> 0xfffffffc.

toHexCSSVString

public static java.lang.String toHexCSSVString(byte[] ar)

This generates a hexadecimal Comma-Space-Separated-Value (CSSV) String from the array. Negative numbers are twos compliment, e.g., -4 -> 0xfc.

CHANGED: before 2011-09-04, this was called toHexCSVString.

Parameters:

ar - an array of bytes

Returns:

a CSSV String (or null if ar is null)

toCSSVString

public static java.lang.String toCSSVString(short[] ar)

This generates a Comma-Space-Separated-Value (CSSV) String from the array.

CHANGED: before 2011-09-04, this was called toCSVString.

Parameters:

ar - an array of shorts

Returns:

a CSSV String (or null if ar is null)

toHexCSSVString

public static java.lang.String toHexCSSVString(short[] ar)

This generates a hexadecimal Comma-Space-Separated-Value (CSSV) String from the array. Negative numbers are twos compliment, e.g., -4 -> 0xfffc.

CHANGED: before 2011-09-04, this was called toHexCSVString.

Parameters:

ar - an array of short

Returns:

a CSSV String (or null if ar is null)

toCSSVString

public static java.lang.String toCSSVString(int[] ar)

This generates a Comma-Space-Separated-Value (CSSV) String from the array.

CHANGED: before 2011-09-04, this was called toCSVString.

Parameters:

ar - an array of ints

Returns:

a CSSV String (or null if ar is null)

toHexCSSVString

public static java.lang.String toHexCSSVString(int[] ar)

This generates a hexadecimal Comma-Space-Separated-Value (CSSV) String from the array. Negative numbers are twos compliment, e.g., -4 -> 0xfffffffc.

CHANGED: before 2011-09-04, this was called toHexCSVString.

Parameters:

ar - an array of ints

Returns:

a CSSV String (or null if ar is null)

toCSSVString

public static java.lang.String toCSSVString(long[] ar)

This generates a Comma-Space-Separated-Value (CSSV) String from the array.

CHANGED: before 2011-09-04, this was called toCSVString.

Parameters:

ar - an array of longs

Returns:

a CSSV String (or null if ar is null)

toCSSVString

public static java.lang.String toCSSVString(float[] ar)

This generates a Comma-Space-Separated-Value (CSSV) String from the array.

CHANGED: before 2011-09-04, this was called toCSVString.

Parameters:

ar - an array of float

Returns:

a CSSV String (or null if ar is null)

toCSSVString

public static java.lang.String toCSSVString(double[] ar)

This generates a Comma-Space-Separated-Value (CSSV) String from the array.

CHANGED: before 2011-09-04, this was called toCSVString.

Parameters:

ar - an array of double

Returns:

a CSSV String (or null if ar is null)

toNewlineString

public static java.lang.String toNewlineString(int[] ar)

This generates a newline-separated (always '\n') String from the array.

Parameters:

ar - an array of ints

Returns:

a newline-separated String (or null if ar is null)

toNewlineString

public static java.lang.String toNewlineString(double[] ar)

This generates a newline-separated (always '\n') String from the array.

Parameters:

ar - an array of double

Returns:

a newline-separated String (or null if ar is null)

toStringArray

public static java.lang.String[] toStringArray(java.lang.Object[] aa)

This converts an Object[] into a String[]. If you have an ArrayList or a Vector, use arrayList.toArray().

Parameters:

aa -

Returns:

the corresponding String[] by calling toString() for each object

arrayToCSSVString

public static java.lang.String arrayToCSSVString(java.lang.Object value)

This returns a nice String representation of the attribute value (which should be a String or an array of primitives).

CHANGED: before 2011-09-04, this was called toCSVString.

Parameters:

value -

Returns:

a nice String representation

toByteArray

public static byte[] toByteArray(java.lang.String s)

This extracts the lower 8 bits of each char to form a byte array.

Parameters:

s - a String

Returns:

the corresponding byte[] (or null if s is null)

indexOfObject

public static int indexOfObject(java.lang.Object[] ar,
                                java.lang.Object o,
                                int startAt)

This finds the first element in Object[] (starting at element startAt) where ar[i]==o.

Parameters:

ar - the array of Objects

o - the String to be found

startAt - the first element of ar to be checked. If startAt < 0, this starts with startAt = 0. If startAt >= ar.length, this returns -1.

Returns:

the element number of ar which is equal to s (or -1 if ar is null, or s is null or not found)

indexOfObject

public static int indexOfObject(java.lang.Object[] ar,
                                java.lang.Object o)

A variant of indexOfObject() that uses startAt=0.

indexOf

public static int indexOf(java.lang.Object[] ar,
                          java.lang.String s)

This finds the first element in Object[] where the ar[i].toString value equals to s.

Parameters:

ar - the array of Objects (Strings?)

s - the String to be found

Returns:

the element number of ar which is equal to s (or -1 if ar is null, or s is null or not found)

indexOf

public static int indexOf(java.lang.Object[] ar,
                          java.lang.String s,
                          int startAt)

This finds the first element in Object[] (starting at element startAt) where the ar[i].toString value equals s.

Parameters:

ar - the array of Objects

s - the String to be found

startAt - the first element of ar to be checked. If startAt < 0, this starts with startAt = 0. If startAt >= ar.length, this returns -1.

Returns:

the element number of ar which is equal to s (or -1 if ar is null, or s is null or not found)

caseInsensitiveIndexOf

public static int caseInsensitiveIndexOf(java.lang.Object[] ar,
                                         java.lang.String s)

This finds the first element in Object[] where ar[i].toString().toLowerCase() equals to s.toLowerCase(). This could have been called indexOfIgnoreCase().

Parameters:

ar - the array of Objects

s - the String to be found

Returns:

the element number of ar which is equal to s (or -1 if s is null or not found)

lineContaining

public static int lineContaining(java.lang.Object[] ar,
                                 java.lang.String s)

This finds the first element in Object[] where the ar[i].toString value contains the substring s.

Parameters:

ar - the array of objects

s - the String to be found

Returns:

the element number of ar which is equal to s (or -1 if not found)

lineContaining

public static int lineContaining(java.lang.Object[] ar,
                                 java.lang.String s,
                                 int startAt)

This finds the first element in Object[] (starting at element startAt) where the ar[i].toString value contains the substring s.

Parameters:

ar - the array of objects

s - the String to be found

startAt - the first element of ar to be checked. If startAt < 0, this starts with startAt = 0.

Returns:

the element number of ar which is equal to s (or -1 if not found)

lineContainingIgnoreCase

public static int lineContainingIgnoreCase(java.lang.Object[] ar,
                                           java.lang.String s,
                                           int startAt)

This finds the first element in Object[] (starting at element startAt) where the ar[i].toString value contains the substring s (ignoring the case of ar and s).

Parameters:

ar - the array of objects

s - the String to be found

startAt - the first element of ar to be checked. If startAt < 0, this starts with startAt = 0.

Returns:

the element number of ar which is equal to s (or -1 if not found)

stringStartsWith

public static java.lang.String stringStartsWith(java.lang.Object[] ar,
                                                java.lang.String s)

This returns the first element in Object[] (starting at element 0) where the ar[i].toString value starts with s.

Parameters:

ar - the array of objects

s - the String to be found

Returns:

the first element ar (as a String) which starts with s (or null if not found)

lineStartsWith

public static int lineStartsWith(java.lang.Object[] ar,
                                 java.lang.String s)

This finds the first element in Object[] (starting at element 0) where the ar[i].toString value starts with s.

Parameters:

ar - the array of objects

s - the String to be found

Returns:

the element number of ar which starts with s (or -1 if not found)

lineStartsWith

public static int lineStartsWith(java.lang.Object[] ar,
                                 java.lang.String s,
                                 int startAt)

This finds the first element in Object[] (starting at element startAt) where the ar[i].toString value starts with s.

Parameters:

ar - the array of objects

s - the String to be found

startAt - the first element of ar to be checked. If startAt < 0, this starts with startAt = 0.

Returns:

the element number of ar which starts with s (or -1 if not found)

lineStartsWithIgnoreCase

public static int lineStartsWithIgnoreCase(java.lang.Object[] ar,
                                           java.lang.String s)

This variant of lineStartsWith startsAt index=0.

Parameters:

ar - the array of objects, e.g., including LATITUDE

s - the String to be found, e.g., Lat

Returns:

the element number of ar which starts with s (or -1 if not found)

lineStartsWithIgnoreCase

public static int lineStartsWithIgnoreCase(java.lang.Object[] ar,
                                           java.lang.String s,
                                           int startAt)

This is like lineStartsWith, but ignores case.

Parameters:

ar - the array of objects, e.g., including LATITUDE

s - the String to be found, e.g., Lat

startAt - the first element of ar to be checked. If startAt < 0, this starts with startAt = 0.

Returns:

the element number of ar which starts with s (or -1 if not found)

whichPrefix

public static int whichPrefix(java.lang.String[] prefixes,
                              java.lang.String longerString,
                              int startAt)

This finds the first element in prefixes (starting at element startAt) where the longerString starts with prefixes[i].

Parameters:

prefixes - the array of prefixes

longerString - the String that might start with one of the prefixes

startAt - the first element of ar to be checked. If startAt < 0, this starts with startAt = 0.

Returns:

the element number of prefixes which longerString starts with (or -1 if not found)

findPrefix

public static java.lang.String findPrefix(java.lang.String[] prefixes,
                                          java.lang.String longerString,
                                          int startAt)

This is like whichPrefix, but returns the found prefix (or null).

Parameters:

prefixes - the array of prefixes

longerString - the String that might start with one of the prefixes

startAt - the first element of ar to be checked. If startAt < 0, this starts with startAt = 0.

Returns:

the prefixes[i] which longerString starts with (or null if not found)

whichSuffix

public static int whichSuffix(java.lang.String[] suffixes,
                              java.lang.String longerString,
                              int startAt)

This finds the first element in suffixes (starting at element startAt) where the longerString ends with suffixes[i].

Parameters:

suffixes - the array of suffixes

longerString - the String that might end with one of the suffixes

startAt - the first element of ar to be checked. If startAt < 0, this starts with startAt = 0.

Returns:

the element number of suffixes which longerString ends with (or -1 if not found)

split

public static java.lang.String[] split(java.lang.String s,
                                       char separator)

This splits the string at the specified character. The substrings are trim'd. A missing final string is treated as "" (not discarded as with String.split).

Parameters:

s - a string with 0 or more separator chatacters

separator -

Returns:

a String[] with the strings (not canonical). s=null returns null. s="" returns String[1]{""}.

splitNoTrim

public static java.lang.String[] splitNoTrim(java.lang.String s,
                                             char separator)

This splits the string at the specified character. A missing final string is treated as "" (not discarded as with String.split).

Parameters:

s - a string with 0 or more separator chatacters

separator -

Returns:

a String[] with the strings (not canonical). s=null returns null. s="" returns String[1]{""}.

toIntArray

public static int[] toIntArray(java.lang.Object[] oar)

This converts an Object[] (for example, where objects are Strings or Integers) into an int[].

Parameters:

oar - an Object[]

Returns:

the corresponding int[] (invalid values are converted to Integer.MAX_VALUE). oar=null returns null.

toFloatArray

public static float[] toFloatArray(java.lang.Object[] oar)

This converts an Object[] (for example, where objects are Strings or Floats) into a float[].

Parameters:

oar - an Object[]

Returns:

the corresponding float[] (invalid values are converted to Float.NaN). oar=null returns null.

toDoubleArray

public static double[] toDoubleArray(java.lang.Object[] oar)

This converts an Object[] (for example, where objects are Strings or Doubles) into a double[].

Parameters:

oar - an Object[]

Returns:

the corresponding double[] (invalid values are converted to Double.NaN). oar=null returns null.

justFiniteValues

public static int[] justFiniteValues(int[] iar)

This returns an int[] with just the non-Integer.MAX_VALUE values from the original array.

Parameters:

iar - is an int[]

Returns:

a new int[] with just the non-Integer.MAX_VALUE values. iar=null returns null.

justFiniteValues

public static double[] justFiniteValues(double[] dar)

This returns a double[] with just the finite values from the original array.

Parameters:

dar - is a double[]

Returns:

a new double[] with just finite values. dar=null returns null.

removeNull

public static java.lang.String[] removeNull(java.lang.String[] sar)

This returns a String[] with just non-null strings from the original array.

Parameters:

sar - is a String[]

Returns:

a new String[] with just non-null strings. sar=null returns null.

removeNullOrEmpty

public static java.lang.String[] removeNullOrEmpty(java.lang.String[] sar)

This returns a String[] with just non-null and non-"" strings from the original array.

Parameters:

sar - is a String[]

Returns:

a new String[] with just non-null and non-"" strings. sar=null returns null.

csvToIntArray

public static int[] csvToIntArray(java.lang.String csv)

This converts a comma-separated-value String into an int[]. Invalid values are converted to Integer.MAX_VALUE.

Parameters:

csv - the comma-separated-value String.

Returns:

the corresponding int[]. csv=null returns null. csv="" is converted to int[1]{Integer.MAX_VALUE}.

csvToDoubleArray

public static double[] csvToDoubleArray(java.lang.String csv)

This converts a comma-separated-value String into a double[]. Invalid values are converted to Double.NaN.

Parameters:

csv - the comma-separated-value String

Returns:

the corresponding double[]. csv=null returns null. csv="" is converted to double[1]{Double.NAN}.

parseBoolean

public static boolean parseBoolean(java.lang.String s)

This converts a string to a boolean.

Parameters:

s - the string

Returns:

false if s is "false", "f", or "0". Case and leading/trailing spaces don't matter. All other values (and null) are treated as true.

parseBooleanToInt

public static byte parseBooleanToInt(java.lang.String s)

This converts a string to a boolean and then an int.

Parameters:

s - the string

Returns:

Integer.MAX_VALUE (i.e., missing value) if s is null or s is "". Return 0 if s is "false", "f", or "0". Return 1 if for all other values. Case and leading/trailing spaces don't matter.

removeLeading

public static java.lang.String removeLeading(java.lang.String s,
                                             char ch)

This removes leading ch's.

Parameters:

s -

ch -

Returns:

s or a new string without leading ch's. null returns null.

parseInt

public static int parseInt(java.lang.String s,
                           int def)

Like parseInt(s), but returns def if error).

parseInt

public static int parseInt(java.lang.String s)

Convert a string to an int. Leading or trailing spaces are automatically removed. This accepts hexadecimal integers starting with "0x". Leading 0's (e.g., 0012) are ignored; number is treated as decimal (not octal as Java would). Floating point numbers are rounded. This won't throw an exception if the number isn't formatted right. To make a string from an int, use ""+i, Integer.toHexString, or Integer.toString(i,radix).

Parameters:

s - is the String representation of a number.

Returns:

the int value from the String (or Integer.MAX_VALUE if error).

parseDouble

public static double parseDouble(java.lang.String s)

Convert a string to a double. Leading or trailing spaces are automatically removed. This accepts hexadecimal integers starting with "0x". Whole number starting with '0' (e.g., 012) is treated as decimal (not octal as Java would). This won't throw an exception if the number isn't formatted right.

Parameters:

s - is the String representation of a number.

Returns:

the double value from the String (a finite value, Double.POSITIVE_INFINITY, Double.NEGATIVE_INFINITY, or Double.NaN if error).

isDoubleTrouble

public static boolean isDoubleTrouble(java.lang.String s)

DON'T USE THIS; RELY ON THE FIXES AVAILABLE FOR JAVA: EITHER THE LATEST VERSION OF JAVA OR THE JAVA UPDATER TO FIX THE BUG ON EXISTING OLDER JAVA INSTALLATIONS https://www.oracle.com/technetwork/java/javase/fpupdater-tool-readme-305936.html

This returns true if s is a value that causes Java to hang. Avoid java hang. 2011-02-09 http://www.exploringbinary.com/java-hangs-when-converting-2-2250738585072012e-308 This was Bob's work-around to avoid the Java bug.

Parameters:

s - a string representing a double value

Returns:

true if the value is the troublesome value. If true, the value can be interpreted as either +/-Double.MIN_VALUE (not sure which) or (crudely) 0.

roundingParseInt

public static double roundingParseInt(java.lang.String s)

Convert a string to an int, with rounding. Leading or trailing spaces are automatically removed. This won't throw an exception if the number isn't formatted right.

Parameters:

s - is the String representation of a number.

Returns:

the int value from the String (or Double.NaN if error).

parseLong

public static long parseLong(java.lang.String s)

This converts String representation of a long. Leading or trailing spaces are automatically removed. THIS DOESN'T ROUND! So floating point values lead to Long.MAX_VALUE.

Parameters:

s - a valid String representation of a long value

Returns:

a long (or Long.MAX_VALUE if trouble).

parseFloat

public static float parseFloat(java.lang.String s)

Parse as a float with either "." or "," as the decimal point. Leading or trailing spaces are automatically removed.

Parameters:

s - a String representing a float value (e.g., 1234.5 or 1234,5 or 1.234e3 1,234e3)

Returns:

the corresponding float (or Float.NaN if not properly formatted)

tokenize

public static java.lang.String[] tokenize(java.lang.String s)

This converts a multiple-space-separated string into a String[] of separate tokens. Double quoted tokens may have internal spaces.

Parameters:

s - the space-separated string

Returns:

String[] of tokens (or null if s is null)

noLongLines

public static java.lang.String noLongLines(java.lang.String s,
                                           int maxLength,
                                           java.lang.String spaces)

If lines in s are >=maxLength characters, this inserts "\n"+spaces at the previous non-DigitLetter + DigitLetter; or if none, this inserts "\n"+spaces at maxLength. Useful keywords for searching for this method: longer, longest, noLongerThan.

Parameters:

s - a String with multiple lines, separated by \n's

maxLength - the maximum line length allowed

spaces - the string to be inserted after the inserted newline, e.g., "<br> "

Returns:

s (perhaps the same, perhaps different), but with no long lines

noLongLinesAtSpace

public static java.lang.String noLongLinesAtSpace(java.lang.String s,
                                                  int maxLength,
                                                  java.lang.String spaces)

This is like noLongLines, but will only break at spaces.

Parameters:

s - a String with multiple lines, separated by \n's

maxLength - the maximum line length allowed

spaces - the string to be inserted after the inserted newline, e.g., " "

Returns:

the content of s, but with no long lines

genEFormat6

public static java.lang.String genEFormat6(double d)

This returns the number formatted with up to 6 digits to the left and right of the decimal and trailing decimal 0's removed. If abs(d) < 0.0999995 or abs(d) >= 999999.9999995, the number is displayed in scientific notation (e.g., 8.954321E-5). Thus the maximum length should be 14 characters (-123456.123456). 0 returns "0" NaN returns "NaN". Double.POSITIVE_INFINITY returns "Infinity". Double.NEGATIVE_INFINITY returns "-Infinity".

Parameters:

d - a number

Returns:

the number converted to a string

genEFormat10

public static java.lang.String genEFormat10(double d)

This returns the number formatted with up to 10 digits to the left and right of the decimal and trailing decimal 0's removed. If abs(d) < 0.09999999995 or abs(d) >= 999999.99999999995, the number is displayed in scientific notation (e.g., 8.9544680321E-5). Thus the maximum length should be 18 characters (-123456.1234567898). 0 returns "0" NaN returns "NaN". Double.POSITIVE_INFINITY returns "Infinity". Double.NEGATIVE_INFINITY returns "-Infinity".

Parameters:

d - a number

Returns:

the number converted to a string

genX10Format6

public static java.lang.String genX10Format6(double d)

This is like genEFormat6, but the scientific notation format is, e.g., 8.954321x10^-5.

Parameters:

d - a number

Returns:

the number converted to a string

genX10Format10

public static java.lang.String genX10Format10(double d)

This is like genEFormat10, but the scientific notation format is, e.g., 8.9509484321x10^-5.

Parameters:

d - a number

Returns:

the number converted to a string

genHTMLFormat6

public static java.lang.String genHTMLFormat6(double d)

This is like genEFormat6, but the scientific notation format is, e.g., 8.954321x10^-5.

Parameters:

d - a number

Returns:

the number converted to a string

genHTMLFormat10

public static java.lang.String genHTMLFormat10(double d)

This is like genEFormat10, but the scientific notation format is, e.g., 8.9509244321x10^-5.

Parameters:

d - a number

Returns:

the number converted to a string

trimStart

public static java.lang.String trimStart(java.lang.String s)

This trims just the start of the string.

Parameters:

s -

Returns:

s with just the start of the string trim'd. If s == null, this returns null.

trimEnd

public static java.lang.String trimEnd(java.lang.String s)

This trims just the end of the string.

Parameters:

s -

Returns:

s with just the end of the string trim'd. If s == null, this returns null.

binaryFindLastLE

public static int binaryFindLastLE(java.lang.String[] sar,
                                   java.lang.String s)

Find the last element which is <= s in an ascending sorted array.

Parameters:

sar - an ascending sorted String[] which may have duplicate values

s -

Returns:

the index of the last element which is <= s in an ascending sorted array. If s is null or s < the smallest element, this returns -1 (no element is appropriate). If s > the largest element, this returns sar.length-1.

binaryFindFirstGE

public static int binaryFindFirstGE(java.lang.String[] sar,
                                    java.lang.String s)

Find the first element which is >= s in an ascending sorted array.

Parameters:

sar - an ascending sorted String[] which currently may not have duplicate values

s -

Returns:

the index of the first element which is >= s in an ascending sorted array. If s < the smallest element, this returns 0. If s is null or s > the largest element, this returns sar.length (no element is appropriate).

binaryFindClosest

public static int binaryFindClosest(java.lang.String[] sar,
                                    java.lang.String s)

Find the closest element to s in an ascending sorted array.

Parameters:

sar - an ascending sorted String[]. It the array has duplicates and s equals one of them, it isn't specified which duplicate's index will be returned.

s -

Returns:

the index of the element closest to s. If s is null, this returns -1.

findInvalidUnicode

public static int findInvalidUnicode(java.lang.String s,
                                     java.lang.String alsoOK)

This returns the index of the first non-Unicode character. Currently, valid characters are #32 - #126, #160+.

Parameters:

s -

alsoOK - a string with characters (e.g., \r, \n, \t) which are also valid

Returns:

the index of the first non-utf-8 character, or -1 if all valid.

makeValidUnicode

public static java.lang.String makeValidUnicode(java.lang.String s,
                                                java.lang.String alsoOK)

This makes s valid Unicode by converting invalid characters (e.g., #128) with \\uhhhh (literally 2 backslashes, so no info is lost). The invalid characters are often Windows charset characters #127 - 159.

Parameters:

s -

alsoOK - a string with characters (e.g., \r, \n, \t) which are also valid

Returns:

the valid Unicode string.

toIso88591Char

public static char toIso88591Char(char ch)

This converts the char to an ISO-8859-1 (ISO_8859_1) char. This converts any char in 127-159 and >255 into '?'.

Parameters:

ch - the char to be converted

Returns:

an ISO_8859_1-only char.

toIso88591Chars

public static char[] toIso88591Chars(char[] car)

This converts the chars to ISO-8859-1 (ISO_8859_1) chars. This converts any char in 127-159 and >255 into '?'.

Parameters:

car[] - the char[] to be converted

Returns:

car for convenience.

stringToUtf8Bytes

public static byte[] stringToUtf8Bytes(java.lang.String s)

This returns the UTF-8 encoding of the string (or null if trouble). The inverse of this is utf8BytesToString. This won't throw an exception and returns ERROR (as bytes) if trouble.

Returns:

the byte[]. null in returns null. length=0 returns BAR_ZERO.

utf8BytesToString

public static java.lang.String utf8BytesToString(byte[] bar)

This returns a string from the UTF-8 encoded byte[] (or ERROR if trouble). The inverse of this is stringToUtf8Bytes. This won't throw an exception unless bar is invalid and returns ERROR if trouble. null in returns null out.

md5Hex

public static java.lang.String md5Hex(java.lang.String password)

This returns the MD5 hash digest of stringToUtf8Bytes(password) as a String of 32 lowercase hex digits. Lowercase because the digest authentication standard uses lower case; so mimic them. And lowercase is easier to type.

Parameters:

password - the text to be digested

Returns:

the MD5 hash digest of the password (32 lowercase hex digits, as a String), or null if password is null or there is trouble.

passwordDigest

public static java.lang.String passwordDigest(java.lang.String algorithm,
                                              java.lang.String password)

This returns the hash digest of stringToUtf8Bytes(password) as a String of lowercase hex digits. Lowercase because the digest authentication standard uses lower case; so mimic them. And lowercase is easier to type.

Parameters:

algorithm - one of the FILE_DIGEST_OPTIONS {"MD5", "SHA-1", "SHA-256", "SHA-384", "SHA-512" };

password - the text to be digested

Returns:

the algorithm's hash digest of the password (many lowercase hex digits, as a String), or null if password is null or there is trouble.

md5Hex12

public static java.lang.String md5Hex12(java.lang.String password)

This returns the last 12 hex digits from md5Hex (or null if md5 is null), broken into 3 blocks of 4 digits, separated by '_'. I use this as a short, easy to type, repeatable, representation of long strings (e.g., an ERDDAP™ query URL), sort of like the idea of tinyURL. It performs much better than hashcode or CRC32 when a large number of passwords (or filenames) are encoded and you don't want any collisions. See Projects.testHashFunctions.

differentLine

public static java.lang.String differentLine(java.lang.String oldS,
                                             java.lang.String newS)

Given two strings with internal newlines, oldS and newS, this a message indicating where they differ.

Parameters:

oldS -

newS -

Returns:

a message indicating where they differ, or "" if there is no difference.

toRational

public static int[] toRational(double d)

This converts a double to a rational number (m * 10^t). This is similar to Math2.mantissa and Math2.intExponent, but works via string manipulation to avoid roundoff problems (e.g., with 6.6260755e-24).

Parameters:

d -

Returns:

int[2]: [0]=m, [1]=t. (or {0, 0} if d=0, or {1, Integer.MAX_VALUE} if !finite(d))

encodeFileNameSafe

public static java.lang.String encodeFileNameSafe(java.lang.String s)

This is different from String2.modifyToBeFileNameSafe -- this encodes non-fileNameSafe characters so little or no information is lost.
This returns the string with just file-name-safe characters (0-9, A-Z, a-z, _, -, .).
'x' and non-safe characters are CONVERTED to 'x' plus their 2 lowercase hexadecimalDigit number or "xx" + their 4 hexadecimalDigit number.
See posix fully portable file names at https://en.wikipedia.org/wiki/Filename .
When the encoding is more than 25 characters, this stops encoding and adds "xh" and the hash code for the entire original string, so the result will always be less than ~41 characters.

THIS WON'T BE CHANGED. FILE NAMES CREATED FOR EDDGridCopy and EDDTableCopy DEPEND ON SAME ENCODING OVER TIME.

Parameters:

s -

Returns:

s with all of the non-fileNameSafe characters changed.
If s is null, this returns "x-1".
If s is "", this returns "x-0".

encodeMatlabNameSafe

public static java.lang.String encodeMatlabNameSafe(java.lang.String s)

This is like encodeFileNameSafe, but further restricts the name to

• first character must be A-Z, a-z.
• subsequent characters must be A-Z, a-z, _, 0-9.

'x' and non-safe characters are CONVERTED to 'x' plus their 2 lowercase hexadecimalDigit number or "xx" + their 4 hexadecimalDigit number.
See posix fully portable file names at https://en.wikipedia.org/wiki/Filename .
When the encoding is more than 25 characters, this stops encoding and adds "xh" and the hash code for the entire original string, so the result will always be less than ~41 characters.
This meets MatLab restrictions: https://www.mathworks.com/help/matlab/ref/matlab.lang.makevalidname.html

THIS WON'T BE CHANGED. FILE NAMES CREATED FOR EDDGridFromFile and EDDTableFromFile DEPEND ON SAME ENCODING OVER TIME.

Parameters:

s -

Returns:

s with all of the non-variableNameSafe characters changed.
If s is null, this returns "x_1".
If s is "", this returns "x_0".

simpleMatlabNameSafe

public static java.lang.String simpleMatlabNameSafe(java.lang.String s)

This is like encodeMatlabNameSafe, but simpler and won't always retain all the info.

• first character must be A-Z, a-z.
• subsequent characters must be A-Z, a-z, _, 0-9.

non-safe characters are some safe variant.
See posix fully portable file names at https://en.wikipedia.org/wiki/Filename .
When the encoding is more than 25 characters, this stops encoding and adds "xh" and the hash code for the entire original string, so the result will always be less than ~41 characters.
This meets MatLab restrictions: https://www.mathworks.com/help/matlab/ref/matlab.lang.makevalidname.html

THIS WON'T BE CHANGED. SOME datasetIDs DEPEND ON SAME ENCODING OVER TIME.

Parameters:

s -

Returns:

s with all of the non-variableNameSafe characters changed.
If s is null, this returns "null_".
If s is "", this returns "nothing_".

quoteParameterIfNeeded

public static java.lang.String quoteParameterIfNeeded(java.lang.String s)

For command line parameters, this returns toJson(s) if the string is empty or contains special characters or single or double quotes or backslash; otherwise it return s.

toTitleCase

public static java.lang.String toTitleCase(java.lang.String s)

This changes the characters case to title case (only letters after non-letters are capitalized). This is simplistic (it doesn't know about acronyms or pH or ...).

toSentenceCase

public static java.lang.String toSentenceCase(java.lang.String s)

This changes the character's case to sentence case (first letter and first letter after each period capitalized). This is simplistic.

toVariableName

public static java.lang.String toVariableName(java.lang.String s)

This suggests a camel-case variable name.

Parameters:

s - the starting string for the variable name.

Returns:

a valid variable name asciiLowerCaseLetter+asciiDigitLetter*, using camel case. This is a simplistic suggestion. Different strings may return the same variable name. null returns "null". "" returns "a".

camelCaseToTitleCase

public static java.lang.String camelCaseToTitleCase(java.lang.String s)

This converts "camelCase99String" to "Camel Case 99 String"

Parameters:

s - the camel case string.

Returns:

the string with spaces before capital letters. null returns null. "" returns "".

isIso8859

public static boolean isIso8859(java.lang.String s)

This returns true if the string contains only ISO 8859-1 characters (i.e., 0 - 255).

isSomething

public static boolean isSomething(java.lang.String s)

This returns true if s isn't null and s.trim().length() > 0.

isSomething2

public static boolean isSomething2(java.lang.String s)

This returns true if s isn't null, "", "-", "null", "nd", "N/A", "...", "???", etc.

periodSpaceConcat

public static java.lang.String periodSpaceConcat(java.lang.String a,
                                                 java.lang.String b)

This cleverly concatenates the 2 strings (with "", ". ", or " ", as appropriate.

ifSomethingConcat

public static java.lang.String ifSomethingConcat(java.lang.String a,
                                                 java.lang.String separator,
                                                 java.lang.String b)

This cleverly concatenates the 2 strings (with separator, as appropriate).

Parameters:

a - may be null or "" or something

separator - will only be used if a and b are something.

b - may be null or "" or something

Returns:

a.trim(), a.trim()+separator+b.trim(), b.trim(), or ""