org.lightningj.paywall.util

Class SettingUtils

java.lang.Object

org.lightningj.paywall.util.SettingUtils

public class SettingUtils
extends java.lang.Object

Class containing help methods parsing setting values. Created by Philip Vendil on 2019-01-17.

Constructor Summary

Constructors

Constructor and Description
SettingUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	checkBooleanWithDefault(java.lang.String settingValue, java.lang.String settingKey, boolean defaultValue) Method that returns related boolean or default value if setting is empty.
static int	checkIntegerWithDefault(java.lang.String settingValue, java.lang.String settingKey, int defaultValue) Method that returns related integer or default value if setting is empty.
static long	checkLongWithDefault(java.lang.String settingValue, java.lang.String settingKey, long defaultValue) Method that returns related long or default value if setting is empty.
static boolean	checkRequiredBoolean(java.lang.String settingValue, java.lang.String settingKey) Help method to parse a boolean for a required setting.
static int	checkRequiredInteger(java.lang.String settingValue, java.lang.String settingKey) Help method to parse an integer for a required setting.
static long	checkRequiredLong(java.lang.String settingValue, java.lang.String settingKey) Help method to parse an long for a required setting.
static java.lang.String	checkRequiredString(java.lang.String settingValue, java.lang.String settingKey) Help method that checks that given setting isn't null or empty otherwise it throws an InternalErrorException with error message that related key should be set.
static java.lang.String	checkStringWithDefault(java.lang.String settingValue, java.lang.String defaultValue) Method that returns related string or default value if setting is empty.
static boolean	isEmpty(java.lang.String value) Help method to see if string is null or only contains spaces.

Methods inherited from class java.lang.Object

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

Constructor Detail

SettingUtils

public SettingUtils()

Method Detail

checkRequiredString

public static java.lang.String checkRequiredString(java.lang.String settingValue,
                                                   java.lang.String settingKey)
                                            throws InternalErrorException

Help method that checks that given setting isn't null or empty otherwise it throws an InternalErrorException with error message that related key should be set.

Parameters:

settingValue - the value to set.

settingKey - the key to use in error message

Returns:

the returned value.

Throws:

InternalErrorException - if settingValue was empty.

checkStringWithDefault

public static java.lang.String checkStringWithDefault(java.lang.String settingValue,
                                                      java.lang.String defaultValue)

Method that returns related string or default value if setting is empty.

Parameters:

settingValue - the value of setting

defaultValue - the default value if not set or empty.

Returns:

either the setting or the default value

checkRequiredInteger

public static int checkRequiredInteger(java.lang.String settingValue,
                                       java.lang.String settingKey)
                                throws InternalErrorException

Help method to parse an integer for a required setting.

Parameters:

settingValue - the value to convert to an integer.

settingKey - the key to use in error message

Returns:

a integer version of the setting.

Throws:

InternalErrorException - if setting value was empty or non-integer.

checkIntegerWithDefault

public static int checkIntegerWithDefault(java.lang.String settingValue,
                                          java.lang.String settingKey,
                                          int defaultValue)
                                   throws InternalErrorException

Method that returns related integer or default value if setting is empty.

Parameters:

settingValue - the value of setting

settingKey - the related setting key

defaultValue - the default value if not set or empty.

Returns:

either the setting or the default value

Throws:

InternalErrorException - if setting value was empty or non-integer.

checkRequiredLong

public static long checkRequiredLong(java.lang.String settingValue,
                                     java.lang.String settingKey)
                              throws InternalErrorException

Help method to parse an long for a required setting.

Parameters:

settingValue - the value to convert to an long.

settingKey - the key to use in error message

Returns:

a long version of the setting.

Throws:

InternalErrorException - if setting value was empty or non-integer.

checkLongWithDefault

public static long checkLongWithDefault(java.lang.String settingValue,
                                        java.lang.String settingKey,
                                        long defaultValue)
                                 throws InternalErrorException

Method that returns related long or default value if setting is empty.

Parameters:

settingValue - the value of setting

settingKey - the related setting key

defaultValue - the default value if not set or empty.

Returns:

either the setting or the default value

Throws:

InternalErrorException - if setting value was empty or non-integer.

checkRequiredBoolean

public static boolean checkRequiredBoolean(java.lang.String settingValue,
                                           java.lang.String settingKey)
                                    throws InternalErrorException

Help method to parse a boolean for a required setting.

Parameters:

settingValue - the value to convert to an boolean.

settingKey - the key to use in error message

Returns:

a integer version of the setting.

Throws:

InternalErrorException - if setting value was empty or non-boolean.

checkBooleanWithDefault

public static boolean checkBooleanWithDefault(java.lang.String settingValue,
                                              java.lang.String settingKey,
                                              boolean defaultValue)
                                       throws InternalErrorException

Method that returns related boolean or default value if setting is empty.

Parameters:

settingValue - the value of setting

settingKey - the related setting key

defaultValue - the default value if not set or empty.

Returns:

either the setting or the default value

Throws:

InternalErrorException - if setting value was non-boolean.

isEmpty

public static boolean isEmpty(java.lang.String value)

Help method to see if string is null or only contains spaces.

Parameters:

value - the string to check

Returns:

true if null or empty.