Util (CML Euclid 2.9 API)

java.lang.Object
- org.xmlcml.euclid.Util

All Implemented Interfaces:

EuclidConstants
```
public class Util
extends Object
implements EuclidConstants
```
A number of miscellaneous tools. Originally devised for jumbo.sgml, now rewritten for jumbo.xml. Use these at your peril - some will be phased out

Author:

(C) P. Murray-Rust, 1998, 20 August 2003

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Util.Message
messages

Nested Classes
Modifier and Type	Class and Description
`static class`	`Util.Message` messages

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DATE_REGEX1` date of form 21-jan-1965.
`static String`	`DATE_REGEX2` date of form 1965-01-25.
`static String[]`	`GREEK_ENTITIES` greek entities
`static Map<String,Character>`	`GREEK2CHARACTER_MAP`
`static String[]`	`ISOLATIN_ENTITIES` isolatin entities
`static int`	`ISOLATIN_HI`
`static int`	`ISOLATIN_LO`
`static String[]`	`LOWER_ROMAN_NUMERAL`
`static String`	`LOWER_ROMAN_REGEX` regex matching roman numbers up to m ("[ivxlcdm]+").
`static String[]`	`months` month data .
`static String[]`	`UPPER_GREEK_ENTITIES` UPPER_GREEK entities
`static String`	`UPPER_ROMAN_REGEX` regex matching roman numbers up to M ("[IVXLCDM]+").

Fields inherited from interface org.xmlcml.euclid.EuclidConstants
C_AMP, C_APOS, C_ATSIGN, C_BACKSLASH, C_BACKSPACE, C_CARET, C_COLON, C_COMMA, C_DEL, C_DOLLAR, C_EQUALS, C_FORMFEED, C_HASH, C_LANGLE, C_LBRAK, C_LCURLY, C_LSQUARE, C_MINUS, C_NBSP, C_NEWLINE, C_NL, C_PERCENT, C_PERIOD, C_PIPE, C_PLUS, C_POUND, C_QUERY, C_QUOT, C_RANGLE, C_RBRAK, C_RCURLY, C_RETURN, C_RSQUARE, C_SEMICOLON, C_SHRIEK, C_SLASH, C_SPACE, C_STAR, C_TAB, C_TILDE, C_UNDER, EPS, F_S, NONWHITEPUNC, NONWHITEPUNC0, NONWHITEPUNC0REGEX, ONE_THIRD, PUNC, S_AMP, S_APOS, S_ATSIGN, S_BACKSLASH, S_CARET, S_COLON, S_COMMA, S_DOLLAR, S_EMPTY, S_EQUALS, S_FORMFEED, S_HASH, S_LANGLE, S_LBRAK, S_LCURLY, S_LSQUARE, S_MINUS, S_NEWLINE, S_NL, S_PERCENT, S_PERIOD, S_PIPE, S_PLUS, S_POUND, S_QUERY, S_QUOT, S_RANGLE, S_RBRAK, S_RCURLY, S_RETURN, S_RSQUARE, S_SEMICOLON, S_SHRIEK, S_SLASH, S_SPACE, S_STAR, S_TAB, S_TILDE, S_UNDER, S_WHITEREGEX, TWO_THIRDS, U_S, WHITESPACE

Constructor Summary

Constructors
Constructor and Description

Util()

Constructors
Constructor and Description
`Util()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static String[]`	`addElementToStringArray(String[] array, String s)` convenience method to extend array of Strings.
`static void`	`BUG(Exception e)` traps a bug.
`static void`	`BUG(String msg)` traps a bug.
`static void`	`BUG(String msg, Exception e)` traps a bug.
`static void`	`BUG(String msg, Throwable t)` traps a bug.
`static void`	`BUG(Throwable t)` traps a bug.
`static String`	`buildPath(String... parts)` gets build path from its components.
`static String`	`calculateMD5(String s)` borrowed from somewhere.
`static String`	`capitalise(String s)` capitalise a String (whatever the starting case)
`static void`	`check(double[] array, int size)` checks array is not null and is of given size.
`static void`	`check(int n, int low, int high)` checks that an in is in the range low to high.
`static boolean`	`checkPMR()` checks that this is local to PMR.
`static String`	`concatenate(boolean[] bb, String separator)` concatenates array of booleans.
`static String`	`concatenate(double[][] ss, String separator)` concatenates array of array of doubles.
`static String`	`concatenate(double[] ss, String separator)` concatenates array of doubles.
`static String`	`concatenate(int[] ss, String separator)` concatenates array of ints.
`static String`	`concatenate(String[] ss, String separator)` concatenates array of Strings.
`static boolean`	`containsString(String[] strings, String s)` does an array of Strings contain a String.
`static char[]`	`convertLatin1ToUTF8(char a)` convert single IsoLatin1 character to 2 UTF8 characters .
`static char`	`convertUTF8ToLatin1(char a, char b)` convert 2 UTF8 characters to single IsoLatin1 character.
`static void`	`copyFile(File inFile, File outFile)` copy one file to another (I suspect there is a better way
`static String`	`createCommaSeparatedStrings(List<String> v)` create comma-separated Strings fields include a comma or a " they are wrapped with quotes (").
`static void`	`createFile(File dir, String filename)` creates directories and files if they don't exist.
`static List<String>`	`createList(String[] ss)` translate array of Strings to a List.
`static File`	`createNewFile(String fileName)` create new file, including making directory if required This seems to be a mess - f.createNewFile() doesn't seem to work A directory should have a trailing file.separator
`static boolean`	`deleteFile(File file, boolean deleteDirectory)` delete a file If directory==true then file will be recursively deleted
`static String`	`deQuote(String s)` remove balanced quotes from ends of (trimmed) string, else no action
`static String`	`dump(URL url)` reads a stream from url and outputs it as integer values of the characters and as strings.
`static void`	`error(String s)` Error message - nothing fancy at present.
`static double`	`format(double d, int ndec)` format trailing decimals
`static String`	`getCanonicalDate(String s)` parse string as date.
`static String`	`getCanonicalPath(File file)` avoids the checked exception
`static List<String>`	`getCommaSeparatedStrings(String s)` parse comma-separated Strings Note fields can be EC.S_EMPTY (as in ,,,) and fields can be quoted "...".
`static double`	`getDouble(String s)`
`static FileOutputStream`	`getFileOutputStream(String fileName)` get an OutputStream from a file or URL.
`static InputStream`	`getInputStreamFromResource(String filename)` convenience method to get input stream from resource.
`static int`	`getIntFromHex(String hex)` Translates a Hex number to its int equivalent.
`static int`	`getPrime(int i)` get i'th prime.
`static String`	`getPWDName()` get current directory
`static String`	`getRelativeFilename(File file1, File file2, String newSeparator)` path to create file2 from file1
`static String`	`getRelativePath(String targetPath, String basePath, String pathSeparator)` Get the relative path from one file to another, specifying the directory separator.
`static URL`	`getResource(String filename)` creates resource from filename.
`static File`	`getResourceFile(String... path)` gets file from build path components.
`static InputStream`	`getResourceUsingContextClassLoader(String name, Class<?> clazz)`
`static byte[]`	`getRESTQuery(String serviceUrl, String urlString, String mediaType)`
`static List<String>`	`getRESTQueryAsLines(String s, String u, String mediaType)`
`static String`	`getSuffix(String filename)` gets suffix from filename
`static File`	`getTEMP_DIRECTORY()` get temporary directory - mainly for testing methods with outputs.
`static File`	`getTestOutputDirectory(Class<?> classx)` get class-specific temporary directory - mainly for testing methods with ouputs.
`static int`	`indexOf(String string, String[] strings, boolean ignoreCase)` get the index of a String in an array
`static int`	`indexOfBalancedBracket(char lbrack, String s)` return index of balanced bracket.
`static Hashtable<Object,Object>`	`invert(Hashtable<Object,Object> table)` invert a Hashtable by interchanging keys and values.
`static boolean`	`isEqual(double[] a, double[] b, double eps)` compare two arrays of doubles.
`static boolean`	`isEqual(int[] a, int[] b, int eps)` compare two arrays of ints.
`static boolean`	`isFloat(String s)` parse string as float.
`static boolean`	`isFloatArray(String s, String delimiterRegex)` parse string as realArray.
`static boolean`	`isInt(String s)` parse string as integer.
`static boolean`	`isIntArray(String s, String delimiterRegex)` parse string as integerArray.
`static String`	`leftTrim(String s)` remove leading blanks
`static void`	`message(String s)` message - nothing fancy at present
`static String`	`normaliseWhitespace(String s)` normalise whitespace in a String (all whitespace is transformed to single spaces and the string is NOT trimmed
`static String`	`outputFloat(int nPlaces, int nDec, double value)` format for example f8.3 this is a mess; if cannot fit, then either right-truncates or when that doesn't work, returns ****
`static String`	`outputNumber(int nPlaces, int nDec, double c)` as above, but trims trailing zeros
`static double`	`parseFlexibleDouble(String value)` Parses double, taking account of lexical forms of special cases allowed by the XSD spec: INF, -INF and NaN.
`static void`	`print(String s)` outputs to sysout.
`static void`	`println()` outputs to sysout.
`static void`	`println(String s)` outputs to sysout.
`static String`	`quoteConcatenate(String[] s)` concatenate strings into quote-separated string
`static byte[]`	`readByteArray(DataInputStream d)` reads a byte array from DataInputStream, including line feeds
`static byte[]`	`readByteArray(String filename)` reads a byte array from file, including line feeds
`static String[]`	`removeElementFromStringArray(String[] array, String s)` convenience method to remove element from array of Strings.
`static String`	`removeHTML(String s)` remove balanced (well-formed) markup from a string.
`static String`	`replaceISOControlsByMnemonic(String s)` remove all control (non-printing) characters
`static String`	`replaceNumericEntityByGreekMnemonics(String s, String ent)`
`static String`	`replaceNumericEntityByISOLatinString(String s, String ent)`
`static String`	`replaceTabs(String s, int width)` replace tabs with spaces while trying to preserve the formatting
`static String`	`rightTrim(String s)` remove trailing blanks
`static void`	`sortByEmbeddedInteger(List<?> list)` sorts a list of string on integers within them.
`static String`	`spaces(int nspace)` make a String of a given number of spaces
`static double[]`	`splitToDoubleArray(String s)` splits string into doubles.
`static double[]`	`splitToDoubleArray(String s, String delim)` splits string into doubles.
`static int[]`	`splitToIntArray(String s, String delim)` splits string into ints.
`static String`	`stripISOControls(String s)` remove all control (non-printing) characters
`static byte[]`	`stripNewlines(byte[] b)` strip linefeeds from a byte array
`static String`	`substituteDOSbyAscii(String s)` substitute certain DOS-compatible diacriticals by the Unicode value.
`static String`	`substituteEquals(String s)` substitute hex representation of character, for example =2E by char(46).
`static String`	`substituteNonASCIIChars(String s, char replacement)`
`static String`	`substituteSmartCharacters(String s)`
`static String`	`substituteString(String s, String oldSubstring, String newSubstring, int count)` make substitutions in a string.
`static String`	`substituteStrings(String s, String[] oldSubstrings, String[] newSubstrings)` make substitutions in a string.
`static void`	`throwNYI()` Deprecated.
`static String`	`toCamelCase(String s)` Description of the Method
`static String`	`translateToMnemonic(char ch)` translate non-printing character to ISO mnemonic.
`static String`	`trim(double d)` trim trailing zeroes and trailing decimal point.
`static double`	`trimFloat(double dd, int ndec)` rounds to decimal place.
`static String`	`truncateAndAddEllipsis(String s, int maxlength)` return the first n characters of a string and add ellipses if truncated
`static String`	`truncateAndAddNewlinesAndEllipsis(String s, int maxlength)` return the first n characters of a string and add ellipses if truncated
`static void`	`warning(String s)` Warning message - nothing fancy at present

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOWER_ROMAN_NUMERAL
```
public static final String[] LOWER_ROMAN_NUMERAL
```
  - LOWER_ROMAN_REGEX
```
public static final String LOWER_ROMAN_REGEX
```
    regex matching roman numbers up to m ("[ivxlcdm]+").
    
    See Also:
    
    Constant Field Values
  - UPPER_ROMAN_REGEX
```
public static final String UPPER_ROMAN_REGEX
```
    regex matching roman numbers up to M ("[IVXLCDM]+").
    
    See Also:
    
    Constant Field Values
  - ISOLATIN_ENTITIES
```
public static final String[] ISOLATIN_ENTITIES
```
    isolatin entities
  - ISOLATIN_LO
```
public static final int ISOLATIN_LO
```
    See Also:
    
    Constant Field Values
  - ISOLATIN_HI
```
public static final int ISOLATIN_HI
```
    See Also:
    
    Constant Field Values
  - GREEK_ENTITIES
```
public static final String[] GREEK_ENTITIES
```
    greek entities
  - UPPER_GREEK_ENTITIES
```
public static final String[] UPPER_GREEK_ENTITIES
```
    UPPER_GREEK entities
  - GREEK2CHARACTER_MAP
```
public static final Map<String,Character> GREEK2CHARACTER_MAP
```
  - DATE_REGEX1
```
public static final String DATE_REGEX1
```
    date of form 21-jan-1965.
    
    See Also:
    
    Constant Field Values
  - DATE_REGEX2
```
public static final String DATE_REGEX2
```
    date of form 1965-01-25.
    
    See Also:
    
    Constant Field Values
  - months
```
public static final String[] months
```
    month data .
- Constructor Detail
  - Util
```
public Util()
```
- Method Detail
  - getTEMP_DIRECTORY
```
public static File getTEMP_DIRECTORY()
```
    get temporary directory - mainly for testing methods with outputs. calls mkdirs() if does not exist
    
    Returns:
    
    temporary directory.
  - getTestOutputDirectory
```
public static File getTestOutputDirectory(Class<?> classx)
```
    get class-specific temporary directory - mainly for testing methods with ouputs. calls mkdirs() if does not exist
    
    Parameters:
    
    classx -
    
    Returns:
    
    temporary directory.
  - addElementToStringArray
```
public static final String[] addElementToStringArray(String[] array,
                                                     String s)
```
    convenience method to extend array of Strings.
    
    Parameters:
    
    array - to extend
    
    s - element to add
    
    Returns:
    
    extended array
  - removeElementFromStringArray
```
public static final String[] removeElementFromStringArray(String[] array,
                                                          String s)
```
    convenience method to remove element from array of Strings. Removes ALL occurrences of string
    
    Parameters:
    
    array - to edit
    
    s - element to remove
    
    Returns:
    
    depleted array
  - BUG
```
public static void BUG(String msg,
                       Exception e)
```
    traps a bug. use for programming errors where this could can "never be reached" concatenates msg with "BUG" and throws RuntimeException
    
    Parameters:
    
    msg -
    
    e -
  - BUG
```
public static void BUG(Exception e)
```
    traps a bug. empty message.
    
    Parameters:
    
    e -
    
    See Also:
    
    BUG(String, Throwable)
  - throwNYI
```
public static void throwNYI()
```
    Deprecated.
    
    convenience method for "not yet implemented". deliberately deprecated so that it requires deprecated on all modules containing NYI
    
    Throws:
    
    RuntimeException
  - BUG
```
public static void BUG(String msg)
```
    traps a bug.
    
    Parameters:
    
    msg -
    
    See Also:
    
    BUG(String, Throwable)
  - getInputStreamFromResource
```
public static InputStream getInputStreamFromResource(String filename)
                                              throws IOException
```
    convenience method to get input stream from resource. the resource is packaged with the classes for distribution. typical filename is org/xmlcml/molutil/elementdata.xml for file elementdata.xml in class hierarchy org.xmlcml.molutil
    
    Parameters:
    
    filename - relative to current class hierarchy.
    
    Returns:
    
    input stream
    
    Throws:
    
    IOException
  - createFile
```
public static void createFile(File dir,
                              String filename)
                       throws IOException
```
    creates directories and files if they don't exist. creates dir/filename
    
    Parameters:
    
    dir -
    
    filename -
    
    Throws:
    
    IOException
  - getResource
```
public static URL getResource(String filename)
```
    creates resource from filename. uses ClassLoader.getResource()
    
    Parameters:
    
    filename - name relative to classroot
    
    Returns:
    
    url or null
  - getResourceUsingContextClassLoader
```
public static InputStream getResourceUsingContextClassLoader(String name,
                                                             Class<?> clazz)
                                                      throws FileNotFoundException
```
    Throws:
    
    FileNotFoundException
  - getResourceFile
```
public static File getResourceFile(String... path)
                            throws URISyntaxException
```
    gets file from build path components. pm286 is not quite sure how it does this...
    
    Parameters:
    
    path -
    
    Returns:
    
    file or null
    
    Throws:
    
    URISyntaxException
  - buildPath
```
public static String buildPath(String... parts)
```
    gets build path from its components.
    
    Parameters:
    
    parts -
    
    Returns:
    
    build path concatenated with File.separatorChar
  - deleteFile
```
public static boolean deleteFile(File file,
                                 boolean deleteDirectory)
```
    delete a file If directory==true then file will be recursively deleted
    
    Parameters:
    
    file - Description of the Parameter
    
    deleteDirectory - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
  - copyFile
```
public static void copyFile(File inFile,
                            File outFile)
                     throws FileNotFoundException,
                            IOException
```
    copy one file to another (I suspect there is a better way
    
    Parameters:
    
    inFile - Description of the Parameter
    
    outFile - Description of the Parameter
    
    Throws:
    
    FileNotFoundException - Description of the Exception
    
    IOException - Description of the Exception
  - dump
```
public static String dump(URL url)
                   throws Exception
```
    reads a stream from url and outputs it as integer values of the characters and as strings. Emulates UNIX od().
    
    Parameters:
    
    url - Description of the Parameter
    
    Returns:
    
    String tabular version of input (in 10-column chunks)
    
    Throws:
    
    Exception - Description of the Exception
  - spaces
```
public static String spaces(int nspace)
```
    make a String of a given number of spaces
    
    Parameters:
    
    nspace - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
  - getSuffix
```
public static String getSuffix(String filename)
```
    gets suffix from filename
    
    Parameters:
    
    filename - Description of the Parameter
    
    Returns:
    
    The suffix value
  - truncateAndAddEllipsis
```
public static String truncateAndAddEllipsis(String s,
                                            int maxlength)
```
    return the first n characters of a string and add ellipses if truncated
    
    Parameters:
    
    s -
    
    maxlength -
    
    Returns:
    
    String the (possibly) truncated string
  - truncateAndAddNewlinesAndEllipsis
```
public static String truncateAndAddNewlinesAndEllipsis(String s,
                                                       int maxlength)
```
    return the first n characters of a string and add ellipses if truncated
    
    Parameters:
    
    s -
    
    maxlength -
    
    Returns:
    
    String the (possibly) truncated string
  - deQuote
```
public static String deQuote(String s)
```
    remove balanced quotes from ends of (trimmed) string, else no action
    
    Parameters:
    
    s - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
  - rightTrim
```
public static String rightTrim(String s)
```
    remove trailing blanks
    
    Parameters:
    
    s - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
  - leftTrim
```
public static String leftTrim(String s)
```
    remove leading blanks
    
    Parameters:
    
    s - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
  - indexOfBalancedBracket
```
public static int indexOfBalancedBracket(char lbrack,
                                         String s)
```
    return index of balanced bracket. String MUST start with a generic LH bracket (e.g. '{', '<', '(' '[')
    
    Parameters:
    
    lbrack - starting character
    
    s - string to search
    
    Returns:
    
    index of bracket or -1 if none
  - getCommaSeparatedStrings
```
public static List<String> getCommaSeparatedStrings(String s)
                                             throws RuntimeException
```
    parse comma-separated Strings Note fields can be EC.S_EMPTY (as in ,,,) and fields can be quoted "...". If so, embedded quotes are represented as EC.S_EMPTY, for example A," this is a EC.S_EMPTYBS_EMPTY character",C. An unbalanced quote returns a mess
    
    Parameters:
    
    s - Description of the Parameter
    
    Returns:
    
    List the vector of Strings - any error returns null
    
    Throws:
    
    RuntimeException - missing quote
  - createCommaSeparatedStrings
```
public static String createCommaSeparatedStrings(List<String> v)
```
    create comma-separated Strings fields include a comma or a " they are wrapped with quotes ("). Note fields can be EC.S_EMPTY (as in ,,,) and fields can be quoted "...". If so, embedded quotes are represented as EC.S_EMPTY, for example A," this is a EC.S_EMPTYBS_EMPTY character",C.
    
    Parameters:
    
    v - vector of strings to be concatenated (null returns null)
    
    Returns:
    
    String the concatenated string - any error returns null
  - quoteConcatenate
```
public static String quoteConcatenate(String[] s)
```
    concatenate strings into quote-separated string
    
    Parameters:
    
    s - Description of the Parameter
    
    Returns:
    
    String concatenated string
  - indexOf
```
public static int indexOf(String string,
                          String[] strings,
                          boolean ignoreCase)
```
    get the index of a String in an array
    
    Parameters:
    
    string - Description of the Parameter
    
    strings - Description of the Parameter
    
    ignoreCase - ignore case
    
    Returns:
    
    index of string else -1 if not found
  - removeHTML
```
public static String removeHTML(String s)
```
    remove balanced (well-formed) markup from a string. Crude (that is not fully XML-compliant); Example: "This is <A HREF="foo">bar</A> and </BR> a break" goes to "This is bar and a break"
    
    Parameters:
    
    s - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
  - warning
```
public static void warning(String s)
```
    Warning message - nothing fancy at present
    
    Parameters:
    
    s - Description of the Parameter
  - message
```
public static void message(String s)
```
    message - nothing fancy at present
    
    Parameters:
    
    s - Description of the Parameter
  - error
```
public static void error(String s)
```
    Error message - nothing fancy at present. Display in Text frame
    
    Parameters:
    
    s - Description of the Parameter
  - BUG
```
public static void BUG(String msg,
                       Throwable t)
```
    traps a bug. use for programming errors where this could can "never be reached" concatenates msg with "BUG" and throws RuntimeException
    
    Parameters:
    
    msg -
    
    t -
  - BUG
```
public static void BUG(Throwable t)
```
    traps a bug. empty message.
    
    Parameters:
    
    t -
    
    See Also:
    
    BUG(String, Throwable)
  - getPWDName
```
public static String getPWDName()
```
    get current directory
    
    Returns:
    
    The pWDName value
  - createNewFile
```
public static File createNewFile(String fileName)
                          throws IOException
```
    create new file, including making directory if required This seems to be a mess - f.createNewFile() doesn't seem to work A directory should have a trailing file.separator
    
    Parameters:
    
    fileName -
    
    Returns:
    
    file
    
    Throws:
    
    IOException
  - substituteString
```
public static String substituteString(String s,
                                      String oldSubstring,
                                      String newSubstring,
                                      int count)
```
    make substitutions in a string. If oldSubtrings = "A" and newSubstrings = "aa" then count occurrences of "A" in s are replaced with "aa", etc. "AAA" count=2 would be replaced by "aaaaA"
    
    Parameters:
    
    s -
    
    oldSubstring -
    
    newSubstring -
    
    count -
    
    Returns:
    
    new string
  - substituteStrings
```
public static String substituteStrings(String s,
                                       String[] oldSubstrings,
                                       String[] newSubstrings)
```
    make substitutions in a string. If oldSubtrings = {"A", "BB", "C"} and newSubstrings = {"aa", "b", "zz"} then every occurrence of "A" in s is replaced with "aa", etc. "BBB" would be replaced by "bB"
    
    Parameters:
    
    s -
    
    oldSubstrings -
    
    newSubstrings -
    
    Returns:
    
    Description of the Return Value
    
    Throws:
    
    RuntimeException
  - replaceNumericEntityByISOLatinString
```
public static String replaceNumericEntityByISOLatinString(String s,
                                                          String ent)
```
    Parameters:
    
    s - string to be edited
    
    ent - leading entity
    
    Returns:
    
    edited string
  - replaceISOControlsByMnemonic
```
public static String replaceISOControlsByMnemonic(String s)
```
    remove all control (non-printing) characters
    
    Parameters:
    
    s - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
  - translateToMnemonic
```
public static String translateToMnemonic(char ch)
```
    translate non-printing character to ISO mnemonic. e.g. 1 => SOH
    
    Parameters:
    
    ch - [0 - 31] or 127
    
    Returns:
    
    translation or empty string if out of range
  - convertUTF8ToLatin1
```
public static char convertUTF8ToLatin1(char a,
                                       char b)
```
    convert 2 UTF8 characters to single IsoLatin1 character. quick and dirty UTF8 C2 80 => 80 (etc) UTF8 C3 80 => C0 (i.e. add x40) user has responsibility for selecting characters
    
    Parameters:
    
    a - leading character (ignored if not C2 and not C3)
    
    b - range 80-bf
    
    Returns:
    
    Isolatin equiv or 0 if a,b ignored or bad range
  - convertLatin1ToUTF8
```
public static char[] convertLatin1ToUTF8(char a)
```
    convert single IsoLatin1 character to 2 UTF8 characters . quick and dirty user has responsibility for selecting characters a >= x80 AND a <= xBF ==> xC2 a a >= xC0 AND a <= xFF ==> xC3 a - x40
    
    Parameters:
    
    a - char to be converted (a >= x80 AND a <xff)
    
    Returns:
    
    2 characters or null
  - replaceNumericEntityByGreekMnemonics
```
public static String replaceNumericEntityByGreekMnemonics(String s,
                                                          String ent)
```
    Parameters:
    
    s - string to be edited
    
    ent - leading entity
    
    Returns:
    
    edited string
  - substituteDOSbyAscii
```
public static String substituteDOSbyAscii(String s)
```
    substitute certain DOS-compatible diacriticals by the Unicode value. Not guaranteed to be correct. Example 130 is e-acute (==
    
    Parameters:
    
    s - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
  - substituteNonASCIIChars
```
public static String substituteNonASCIIChars(String s,
                                             char replacement)
```
  - substituteSmartCharacters
```
public static String substituteSmartCharacters(String s)
```
  - replaceTabs
```
public static String replaceTabs(String s,
                                 int width)
```
    replace tabs with spaces while trying to preserve the formatting
    
    Parameters:
    
    s -
    
    width -
    
    Returns:
  - substituteEquals
```
public static String substituteEquals(String s)
```
    substitute hex representation of character, for example =2E by char(46). If line ends with =, ignore that character.
    
    Parameters:
    
    s - Description of the Parameter
    
    Returns:
    
    String result
  - getIntFromHex
```
public static int getIntFromHex(String hex)
```
    Translates a Hex number to its int equivalent. Thus "FE" translates to 254. Horrid, but I couldn't find if Java reads hex. All results are >= 0. Errors return -1
    
    Parameters:
    
    hex - Description of the Parameter
    
    Returns:
    
    The intFromHex value
  - capitalise
```
public static String capitalise(String s)
```
    capitalise a String (whatever the starting case)
    
    Parameters:
    
    s - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
  - toCamelCase
```
public static String toCamelCase(String s)
```
    Description of the Method
    
    Parameters:
    
    s - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
  - readByteArray
```
public static byte[] readByteArray(String filename)
                            throws FileNotFoundException,
                                   IOException
```
    reads a byte array from file, *including* line feeds
    
    Parameters:
    
    filename - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
    
    Throws:
    
    FileNotFoundException - Description of the Exception
    
    IOException - Description of the Exception
  - readByteArray
```
public static byte[] readByteArray(DataInputStream d)
                            throws IOException
```
    reads a byte array from DataInputStream, *including* line feeds
    
    Parameters:
    
    d - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
    
    Throws:
    
    IOException - Description of the Exception
  - stripISOControls
```
public static String stripISOControls(String s)
```
    remove all control (non-printing) characters
    
    Parameters:
    
    s - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
  - normaliseWhitespace
```
public static String normaliseWhitespace(String s)
```
    normalise whitespace in a String (all whitespace is transformed to single spaces and the string is NOT trimmed
    
    Parameters:
    
    s - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
  - stripNewlines
```
public static byte[] stripNewlines(byte[] b)
```
    strip linefeeds from a byte array
    
    Parameters:
    
    b - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
  - getFileOutputStream
```
public static FileOutputStream getFileOutputStream(String fileName)
                                            throws FileNotFoundException
```
    get an OutputStream from a file or URL. Required (I think) because strings of the sort "file:/C:\foo\bat.txt" crash FileOutputStream, so this strips off the file:/ stuff for Windows-like stuff
    
    Parameters:
    
    fileName - Description of the Parameter
    
    Returns:
    
    FileOutputStream a new (opened) FileOutputStream
    
    Throws:
    
    FileNotFoundException - Description of the Exception
  - outputFloat
```
public static String outputFloat(int nPlaces,
                                 int nDec,
                                 double value)
                          throws EuclidRuntimeException
```
    format for example f8.3 this is a mess; if cannot fit, then either right-truncates or when that doesn't work, returns ****
    
    Parameters:
    
    nPlaces - Description of the Parameter
    
    nDec - Description of the Parameter
    
    value - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
    
    Throws:
    
    EuclidRuntimeException - Description of the Exception
  - outputNumber
```
public static String outputNumber(int nPlaces,
                                  int nDec,
                                  double c)
```
    as above, but trims trailing zeros
    
    Parameters:
    
    nPlaces - Description of the Parameter
    
    nDec - Description of the Parameter
    
    c - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
  - invert
```
public static Hashtable<Object,Object> invert(Hashtable<Object,Object> table)
```
    invert a Hashtable by interchanging keys and values. This assumes a 1;1 mapping - if not the result is probably garbage.
    
    Parameters:
    
    table - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
  - check
```
public static void check(double[] array,
                         int size)
                  throws EuclidRuntimeException
```
    checks array is not null and is of given size.
    
    Parameters:
    
    array - to check
    
    size - required size
    
    Throws:
    
    EuclidRuntimeException - if null or wrong size
  - check
```
public static void check(int n,
                         int low,
                         int high)
                  throws EuclidRuntimeException
```
    checks that an in is in the range low to high.
    
    Parameters:
    
    n - to check
    
    low - inclusive lower
    
    high - inclusive higher
    
    Throws:
    
    EuclidRuntimeException - if out of range
  - isEqual
```
public static boolean isEqual(double[] a,
                              double[] b,
                              double eps)
```
    compare two arrays of doubles.
    
    Parameters:
    
    a - first array
    
    b - second array
    
    eps - maximum allowed difference
    
    Returns:
    
    true if arrays non-null and if arrays are equal length and corresonding elements agree within eps.
  - isEqual
```
public static boolean isEqual(int[] a,
                              int[] b,
                              int eps)
```
    compare two arrays of ints.
    
    Parameters:
    
    a - first array
    
    b - second array
    
    eps - maximum allowed difference
    
    Returns:
    
    true if arrays non-null and if arrays are equal length and corresonding elements agree within eps.
  - concatenate
```
public static final String concatenate(boolean[] bb,
                                       String separator)
```
    concatenates array of booleans.
    
    Parameters:
    
    bb - the values
    
    separator -
    
    Returns:
    
    the String
  - concatenate
```
public static final String concatenate(double[] ss,
                                       String separator)
```
    concatenates array of doubles.
    
    Parameters:
    
    ss - the values
    
    separator -
    
    Returns:
    
    the String
  - concatenate
```
public static final String concatenate(double[][] ss,
                                       String separator)
```
    concatenates array of array of doubles.
    
    Parameters:
    
    ss - the values
    
    separator -
    
    Returns:
    
    the String
  - splitToIntArray
```
public static final int[] splitToIntArray(String s,
                                          String delim)
                                   throws EuclidRuntimeException
```
    splits string into ints.
    
    Parameters:
    
    s - the string
    
    delim -
    
    Returns:
    
    array
    
    Throws:
    
    EuclidRuntimeException - cannot parse as ints
  - splitToDoubleArray
```
public static final double[] splitToDoubleArray(String s)
```
    splits string into doubles. assumes single space delimiters
    
    Parameters:
    
    s - the string
    
    Returns:
    
    array
    
    Throws:
    
    EuclidRuntimeException - cannot parse as ints
  - parseFlexibleDouble
```
public static double parseFlexibleDouble(String value)
                                  throws ParseException
```
    Parses double, taking account of lexical forms of special cases allowed by the XSD spec: INF, -INF and NaN.
    
    Parameters:
    
    value -
    
    Returns:
    
    Throws:
    
    ParseException
  - splitToDoubleArray
```
public static final double[] splitToDoubleArray(String s,
                                                String delim)
                                         throws EuclidRuntimeException
```
    splits string into doubles.
    
    Parameters:
    
    s - the string
    
    delim -
    
    Returns:
    
    array
    
    Throws:
    
    EuclidRuntimeException - cannot parse as ints
  - concatenate
```
public static final String concatenate(int[] ss,
                                       String separator)
```
    concatenates array of ints.
    
    Parameters:
    
    ss - the values
    
    separator -
    
    Returns:
    
    the String
  - concatenate
```
public static final String concatenate(String[] ss,
                                       String separator)
```
    concatenates array of Strings.
    
    Parameters:
    
    ss - the values
    
    separator -
    
    Returns:
    
    the String
  - containsString
```
public static final boolean containsString(String[] strings,
                                           String s)
```
    does an array of Strings contain a String.
    
    Parameters:
    
    strings -
    
    s - string to search for
    
    Returns:
    
    true if any ss[i] == s
  - format
```
public static double format(double d,
                            int ndec)
```
    format trailing decimals
    
    Parameters:
    
    d - value to be formatted
    
    ndec - max number of decimals (3 = ****.ddd)
    
    Returns:
    
    the formatted number
  - trim
```
public static String trim(double d)
```
    trim trailing zeroes and trailing decimal point.
    
    Parameters:
    
    d -
    
    Returns:
    
    trimmed string
  - createList
```
public static List<String> createList(String[] ss)
```
    translate array of Strings to a List.
    
    Parameters:
    
    ss - strings (can include null)
    
    Returns:
    
    the list
  - getPrime
```
public static int getPrime(int i)
```
    get i'th prime. calculates it on demand if not already present and caches result.
    
    Parameters:
    
    i -
    
    Returns:
    
    the primt (starts at 2)
  - isInt
```
public static boolean isInt(String s)
```
    parse string as integer.
    
    Parameters:
    
    s -
    
    Returns:
    
    true if can be parsed.
  - isIntArray
```
public static boolean isIntArray(String s,
                                 String delimiterRegex)
```
    parse string as integerArray.
    
    Parameters:
    
    s -
    
    delimiterRegex -
    
    Returns:
    
    true if can be parsed.
  - isFloatArray
```
public static boolean isFloatArray(String s,
                                   String delimiterRegex)
```
    parse string as realArray.
    
    Parameters:
    
    s -
    
    delimiterRegex -
    
    Returns:
    
    true if can be parsed.
  - isFloat
```
public static boolean isFloat(String s)
```
    parse string as float.
    
    Parameters:
    
    s -
    
    Returns:
    
    true if can be parsed.
  - getCanonicalDate
```
public static String getCanonicalDate(String s)
```
    parse string as date. tries several formats (case insensitive) can be used to test whether string is parsable as date
    
    Parameters:
    
    s -
    
    Returns:
    
    ISO 8601 format if can be parsed or null
  - getDouble
```
public static double getDouble(String s)
```
  - trimFloat
```
public static double trimFloat(double dd,
                               int ndec)
```
    rounds to decimal place.
    
    Parameters:
    
    dd - number to be rounded
    
    ndec - number of places
    
    Returns:
    
    float
  - sortByEmbeddedInteger
```
public static void sortByEmbeddedInteger(List<?> list)
```
    sorts a list of string on integers within them. normal lexical sort will often produce file1, file10, file11, file2, etc. this will order them by integers int their
    
    Parameters:
    
    list -
  - print
```
public static void print(String s)
```
    outputs to sysout. primarily to allow trapping and tracing of sysout calls which we try to avoid anyway
    
    Parameters:
    
    s -
  - println
```
public static void println(String s)
```
    outputs to sysout. primarily to allow trapping and tracing of sysout calls which we try to avoid anyway
    
    Parameters:
    
    s -
  - println
```
public static void println()
```
    outputs to sysout. primarily to allow trapping and tracing of sysout calls which we try to avoid anyway
  - getRESTQueryAsLines
```
public static List<String> getRESTQueryAsLines(String s,
                                               String u,
                                               String mediaType)
                                        throws IOException
```
    Throws:
    
    IOException
  - getRESTQuery
```
public static byte[] getRESTQuery(String serviceUrl,
                                  String urlString,
                                  String mediaType)
                           throws IOException
```
    Throws:
    
    IOException
  - calculateMD5
```
public static String calculateMD5(String s)
```
    borrowed from somewhere.
    
    Parameters:
    
    s -
    
    Returns:
  - getCanonicalPath
```
public static String getCanonicalPath(File file)
```
    avoids the checked exception
    
    Parameters:
    
    file -
    
    Returns:
  - getRelativeFilename
```
public static String getRelativeFilename(File file1,
                                         File file2,
                                         String newSeparator)
```
    path to create file2 from file1
    
    Parameters:
    
    file1 -
    
    file2 -
    
    newSeparator - if not null, use as new separator
  - getRelativePath
```
public static String getRelativePath(String targetPath,
                                     String basePath,
                                     String pathSeparator)
```
    Get the relative path from one file to another, specifying the directory separator. If one of the provided resources does not exist, it is assumed to be a file unless it ends with '/' or '\'. from Stackoverflow: http://stackoverflow.com/questions/204784/how-to-construct-a-relative-path-in-java-from-two-absolute-paths-or-urls
    
    Parameters:
    
    targetPath - targetPath is calculated to this file
    
    basePath - basePath is calculated from this file
    
    pathSeparator - directory separator. The platform default is not assumed so that we can test Unix behaviour when running on Windows (for example)
    
    Returns:
  - checkPMR
```
public static boolean checkPMR()
```
    checks that this is local to PMR. Stops certain tests being run outside PMR implementation, especially ones which use directories outside the maven project uses System.user.name
    
    Returns:

Class Util

Nested Class Summary

Field Summary

Fields inherited from interface org.xmlcml.euclid.EuclidConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOWER_ROMAN_NUMERAL

LOWER_ROMAN_REGEX

UPPER_ROMAN_REGEX

ISOLATIN_ENTITIES

ISOLATIN_LO

ISOLATIN_HI

GREEK_ENTITIES

UPPER_GREEK_ENTITIES

GREEK2CHARACTER_MAP

DATE_REGEX1

DATE_REGEX2

months

Constructor Detail

Util

Method Detail

getTEMP_DIRECTORY

getTestOutputDirectory

addElementToStringArray

removeElementFromStringArray

BUG

BUG

throwNYI

BUG

getInputStreamFromResource

createFile

getResource

getResourceUsingContextClassLoader

getResourceFile

buildPath

deleteFile

copyFile

dump

spaces

getSuffix

truncateAndAddEllipsis

truncateAndAddNewlinesAndEllipsis

deQuote

rightTrim

leftTrim

indexOfBalancedBracket

getCommaSeparatedStrings

createCommaSeparatedStrings

quoteConcatenate

indexOf

removeHTML

warning

message

error

BUG

BUG

getPWDName

createNewFile

substituteString

substituteStrings

replaceNumericEntityByISOLatinString

replaceISOControlsByMnemonic

translateToMnemonic

convertUTF8ToLatin1

convertLatin1ToUTF8

replaceNumericEntityByGreekMnemonics

substituteDOSbyAscii

substituteNonASCIIChars

substituteSmartCharacters

replaceTabs

substituteEquals

getIntFromHex

capitalise

toCamelCase

readByteArray

readByteArray

stripISOControls

normaliseWhitespace