CommonUtilities (ecmsdk-api 3.7.0 API)

java.lang.Object
- oracle.ifs.core.util.CommonUtilities

```
public class CommonUtilities
extends Object
```
A set of common utility and convenience methods.

Author:

Luis Saenz

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`arrayContains(Object[] objs, Object objToCheck)` Returns indication as to whether the specified array contains the specified value, using an equals() check.
`static String`	`collapseQuotes(String s)` Collapse embedded/doubled quotes to a single embedded quote.
`static String`	`concatenateStrings(String[] strings, String separator)` Concatenate the specified array of strings into a single string, separated by the specified separator.
`static String[]`	`concatenateStrings(String[] strings, String separator, int maxPerString)` Concatenate the specified array of strings into a set of strings, separated by the specified separator, with each of the produced Strings containing no more than the specified limit value.
`static String`	`convertEmptyToNull(String str)` Convert an empty string to null.
`static int`	`countOccurrences(String string, char charToCount)` Returns the count of occurrences of the specified character within the specified String.
`static int`	`countUnquotedOccurrences(String string, char charToCount, char quoteChar, char escapeChar)` Returns the count of occurrences of the specified character within the specified String, not counting occurrences that occur in a quoted context.
`static String`	`expandQuotes(String s)` Expand embedded quotes to double the quotes.
`static Boolean`	`getBoolean(Map source, String key)` Returns a Boolean value from a Map given a key; throws IFS-90008 if the cast to a Boolean value fails.
`static Date`	`getDate(Map source, String key)` Returns a Date value from a Map given a key; throws IFS-90008 if the cast to a Date value fails.
`static Integer`	`getInteger(Map source, String key)` Returns a Integer value from a Map given a key; throws IFS-90008 if the cast to a Integer value fails.
`static Long`	`getLong(Map source, String key)` Returns a Long value from a Map given a key; throws IFS-90008 if the cast to a Long value fails.
`static long[]`	`getLongArray(Map source, String key)` Returns a long array value from a Map given a key; throws IFS-90008 if the cast to a long array value fails.
`static Map<Long,Double>`	`getLongDoubleMap(Long[] keys, Double[] values)` Construct a Long-Double map from the key and value arrays specified.
`static Map<Long,AttributeValue>`	`getLongLibraryObjectMap(Long[] keys, LibraryObject[] values)` Construct a Long-LibraryObject map from the key and value arrays specified.
`static Map<Long,Long>`	`getLongLongMap(Long[] keys, Long[] values)` Construct a Long-Long map from the key and value arrays specified.
`static Map<Long,String>`	`getLongStringMap(Long[] keys, String[] values)` Construct a Long-String map from the key and value arrays specified.
`static String`	`getString(Map source, String key)` Returns a String value from a Map given a key; throws IFS-90008 if the cast to a String value fails.
`static String[]`	`getStringArray(Map source, String key)` Returns a String array value from a Map given a key; throws IFS-90008 if the cast to a String array value fails.
`static Map<String,Double>`	`getStringDoubleMap(String[] keys, Double[] values)` Construct a String-Double map from the key and value arrays specified.
`static Map<String,AttributeValue>`	`getStringLibraryObjectMap(String[] keys, LibraryObject[] values)` Construct a String-LibraryObject map from the key and value arrays specified.
`static Map<String,Long>`	`getStringLongMap(String[] keys, Long[] values)` Construct a String-Long map from the key and value arrays specified.
`static String[]`	`getStringsFromDelimitedToken(String token)` Get String array from a value of the form "{value1, value2, value3}".
`static String[]`	`getStringsFromDelimitedToken(String token, String delim)` Get String array from a value of the form "{value1 value2 value3}".
`static Map<String,String>`	`getStringStringMap(String[] keys, String[] values)` Construct a String-String map from the key and value arrays specified.
`static String`	`makeString(List<Character> charList)` Make a String from a list of Character.
`static String`	`makeString(List<Character> charList, String defString)` Make a String from a list of Character.
`static void`	`objectArrayReverse(Object[] objArray)` Reverse the elements of the specified object array.
`static String[]`	`splitString(String string, int maxSegLength)` Split a string into segments bounded by the max segment length specified.
`static boolean`	`stringArrayContains(String[] objs, String objToCheck)` Returns indication as to whether the specified String array contains the specified String value, ignoring case.
`static boolean`	`stringArrayContains(String[] objs, String objToCheck, boolean ignoreCase)` Returns indication as to whether the specified String array contains the specified String value, with or without ignoring case.
`static AttributeValue[]`	`toAttributeValueArray(List<AttributeValue> avList)` Convert the specified list of AttributeValue to an AttributeValue array.
`static String`	`toLowerCase(String string)` Returns the lower-cased variant of the specified String.
`static String`	`toLowerCase(String string, String ifNull)` Returns the lower-cased variant of the specified String, or the second String if the specified String is null.
`static String`	`toUpperCase(String string)` Returns the upper-cased variant of the specified String.
`static String`	`toUpperCase(String string, String ifNull)` Returns the upper-cased variant of the specified String, or the second String if the specified String is null.
`static String`	`toZeroPaddedString(int value, int len)` Convert an integer into a zero padded String that is at least as long as the specified length.
`static String`	`zeroPad(String s, int len)` Prepends `s` with "0" characters until the resulting String is of length `len`.

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

- Method Detail
  - arrayContains
```
public static boolean arrayContains(Object[] objs,
                                    Object objToCheck)
```
    Returns indication as to whether the specified array contains the specified value, using an equals() check.
    
    Parameters:
    
    objs - the array to check
    
    objToCheck - the object to check for
    
    Returns:
    
    true if the array contains the object
  - objectArrayReverse
```
public static void objectArrayReverse(Object[] objArray)
```
    Reverse the elements of the specified object array.
    
    Parameters:
    
    objArray - the array to reverse in place
  - stringArrayContains
```
public static boolean stringArrayContains(String[] objs,
                                          String objToCheck)
```
    Returns indication as to whether the specified String array contains the specified String value, ignoring case.
    
    Parameters:
    
    objs - the array to check
    
    objToCheck - the object to check for
    
    Returns:
    
    true if the array contains the object
  - stringArrayContains
```
public static boolean stringArrayContains(String[] objs,
                                          String objToCheck,
                                          boolean ignoreCase)
```
    Returns indication as to whether the specified String array contains the specified String value, with or without ignoring case.
    
    Parameters:
    
    objs - the array to check
    
    objToCheck - the object to check for
    
    ignoreCase - whether to ignore case
    
    Returns:
    
    true if the array contains the object
  - zeroPad
```
public static String zeroPad(String s,
                             int len)
```
    Prepends s with "0" characters until the resulting String is of length len.
    
    Parameters:
    
    s - the string to pad.
    
    len - the desired length of the string.
    
    Returns:
    
    the padded string.
  - toZeroPaddedString
```
public static String toZeroPaddedString(int value,
                                        int len)
```
    Convert an integer into a zero padded String that is at least as long as the specified length.
    Only zero pads for non-negative integer values.
    
    Parameters:
    
    value - the integer value to convert
    
    len - the desired minimum length of the string
    
    Returns:
    
    the zero-padded string.
  - concatenateStrings
```
public static String concatenateStrings(String[] strings,
                                        String separator)
```
    Concatenate the specified array of strings into a single string, separated by the specified separator.
    
    Parameters:
    
    strings - the array of strings
    
    separator - the separator
    
    Returns:
    
    the concatenated string
  - concatenateStrings
```
public static String[] concatenateStrings(String[] strings,
                                          String separator,
                                          int maxPerString)
```
    Concatenate the specified array of strings into a set of strings, separated by the specified separator, with each of the produced Strings containing no more than the specified limit value.
    
    Parameters:
    
    strings - the array of strings
    
    separator - the separator
    
    maxPerString - the maximum number of Strings per each produced String
    
    Returns:
    
    the set of concatenated strings
  - splitString
```
public static String[] splitString(String string,
                                   int maxSegLength)
```
    Split a string into segments bounded by the max segment length specified.
    
    Parameters:
    
    string - the string to split
    
    maxSegLength - the maximum length of a single segment
    
    Returns:
    
    the array of string segments; null if the specified String is null; an empty array if the specified String is an empty String
  - countOccurrences
```
public static int countOccurrences(String string,
                                   char charToCount)
```
    Returns the count of occurrences of the specified character within the specified String.
    
    Parameters:
    
    string - the string
    
    charToCount - the character of interest
    
    Returns:
    
    the count of occurrences
  - countUnquotedOccurrences
```
public static int countUnquotedOccurrences(String string,
                                           char charToCount,
                                           char quoteChar,
                                           char escapeChar)
```
    Returns the count of occurrences of the specified character within the specified String, not counting occurrences that occur in a quoted context.
    For example, the following will return 2: countUnquotedOccurrences("Foo = 'warum?', ?, ?", '?', '\'', '\\')
    
    Parameters:
    
    string - the string
    
    charToCount - the character of interest
    
    quoteChar - the character used for quoted strings
    
    escapeChar - the character used as an escape character
    
    Returns:
    
    the count of occurrences
  - toUpperCase
```
public static String toUpperCase(String string)
```
    Returns the upper-cased variant of the specified String.
    
    Parameters:
    
    string - the string to uppercase
    
    Returns:
    
    the upper-cased String, or null if the string is null
  - toUpperCase
```
public static String toUpperCase(String string,
                                 String ifNull)
```
    Returns the upper-cased variant of the specified String, or the second String if the specified String is null.
    
    Parameters:
    
    string - the string to upper case
    
    charToCount - the string to return if the string is null
    
    Returns:
    
    the upper-cased String
  - toLowerCase
```
public static String toLowerCase(String string)
```
    Returns the lower-cased variant of the specified String.
    
    Parameters:
    
    string - the string to lower case
    
    Returns:
    
    the lower-cased String, or null if the string is null
  - toLowerCase
```
public static String toLowerCase(String string,
                                 String ifNull)
```
    Returns the lower-cased variant of the specified String, or the second String if the specified String is null.
    
    Parameters:
    
    string - the string to lower case
    
    charToCount - the string to return if the string is null
    
    Returns:
    
    the lower-cased String
  - getStringsFromDelimitedToken
```
public static String[] getStringsFromDelimitedToken(String token)
```
    Get String array from a value of the form "{value1, value2, value3}".
    A single comma is treated as the delimiter. The enclosing curly braces can be omitted.
    
    Parameters:
    
    token - the string token
    
    Returns:
    
    the corresponding array
  - getStringsFromDelimitedToken
```
public static String[] getStringsFromDelimitedToken(String token,
                                                    String delim)
```
    Get String array from a value of the form "{value1 value2 value3}".
    The enclosing curly braces can be omitted.
    NOTE: consecutive delimitters are recognized, both leading, trailing, and within the string. For example, getStringsFromArrayToken("{,, foo,, bar, zad,,, }", ",") will return an array of: [null, null, "foo", null, "bar", "zad", null, null, null].
    
    Parameters:
    
    token - the string token
    
    delim - the delimiter
    
    Returns:
    
    the corresponding array
  - makeString
```
public static String makeString(List<Character> charList)
```
    Make a String from a list of Character.
    If the list is empty, an empty String will be returned.
    
    Parameters:
    
    charList - the Character list
    
    Returns:
    
    the string
  - makeString
```
public static String makeString(List<Character> charList,
                                String defString)
```
    Make a String from a list of Character.
    If the list is null or empty, return the specified default String.
    
    Parameters:
    
    charList - the Character list
    
    defString - the default String, used if the list is null/empty
    
    Returns:
    
    the string
  - expandQuotes
```
public static String expandQuotes(String s)
```
    Expand embedded quotes to double the quotes.
    For exmaple, if the input string is: |matt "likes" the news|, the returned string is: |matt ""likes"" the news|.
    
    Parameters:
    
    s - the input string that may contain doubled quotes
    
    Returns:
    
    the expanded string
  - collapseQuotes
```
public static String collapseQuotes(String s)
```
    Collapse embedded/doubled quotes to a single embedded quote.
    For exmaple, if the input string is: |matt ""likes"" the news|, the returned string is: |matt "likes" the news|.
    
    Parameters:
    
    s - the input string that may contain doubled quotes
    
    Returns:
    
    the expanded string
  - convertEmptyToNull
```
public static String convertEmptyToNull(String str)
```
    Convert an empty string to null.
    Trims the string before checking.
    
    Parameters:
    
    str - the string to check
    
    Returns:
    
    the same string, or null if it was empty
  - getString
```
public static String getString(Map source,
                               String key)
                        throws IfsException
```
    Returns a String value from a Map given a key; throws IFS-90008 if the cast to a String value fails.
    
    Parameters:
    
    source - the Map from which to get the String value
    
    key - the key for the String value
    
    Returns:
    
    the String value for the key
    
    Throws:
    
    IfsException - 90008: if the cast fails
  - getBoolean
```
public static Boolean getBoolean(Map source,
                                 String key)
                          throws IfsException
```
    Returns a Boolean value from a Map given a key; throws IFS-90008 if the cast to a Boolean value fails.
    
    Parameters:
    
    source - the Map from which to get the Boolean value
    
    key - the key for the Boolean value
    
    Returns:
    
    the Boolean value for the key
    
    Throws:
    
    IfsException - 90008: if the cast fails
  - getInteger
```
public static Integer getInteger(Map source,
                                 String key)
                          throws IfsException
```
    Returns a Integer value from a Map given a key; throws IFS-90008 if the cast to a Integer value fails.
    
    Parameters:
    
    source - the Map from which to get the Integer value
    
    key - the key for the Integer value
    
    Returns:
    
    the Integer value for the key
    
    Throws:
    
    IfsException - 90008: if the cast fails
  - getLong
```
public static Long getLong(Map source,
                           String key)
                    throws IfsException
```
    Returns a Long value from a Map given a key; throws IFS-90008 if the cast to a Long value fails.
    
    Parameters:
    
    source - the Map from which to get the Long value
    
    key - the key for the Long value
    
    Returns:
    
    the Long value for the key
    
    Throws:
    
    IfsException - 90008: if the cast fails
  - getDate
```
public static Date getDate(Map source,
                           String key)
                    throws IfsException
```
    Returns a Date value from a Map given a key; throws IFS-90008 if the cast to a Date value fails.
    
    Parameters:
    
    source - the Map from which to get the Date value
    
    key - the key for the Date value
    
    Returns:
    
    the Long value for the key
    
    Throws:
    
    IfsException - 90008: if the cast fails
  - getLongArray
```
public static long[] getLongArray(Map source,
                                  String key)
                           throws IfsException
```
    Returns a long array value from a Map given a key; throws IFS-90008 if the cast to a long array value fails.
    
    Parameters:
    
    source - the Map from which to get the Long array value
    
    key - the key for the Long array value
    
    Returns:
    
    the Long value for the key
    
    Throws:
    
    IfsException - 90008: if the cast fails
  - getStringArray
```
public static String[] getStringArray(Map source,
                                      String key)
                               throws IfsException
```
    Returns a String array value from a Map given a key; throws IFS-90008 if the cast to a String array value fails.
    
    Parameters:
    
    source - the Map from which to get the String array value
    
    key - the key for the String array value
    
    Returns:
    
    the Long value for the key
    
    Throws:
    
    IfsException - 90008: if the cast fails
  - toAttributeValueArray
```
public static AttributeValue[] toAttributeValueArray(List<AttributeValue> avList)
```
    Convert the specified list of AttributeValue to an AttributeValue array.
    
    Parameters:
    
    avList - the list of AttributeValue
    
    Returns:
    
    the corresponding AttributeValue array; returns an empty array if list is null or empty
  - getStringStringMap
```
public static Map<String,String> getStringStringMap(String[] keys,
                                                    String[] values)
                                             throws IfsException
```
    Construct a String-String map from the key and value arrays specified.
    
    Parameters:
    
    keys - the keys
    
    values - the values
    
    Returns:
    
    a map with the specified key/values
    
    Throws:
    
    IfsException - (19004) if the arrays are not of equal length
  - getStringLongMap
```
public static Map<String,Long> getStringLongMap(String[] keys,
                                                Long[] values)
                                         throws IfsException
```
    Construct a String-Long map from the key and value arrays specified.
    
    Parameters:
    
    keys - the keys
    
    values - the values
    
    Returns:
    
    a map with the specified key/values
    
    Throws:
    
    IfsException - (19004) if the arrays are not of equal length
  - getStringDoubleMap
```
public static Map<String,Double> getStringDoubleMap(String[] keys,
                                                    Double[] values)
                                             throws IfsException
```
    Construct a String-Double map from the key and value arrays specified.
    
    Parameters:
    
    keys - the keys
    
    values - the values
    
    Returns:
    
    a map with the specified key/values
    
    Throws:
    
    IfsException - (19004) if the arrays are not of equal length
  - getStringLibraryObjectMap
```
public static Map<String,AttributeValue> getStringLibraryObjectMap(String[] keys,
                                                                   LibraryObject[] values)
                                                            throws IfsException
```
    Construct a String-LibraryObject map from the key and value arrays specified.
    
    Parameters:
    
    keys - the keys
    
    values - the values
    
    Returns:
    
    a map with the specified key/values
    
    Throws:
    
    IfsException - (19004) if the arrays are not of equal length
  - getLongStringMap
```
public static Map<Long,String> getLongStringMap(Long[] keys,
                                                String[] values)
                                         throws IfsException
```
    Construct a Long-String map from the key and value arrays specified.
    
    Parameters:
    
    keys - the keys
    
    values - the values
    
    Returns:
    
    a map with the specified key/values
    
    Throws:
    
    IfsException - (19004) if the arrays are not of equal length
  - getLongLongMap
```
public static Map<Long,Long> getLongLongMap(Long[] keys,
                                            Long[] values)
                                     throws IfsException
```
    Construct a Long-Long map from the key and value arrays specified.
    
    Parameters:
    
    keys - the keys
    
    values - the values
    
    Returns:
    
    a map with the specified key/values
    
    Throws:
    
    IfsException - (19004) if the arrays are not of equal length
  - getLongDoubleMap
```
public static Map<Long,Double> getLongDoubleMap(Long[] keys,
                                                Double[] values)
                                         throws IfsException
```
    Construct a Long-Double map from the key and value arrays specified.
    
    Parameters:
    
    keys - the keys
    
    values - the values
    
    Returns:
    
    a map with the specified key/values
    
    Throws:
    
    IfsException - (19004) if the arrays are not of equal length
  - getLongLibraryObjectMap
```
public static Map<Long,AttributeValue> getLongLibraryObjectMap(Long[] keys,
                                                               LibraryObject[] values)
                                                        throws IfsException
```
    Construct a Long-LibraryObject map from the key and value arrays specified.
    
    Parameters:
    
    keys - the keys
    
    values - the values
    
    Returns:
    
    a map with the specified key/values
    
    Throws:
    
    IfsException - (19004) if the arrays are not of equal length

Class CommonUtilities

Method Summary

Methods inherited from class java.lang.Object

Method Detail

arrayContains

objectArrayReverse

stringArrayContains

stringArrayContains

zeroPad

toZeroPaddedString

concatenateStrings

concatenateStrings

splitString

countOccurrences

countUnquotedOccurrences

toUpperCase

toUpperCase

toLowerCase

toLowerCase

getStringsFromDelimitedToken

getStringsFromDelimitedToken

makeString

makeString

expandQuotes

collapseQuotes

convertEmptyToNull

getString

getBoolean

getInteger

getLong

getDate

getLongArray

getStringArray

toAttributeValueArray

getStringStringMap

getStringLongMap

getStringDoubleMap

getStringLibraryObjectMap

getLongStringMap

getLongLongMap

getLongDoubleMap

getLongLibraryObjectMap