001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2018 Wren Security. All rights reserved.
015 */
016package org.forgerock.api.util;
017
018import java.math.BigDecimal;
019
020/**
021 * Common utility methods for dealing with {@code BigDecimal} values.
022 */
023public final class BigDecimalUtil {
024    /**
025     * Private constructor for singleton static class.
026     */
027    private BigDecimalUtil() { }
028
029    /**
030     * Convert a nullable {@code Double} into a {@code BigDecimal} value.
031     *
032     * <p>If the value is {@code null}, then {@code null} is returned.
033     *
034     * @param value
035     *   The value to convert to a {@code BigDecimal}.
036     *
037     * @return
038     *   If {@code value} is not {@code null}, the {@code BigDecimal} value of the double value;
039     *   otherwise, {@code null}.
040     */
041    public static BigDecimal safeValueOf(final Double value) {
042        if (value == null) {
043            return null;
044        } else {
045            return BigDecimal.valueOf(value);
046        }
047    }
048}