org.finra.herd.service.helper

Class ParameterHelper

java.lang.Object

org.finra.herd.service.helper.ParameterHelper

@Component
public class ParameterHelper
extends Object

A helper class for Parameter related code.

Constructor Summary

Constructors

Constructor and Description
ParameterHelper()

Method Summary

Modifier and Type	Method and Description
String	getParameterValue(Map<String,String> parameters, ConfigurationValue configurationValue) Gets the parameter value if found or defaults to the relative configuration setting value.
int	getParameterValueAsInteger(Map<String,String> parameters, ConfigurationValue configurationValue) Gets the parameter value if found or defaults to the relative configuration setting value.
int	getParameterValueAsInteger(Parameter parameter) Parses the parameter value as a signed decimal integer.
void	validateParameters(List<Parameter> parameters) Validates that parameter names are there and that there are no duplicate parameter names in case insensitive manner.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterHelper

public ParameterHelper()

Method Detail

getParameterValueAsInteger

public int getParameterValueAsInteger(Parameter parameter)
                               throws IllegalArgumentException

Parses the parameter value as a signed decimal integer.

Parameters:

parameter - the string value to be parsed

Returns:

the integer value represented by the parameter value in decimal

Throws:

IllegalArgumentException - if the parameter value does not contain a parsable integer

getParameterValueAsInteger

public int getParameterValueAsInteger(Map<String,String> parameters,
                                      ConfigurationValue configurationValue)
                               throws IllegalArgumentException

Gets the parameter value if found or defaults to the relative configuration setting value. The parameter value is parsed as a signed decimal integer.

Parameters:

parameters - the map of parameters

configurationValue - the configuration value

Returns:

the integer value represented by the parameter value in decimal

Throws:

IllegalArgumentException - if the parameter value does not contain a parsable integer

validateParameters

public void validateParameters(List<Parameter> parameters)

Validates that parameter names are there and that there are no duplicate parameter names in case insensitive manner. This method also trims parameter names.

Parameters:

parameters - the list of parameters to be validated

getParameterValue

public String getParameterValue(Map<String,String> parameters,
                                ConfigurationValue configurationValue)

Gets the parameter value if found or defaults to the relative configuration setting value.

Parameters:

parameters - the map of parameters

configurationValue - the configuration value

Returns:

the parameter value if found, the relative configuration setting value otherwise