Util (bw-util-misc 4.0.19 API)

java.lang.Object
- org.bedework.util.misc.Util

```
public class Util
extends Object
```
Version:

1.0 A number of bitty utility routines.

Author:

Mike Douglass

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Util.AdjustCollectionResult<T>` Show changes for adjustCollection
`static class`	`Util.PropertiesPropertyFetcher`
`static interface`	`Util.PropertyFetcher`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> Util.AdjustCollectionResult<T>`	`adjustCollection(Collection<T> newCol, Collection<T> toAdjust)` Used to adjust a collection toAdjust so that it looks like the collection newCol.
`static String[]`	`appendTextToArray(String[] sarray, String val, int maxEntries)` Add a string to a string array of a given maximum length.
`static String`	`buildPath(boolean endWithSep, String... val)` Build a path out of the given elements.
`static String`	`checkNull(String val)` We get a lot of zero length (or all white space) strings in the web world.
`static int`	`cmpBoolval(boolean thisone, boolean thatone)` Compare two boolean objects
`static int`	`cmpIntval(int thisone, int thatone)` Compare two int objects
`static int`	`cmpObjval(Collection<? extends Comparable> thisone, Collection<? extends Comparable> thatone)` Compare two possibly null objects
`static int`	`cmpObjval(Comparable thisone, Comparable thatone)` Compare two possibly null objects
`static int`	`compare(char[] thisone, char[] thatone)` Compare two char arrays
`static int`	`compareStrings(String s1, String s2)` Compare two strings.
`static String[]`	`decodeArray(String val)` Return a StringArray resulting from decoding the given String which should have been encoded by encodeArray
`static String`	`encodeArray(String[] val)` Return a String representing the given String array, achieved by URLEncoding the individual String elements then concatenating with intervening blanks.
`static boolean`	`equalsString(String thisStr, String thatStr)` Return true if Strings are equal including possible null
`static String`	`fmtMsg(String fmt, int arg)` Format a message consisting of a format string plus one integer parameter
`static String`	`fmtMsg(String fmt, String arg)` Format a message consisting of a format string
`static String`	`fmtMsg(String fmt, String arg1, String arg2)` Format a message consisting of a format string plus two string parameters
`static List<String>`	`getList(String val, boolean emptyOk)` Turn a comma separated list into a List.
`static Object`	`getObject(String className, Class cl)` Given a class name return an object of that class.
`static Properties`	`getPropertiesFromResource(String name)` Load a named resource as a Properties object
`static String`	`icalUTCTimestamp()` Get an ical timestamp of the form "yyyyMMddTHHmmssZ"
`static boolean`	`isEmpty(Collection val)` Return true for null or empty
`static Locale`	`makeLocale(String val)` make a locale from the standard underscore separated parts - no idea why this isn't in Locale
`static String`	`makeRandomString(int length, int maxVal)` Creates a string of given length where each character comes from a set of values 0-9 followed by A-Z.
`static String`	`pathElement(int index, String path)` get the nth element from the path - first is 0.
`static boolean`	`present(String val)` We get a lot of zero length strings in the web world.
`static String`	`propertyReplace(String val, Util.PropertyFetcher props)`
`static String[]`	`splitName(String href)` if an href with terminating "/" the name part is that between the ending "/" and the one before.
`static URI`	`validURI(String val)` Test for a valid URI and return the URI object.

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

- Method Detail
  - icalUTCTimestamp
```
public static String icalUTCTimestamp()
```
    Get an ical timestamp of the form "yyyyMMddTHHmmssZ"
    
    Returns:
    
    String "yyyyMMddTHHmmssZ"
  - adjustCollection
```
public static <T> Util.AdjustCollectionResult<T> adjustCollection(Collection<T> newCol,
                                                                  Collection<T> toAdjust)
```
    Used to adjust a collection toAdjust so that it looks like the collection newCol. The collection newCol will be unchanged but the result object will contain a list of added and removed values.
    
    Parameters:
    
    newCol - make it look like this
    
    toAdjust - if non-null will be adjusted
    
    Returns:
    
    added and removed values
  - buildPath
```
public static String buildPath(boolean endWithSep,
                               String... val)
```
    Build a path out of the given elements. Any parameter may be a path element or a path separator. Note this only allows "/" as the separator.
    The path is constrained to either end or not end with the path separator. The path will be adjusted according to the constraint
    
    Parameters:
    
    endWithSep -
    
    val - - list of elements and path separators.
    
    Returns:
    
    completed path
  - splitName
```
public static String[] splitName(String href)
```
    if an href with terminating "/" the name part is that between the ending "/" and the one before.
    Otherwise it's the part after the last "/"
    
    Parameters:
    
    href - to split
    
    Returns:
    
    name split into path and name part
  - pathElement
```
public static String pathElement(int index,
                                 String path)
```
    get the nth element from the path - first is 0.
    
    Parameters:
    
    index - of element we want
    
    path - from which we extract the element
    
    Returns:
    
    element or null
  - makeLocale
```
public static Locale makeLocale(String val)
                         throws Throwable
```
    make a locale from the standard underscore separated parts - no idea why this isn't in Locale
    
    Parameters:
    
    val - teh locale String e.g. en_US
    
    Returns:
    
    a Locale
    
    Throws:
    
    Throwable
  - getPropertiesFromResource
```
public static Properties getPropertiesFromResource(String name)
                                            throws Throwable
```
    Load a named resource as a Properties object
    
    Parameters:
    
    name - String resource name
    
    Returns:
    
    Properties populated from the resource
    
    Throws:
    
    Throwable
  - getObject
```
public static Object getObject(String className,
                               Class cl)
                        throws Exception
```
    Given a class name return an object of that class. The class parameter is used to check that the named class is an instance of that class.
    
    Parameters:
    
    className - String class name
    
    cl - Class expected
    
    Returns:
    
    Object checked to be an instance of that class
    
    Throws:
    
    Exception
  - propertyReplace
```
public static String propertyReplace(String val,
                                     Util.PropertyFetcher props)
```
  - fmtMsg
```
public static String fmtMsg(String fmt,
                            String arg)
```
    Format a message consisting of a format string
    
    Parameters:
    
    fmt -
    
    arg -
    
    Returns:
    
    String formatted message
  - fmtMsg
```
public static String fmtMsg(String fmt,
                            String arg1,
                            String arg2)
```
    Format a message consisting of a format string plus two string parameters
    
    Parameters:
    
    fmt -
    
    arg1 -
    
    arg2 -
    
    Returns:
    
    String formatted message
  - fmtMsg
```
public static String fmtMsg(String fmt,
                            int arg)
```
    Format a message consisting of a format string plus one integer parameter
    
    Parameters:
    
    fmt -
    
    arg -
    
    Returns:
    
    String formatted message
  - makeRandomString
```
public static String makeRandomString(int length,
                                      int maxVal)
```
    Creates a string of given length where each character comes from a set of values 0-9 followed by A-Z.
    
    Parameters:
    
    length - returned string will be this long. Less than 1k + 1
    
    maxVal - maximum ordinal value of characters. If < than 0, return null. If > 35, 35 is used instead.
    
    Returns:
    
    String the random string
  - appendTextToArray
```
public static String[] appendTextToArray(String[] sarray,
                                         String val,
                                         int maxEntries)
```
    Add a string to a string array of a given maximum length. Truncates the string array if required. New entries go at the end. old get dropped off the front.
    
    Parameters:
    
    sarray - String[] to be updated
    
    val - new entry
    
    maxEntries - Number of entries we keep.
    
    Returns:
    
    String[] Modified sarray
  - encodeArray
```
public static String encodeArray(String[] val)
```
    Return a String representing the given String array, achieved by URLEncoding the individual String elements then concatenating with intervening blanks.
    
    Parameters:
    
    val - String[] value to encode
    
    Returns:
    
    String encoded value
  - decodeArray
```
public static String[] decodeArray(String val)
```
    Return a StringArray resulting from decoding the given String which should have been encoded by encodeArray
    
    Parameters:
    
    val - String value encoded by encodeArray
    
    Returns:
    
    String[] decoded value
  - equalsString
```
public static boolean equalsString(String thisStr,
                                   String thatStr)
```
    Return true if Strings are equal including possible null
    
    Parameters:
    
    thisStr -
    
    thatStr -
    
    Returns:
    
    boolean true for equal
  - compareStrings
```
public static int compareStrings(String s1,
                                 String s2)
```
    Compare two strings. null is less than any non-null string.
    
    Parameters:
    
    s1 - first string.
    
    s2 - second string.
    
    Returns:
    
    int 0 if the s1 is equal to s2; <0 if s1 is lexicographically less than s2; >0 if s1 is lexicographically greater than s2.
  - checkNull
```
public static String checkNull(String val)
```
    We get a lot of zero length (or all white space) strings in the web world. This will return null for a zero length.
    
    Parameters:
    
    val - String request parameter value
    
    Returns:
    
    String null for null or zero lengt val, val otherwise.
  - present
```
public static boolean present(String val)
```
    We get a lot of zero length strings in the web world. This will return false for null or zero-length.
    
    Parameters:
    
    val - String request parameter value
    
    Returns:
    
    boolean true for length > 0
  - getList
```
public static List<String> getList(String val,
                                   boolean emptyOk)
                            throws Throwable
```
    Turn a comma separated list into a List. Throws exception for invalid list.
    
    Parameters:
    
    val - String comma separated list
    
    emptyOk - Empty elements are OK
    
    Returns:
    
    List of elements, never null
    
    Throws:
    
    Throwable - for invalid list
  - cmpObjval
```
public static int cmpObjval(Comparable thisone,
                            Comparable thatone)
```
    Compare two possibly null objects
    
    Parameters:
    
    thisone -
    
    thatone -
    
    Returns:
    
    int -1, 0, 1,
  - cmpObjval
```
public static int cmpObjval(Collection<? extends Comparable> thisone,
                            Collection<? extends Comparable> thatone)
```
    Compare two possibly null objects
    
    Parameters:
    
    thisone -
    
    thatone -
    
    Returns:
    
    int -1, 0, 1,
  - cmpBoolval
```
public static int cmpBoolval(boolean thisone,
                             boolean thatone)
```
    Compare two boolean objects
    
    Parameters:
    
    thisone -
    
    thatone -
    
    Returns:
    
    int -1, 0, 1,
  - cmpIntval
```
public static int cmpIntval(int thisone,
                            int thatone)
```
    Compare two int objects
    
    Parameters:
    
    thisone -
    
    thatone -
    
    Returns:
    
    int -1, 0, 1,
  - compare
```
public static int compare(char[] thisone,
                          char[] thatone)
```
    Compare two char arrays
    
    Parameters:
    
    thisone -
    
    thatone -
    
    Returns:
    
    int -1, 0, 1,
  - isEmpty
```
public static boolean isEmpty(Collection val)
```
    Return true for null or empty
    
    Parameters:
    
    val -
    
    Returns:
    
    boolean
  - validURI
```
public static URI validURI(String val)
```
    Test for a valid URI and return the URI object.
    
    Parameters:
    
    val -
    
    Returns:
    
    null for invalid or a URI object

Class Util

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

icalUTCTimestamp

adjustCollection

buildPath

splitName

pathElement

makeLocale

getPropertiesFromResource

getObject

propertyReplace

fmtMsg

fmtMsg

fmtMsg

makeRandomString

appendTextToArray

encodeArray

decodeArray

equalsString

compareStrings

checkNull

present

getList

cmpObjval

cmpObjval

cmpBoolval

cmpIntval

compare

isEmpty

validURI