fr.sii.ogham.core.util

Class StringUtils

java.lang.Object

fr.sii.ogham.core.util.StringUtils

public final class StringUtils
extends Object

Helper class for string manipulation:

• Join an array or list into a string with a delimiter

This work can be done by several libraries. The aim of this class is to be able to change the implementation easily to use another library for example.

For example, we could read which library is available in the classpath and use this library instead of forcing users to include Apache Commons Lang library.

Author:

Aurélien Baudet

Method Summary

Modifier and Type	Method and Description
static String	capitalize(String str) Capitalizes a String changing the first character to title case.
static String	join(Iterable<?> iterable, String separator) Joins the elements of the provided Iterable into a single String containing the provided elements.
static String	join(Object[] array, String separator) Joins the elements of the provided array into a single String containing the provided list of elements.
static String	leftPad(String str, int size, char padChar) Left pad a String with a specified character.

Methods inherited from class java.lang.Object

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

Method Detail

join

public static String join(Object[] array,
                          String separator)

Joins the elements of the provided array into a single String containing the provided list of elements.

No delimiter is added before or after the list. A null separator is the same as an empty String (""). Null objects or empty strings within the array are represented by empty strings.

  StringUtils.join(null, *)                = null
  StringUtils.join([], *)                  = ""
  StringUtils.join([null], *)              = ""
  StringUtils.join(["a", "b", "c"], "--")  = "a--b--c"
  StringUtils.join(["a", "b", "c"], null)  = "abc"
  StringUtils.join(["a", "b", "c"], "")    = "abc"
  StringUtils.join([null, "", "a"], ',')   = ",,a"
 

Parameters:

array - the array of values to join together, may be null

separator - the separator character to use, null treated as ""

Returns:

the joined String, null if null array input

join

public static String join(Iterable<?> iterable,
                          String separator)

Joins the elements of the provided Iterable into a single String containing the provided elements.

No delimiter is added before or after the list. A null separator is the same as an empty String ("").

See the examples here: join(Object[], String).

Parameters:

iterable - the Iterable providing the values to join together, may be null

separator - the separator character to use, null treated as ""

Returns:

the joined String, null if null iterator input

leftPad

public static String leftPad(String str,
                             int size,
                             char padChar)

Left pad a String with a specified character.

Pad to a size of size.

 StringUtils.leftPad(null, *, *)     = null
 StringUtils.leftPad("", 3, 'z')     = "zzz"
 StringUtils.leftPad("bat", 3, 'z')  = "bat"
 StringUtils.leftPad("bat", 5, 'z')  = "zzbat"
 StringUtils.leftPad("bat", 1, 'z')  = "bat"
 StringUtils.leftPad("bat", -1, 'z') = "bat"
 

Parameters:

str - the String to pad out, may be null

size - the size to pad to

padChar - the character to pad with

Returns:

left padded String or original String if no padding is necessary, null if null String input

capitalize

public static String capitalize(String str)

Capitalizes a String changing the first character to title case. No other characters are changed.

A null input String returns null.

 StringUtils.capitalize(null)  = null
 StringUtils.capitalize("")    = ""
 StringUtils.capitalize("cat") = "Cat"
 StringUtils.capitalize("cAt") = "CAt"
 StringUtils.capitalize("'cat'") = "'cat'"
 

Parameters:

str - the String to capitalize, may be null

Returns:

the capitalized String, null if null String input