org.finra.herd.dao.helper

Class HerdStringHelper

java.lang.Object

org.finra.herd.dao.helper.HerdStringHelper

@Component
public class HerdStringHelper
extends Object

A helper class for general herd code.

Constructor Summary

Constructors

Constructor and Description
HerdStringHelper()

Method Summary

Modifier and Type	Method and Description
String	buildStringWithDefaultDelimiter(List<String> inputStrings) Builds the string delimited by default delimiter for the input String values.
int	getConfigurationValueAsInteger(ConfigurationValue configurationValue) TODO replace uses of this method with ConfigurationHelper Gets the configuration value as integer.
String	getConfigurationValueAsString(ConfigurationValue configurationValue) TODO replace uses of this method with ConfigurationHelper Gets the configuration value as string.
List<String>	getDelimitedConfigurationValue(ConfigurationValue configurationValue) Returns a list of values from a configuration value which are delimited by the default delimited configured by FIELD_DATA_DELIMITER.
String	getRequiredConfigurationValue(ConfigurationValue configurationValue) Gets the value and verifies that it is not blank for the given configuration option.
String	join(List<String> list, String delimiter, String escapeSequence) Joins the given list of strings, separating each by the given delimiter.
Set<String>	splitAndTrim(String string, String delimiter) Splits the given string by the given delimiter.
List<String>	splitStringWithDefaultDelimiter(String inputString) Splits the input String based on the default delimiter
List<String>	splitStringWithDefaultDelimiterEscaped(String inputString) Splits the input String based on the default delimiter, and also escapes delimiter.

Methods inherited from class java.lang.Object

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

Constructor Detail

HerdStringHelper

public HerdStringHelper()

Method Detail

splitStringWithDefaultDelimiter

public List<String> splitStringWithDefaultDelimiter(String inputString)

Splits the input String based on the default delimiter

Parameters:

inputString - to be split

Returns:

the list of String literals that are split with the delimiter

splitStringWithDefaultDelimiterEscaped

public List<String> splitStringWithDefaultDelimiterEscaped(String inputString)

Splits the input String based on the default delimiter, and also escapes delimiter.

Parameters:

inputString - to be split

Returns:

the list of String literals that are split with the delimiter

getRequiredConfigurationValue

public String getRequiredConfigurationValue(ConfigurationValue configurationValue)

Gets the value and verifies that it is not blank for the given configuration option.

Parameters:

configurationValue - the configuration option

Returns:

the configuration option value

getConfigurationValueAsInteger

public int getConfigurationValueAsInteger(ConfigurationValue configurationValue)

TODO replace uses of this method with ConfigurationHelper Gets the configuration value as integer.

Parameters:

configurationValue - the configuration value.

Returns:

the configuration value as an integer.

getConfigurationValueAsString

public String getConfigurationValueAsString(ConfigurationValue configurationValue)

TODO replace uses of this method with ConfigurationHelper Gets the configuration value as string.

splitAndTrim

public Set<String> splitAndTrim(String string,
                                String delimiter)

Splits the given string by the given delimiter. Trims each token and ignores if empty.

TODO should be merged with splitStringWithDefaultDelimiter(String) and splitStringWithDefaultDelimiterEscaped(String)

TODO determine whether we should use String.split(String) or StringTokenizer

Parameters:

string - The string to split

delimiter - The delimiter of tokens

Returns:

Set of tokens

join

public String join(List<String> list,
                   String delimiter,
                   String escapeSequence)

Joins the given list of strings, separating each by the given delimiter. The elements are ignored if blank. If the original string contains the delimiter, it will be escaped by prepending it with the given escape sequence. If given list is null, the result is also null.

Parameters:

list - List of strings to join

delimiter - Delimiter to separate each element

escapeSequence - Escape sequence to use to escape delimiters

Returns:

Joined string

getDelimitedConfigurationValue

public List<String> getDelimitedConfigurationValue(ConfigurationValue configurationValue)

Returns a list of values from a configuration value which are delimited by the default delimited configured by FIELD_DATA_DELIMITER. Returns an empty list if the configuration value does not exist.

Parameters:

configurationValue - The configuration value

Returns:

List of values

buildStringWithDefaultDelimiter

public String buildStringWithDefaultDelimiter(List<String> inputStrings)

Builds the string delimited by default delimiter for the input String values.

Parameters:

inputStrings - List of string literals

Returns:

the String delimited with the default delimiter