StringUtils (OpenAM Shared 14.8.2 API)

java.lang.Object
- org.forgerock.openam.utils.StringUtils

public final class StringUtils
extends Object

Utility class for handling Strings.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`compareCaseInsensitiveString(String s1, String s2)` Compares two strings in a case insensitive manner, that also allows for either of the strings to be null, without issue.
`static boolean`	`contains(String s1, String s2)` Check if one string contains another string.
`static boolean`	`containsCaseInsensitive(String s1, String s2)` Check if one string contains another string in a case insensitive manner.
`static String`	`encodeURIComponent(String component, String encoding)` Encodes the passed String using an algorithm that's compatible with JavaScript's `encodeURIComponent` function.
`static List<String>`	`getParameter(String list, String delimiter, String parameterName)` Takes a list as a String (where each element is of the form name=value) and returns the value specified by parameterName (if it exists).
`static String`	`ifNullOrEmpty(String original, String defaultString)` Checks that the original string is not null nor empty, if so it returns the non-null default string instead.
`static String`	`insertContent(String original, int position, String content)` Inserted content into a string.
`static boolean`	`isAnyBlank(Set<String> xs)` Tests whether any string in the given set is blank.
`static boolean`	`isBlank(String s)` Determines if the string is blank.
`static boolean`	`isEmpty(String s)` Determines if the string is empty.
`static boolean`	`isEqualTo(String s1, String s2)` Compare two strings for equality.
`static boolean`	`isNotBlank(String s)` Determines if the string is not blank.
`static boolean`	`isNotEmpty(String s)` Determines if the string is not empty.
`static boolean`	`match(String value, String strPattern)` Match the value to the regular expression pattern.
`static List<String>`	`split(String content, Pattern pattern)` Splits a string into a list of elements by a pattern.
`static boolean`	`startsWith(String s1, String s2)` Check if one string starts with another string.
`static String`	`tagSwap(String content, Map<String,String> tagSwapMap)` Swaps content with tags with the provided tag values.

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

- Method Detail
  - tagSwap
```
public static String tagSwap(String content,
                             Map<String,String> tagSwapMap)
```
    Swaps content with tags with the provided tag values.
    
    Parameters:
    
    content - The String content to be replaced
    
    tagSwapMap - A map containing the replacable tokens with their new values
    
    Returns:
    
    the tagswapped String content
  - insertContent
```
public static String insertContent(String original,
                                   int position,
                                   String content)
```
    Inserted content into a string.
    
    Parameters:
    
    original - The original string.
    
    position - The insertion position.
    
    content - The content to insert.
    
    Returns:
    
    A new string with the inserted content.
  - getParameter
```
public static List<String> getParameter(String list,
                                        String delimiter,
                                        String parameterName)
```
    Takes a list as a String (where each element is of the form name=value) and returns the value specified by parameterName (if it exists).
    
    Parameters:
    
    list - The list e.g. a=1,b=2,c=5
    
    delimiter - The delimiter used to separate the elements (e.g. ",")
    
    parameterName - The name of the parameter to return
    
    Returns:
    
    The value(s) specified by parameterName
  - ifNullOrEmpty
```
public static String ifNullOrEmpty(String original,
                                   String defaultString)
```
    Checks that the original string is not null nor empty, if so it returns the non-null default string instead.
    
    Parameters:
    
    original - the original string
    
    defaultString - the non-null default string
    
    Returns:
    
    the original string if not null and not empty, else the default string
  - encodeURIComponent
```
public static String encodeURIComponent(String component,
                                        String encoding)
                                 throws UnsupportedEncodingException
```
    Encodes the passed String using an algorithm that's compatible with JavaScript's encodeURIComponent function. Returns null if the String is null.
    
    Parameters:
    
    component - String to be encoded.
    
    encoding - The name of character encoding.
    
    Returns:
    
    the same value as JavaScript encodeURIComponent function
    
    Throws:
    
    UnsupportedEncodingException - If the named encoding is not supported
  - isEmpty
```
public static boolean isEmpty(String s)
```
    Determines if the string is empty.
    
    Parameters:
    
    s - string to test
    
    Returns:
    
    true if the specified string is null or zero length.
  - isBlank
```
public static boolean isBlank(String s)
```
    Determines if the string is blank.
    
    Parameters:
    
    s - string to test
    
    Returns:
    
    true if the specified string is null or when trimmed is empty (i.e. when trimmed it has zero length)
  - isNotEmpty
```
public static boolean isNotEmpty(String s)
```
    Determines if the string is not empty.
    
    Parameters:
    
    s - string to test
    
    Returns:
    
    test if the specified string is not null and not empty (i.e. is greater than zero length).
  - isNotBlank
```
public static boolean isNotBlank(String s)
```
    Determines if the string is not blank.
    
    Parameters:
    
    s - string to test
    
    Returns:
    
    true if the specified string is not null and when trimmed has greater than zero length.
  - isAnyBlank
```
public static boolean isAnyBlank(Set<String> xs)
```
    Tests whether any string in the given set is blank.
    
    Parameters:
    
    xs - the set of strings.
    
    Returns:
    
    true if the set is null or empty or if any member of the set is blank.
    
    See Also:
    
    isBlank(String)
  - isEqualTo
```
public static boolean isEqualTo(String s1,
                                String s2)
```
    Compare two strings for equality.
    
    Parameters:
    
    s1 - first string to compare.
    
    s2 - second string to compare.
    
    Returns:
    
    true if strings are equal or they are both null.
  - compareCaseInsensitiveString
```
public static boolean compareCaseInsensitiveString(String s1,
                                                   String s2)
```
    Compares two strings in a case insensitive manner, that also allows for either of the strings to be null, without issue.
    
    Parameters:
    
    s1 - the first string to be compared.
    
    s2 - the second string to tbe compared.
    
    Returns:
    
    true if the parameter values are the same, false if different.
  - contains
```
public static boolean contains(String s1,
                               String s2)
```
    Check if one string contains another string.
    
    Parameters:
    
    s1 - The string to check in.
    
    s2 - The string to check for.
    
    Returns:
    
    False if either string is null or if the first does not contain the second, otherwise true.
  - containsCaseInsensitive
```
public static boolean containsCaseInsensitive(String s1,
                                              String s2)
```
    Check if one string contains another string in a case insensitive manner.
    
    Parameters:
    
    s1 - The string to check in.
    
    s2 - The string to check for.
    
    Returns:
    
    False if either string is null or if the first does not contain the second, otherwise true.
  - startsWith
```
public static boolean startsWith(String s1,
                                 String s2)
```
    Check if one string starts with another string.
    
    Parameters:
    
    s1 - The string to check in.
    
    s2 - The string to check for.
    
    Returns:
    
    False if either string is null or if the first does not start with the second, otherwise true.
  - match
```
public static boolean match(String value,
                            String strPattern)
```
    Match the value to the regular expression pattern. The pattern given can contain a file name like search, e.g. '*service*', which will be converted to a valid regular expression, e.g. '.*?service.*'.
    
    Parameters:
    
    value - The value to match on.
    
    strPattern - The pattern to match.
    
    Returns:
    
    True if the value matches the pattern, false otherwise.
  - split
```
public static List<String> split(String content,
                                 Pattern pattern)
```
    Splits a string into a list of elements by a pattern.
    
    Parameters:
    
    content - the content to split into a list of elements.
    
    pattern - the regular expression to use to split elements.
    
    Returns:
    
    the list of elements, or an empty list if the content was null.

Class StringUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

tagSwap

insertContent

getParameter

ifNullOrEmpty

encodeURIComponent

isEmpty

isBlank

isNotEmpty

isNotBlank

isAnyBlank

isEqualTo

compareCaseInsensitiveString

contains

containsCaseInsensitive

startsWith

match

split