com.jashmore.sqs.util.properties.PropertyUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of common-utils Show documentation
Utility methods for dealing with basic functionality for this library, split out so so it can be consumed by other extensions
There is a newer version: 6.0.0
Show newest version
package com.jashmore.sqs.util.properties;

import lombok.experimental.UtilityClass;
import lombok.extern.slf4j.Slf4j;

import java.util.Optional;
import java.util.function.Predicate;
import java.util.function.Supplier;
import javax.annotation.Nonnull;

/**
 * Class that provides helper methods for dealing with the properties of the core components, e.g. by providing safety methods for getting default property
 * values when there is an error obtaining a value.
 */
@Slf4j
@UtilityClass
public class PropertyUtils {
    /**
     * Safely get a long value by returning a default value if there was an error getting the value or the value is null.
     *
     * @param propertyName  the name of the property obtaining the value from, this is used for log messages
     * @param valueSupplier the supplier that will provide the original value
     * @param defaultValue  the default value if the supplier throws an exception or is null
     * @return the long value for this property
     */
    public long safelyGetLongValue(final String propertyName, final Supplier valueSupplier, final long defaultValue) {
        return safelyGetValue(propertyName, valueSupplier, defaultValue, aLong -> true);
    }

    /**
     * Safely get a long value by returning a default value if there was an error getting the value, the value is null or the value is negative or zero.
     *
     * @param propertyName  the name of the property obtaining the value from, this is used for log messages
     * @param valueSupplier the supplier that will provide the original value
     * @param defaultValue  the default value if the supplier throws an exception or is null
     * @return the long value for this property
     */
    public long safelyGetPositiveLongValue(final String propertyName, final Supplier valueSupplier, final long defaultValue) {
        return safelyGetValue(propertyName, valueSupplier, defaultValue, aLong -> aLong > 0);
    }

    /**
     * Safely get a long value by returning a default value if there was an error getting the value, the value is null or the value is negative.
     *
     * @param propertyName  the name of the property obtaining the value from, this is used for log messages
     * @param valueSupplier the supplier that will provide the original value
     * @param defaultValue  the default value if the supplier throws an exception or is null
     * @return the long value for this property
     */
    public long safelyGetPositiveOrZeroLongValue(final String propertyName, final Supplier valueSupplier, final long defaultValue) {
        return safelyGetValue(propertyName, valueSupplier, defaultValue, aLong -> aLong >= 0);
    }

    /**
     * Safely get an int value by returning a default value if there was an error getting the value or the value is null.
     *
     * @param propertyName  the name of the property obtaining the value from, this is used for log messages
     * @param valueSupplier the supplier that will provide the original value
     * @param defaultValue  the default value if the supplier throws an exception or is null
     * @return the int value for this property
     */
    public int safelyGetIntegerValue(final String propertyName, final Supplier valueSupplier, final int defaultValue) {
        return safelyGetValue(propertyName, valueSupplier, defaultValue, aInteger -> true);
    }

    /**
     * Safely get an int value by returning a default value if there was an error getting the value, the value is null or the value is negative or zero.
     *
     * @param propertyName  the name of the property obtaining the value from, this is used for log messages
     * @param valueSupplier the supplier that will provide the original value
     * @param defaultValue  the default value if the supplier throws an exception or is null
     * @return the int value for this property
     */
    public int safelyGetPositiveIntegerValue(final String propertyName, final Supplier valueSupplier, final int defaultValue) {
        return safelyGetValue(propertyName, valueSupplier, defaultValue, aInteger -> aInteger > 0);
    }

    /**
     * Safely get an int value by returning a default value if there was an error getting the value, the value is null or the value is negative.
     *
     * @param propertyName  the name of the property obtaining the value from, this is used for log messages
     * @param valueSupplier the supplier that will provide the original value
     * @param defaultValue  the default value if the supplier throws an exception or is null
     * @return the int value for this property
     */
    public int safelyGetPositiveOrZeroIntegerValue(final String propertyName, final Supplier valueSupplier, final int defaultValue) {
        return safelyGetValue(propertyName, valueSupplier, defaultValue, aInteger -> aInteger >= 0);
    }

    @Nonnull
    private  T safelyGetValue(final String propertyName,
                                 final Supplier valueSupplier,
                                 final T defaultValue,
                                 final Predicate valueValidator) {
        try {
            return Optional.ofNullable(valueSupplier.get())
                    .filter(value -> {
                        if (!valueValidator.test(value)) {
                            log.error("Invalid value {} for property {} returning default value {}", value, propertyName, defaultValue);
                            return false;
                        }

                        return true;
                    })
                    .orElse(defaultValue);
        } catch (final Throwable throwable) {
            log.error("Error obtaining Property value {} returning default value {}", propertyName, defaultValue, throwable);
            return defaultValue;
        }
    }
}