com.jkoolcloud.tnt4j.streams.utils.DoubleRange.java Source code

Introduction

Here is the source code for com.jkoolcloud.tnt4j.streams.utils.DoubleRange.java

Source

/*
 * Copyright 2014-2017 JKOOL, LLC.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.jkoolcloud.tnt4j.streams.utils;

import java.util.regex.Pattern;

import org.apache.commons.lang3.math.NumberUtils;

/**
 * Defines {@link Double} type numeric range.
 *
 * @version $Revision: 1 $
 */
public class DoubleRange extends Range<Double> {
    private static final Pattern D_PATTERN = Pattern.compile(NEGATIVE_REGEX + DOUBLE_REGEX);
    private static final Pattern D_PATTERN_POSITIVE = Pattern.compile(DOUBLE_REGEX);

    /**
     * Constructs a new DoubleRange.
     *
     * @param from
     *            range lower bound
     * @param to
     *            range upper bound
     */
    public DoubleRange(Double from, Double to) {
        super(from, to);
    }

    @Override
    public boolean equals(Object obj) {
        if (obj instanceof Number) {
            return inRange(((Number) obj).doubleValue());
        }

        if (obj instanceof String) {
            try {
                return inRange(Double.parseDouble((String) obj));
            } catch (NumberFormatException exc) {
            }
        }

        return super.equals(obj);
    }

    @Override
    public boolean inRange(Double num) {
        int compareMin = getFrom().compareTo(num);
        int compareMax = getTo().compareTo(num);

        return compareMin <= 0 && compareMax >= 0;
    }

    /**
     * Same as {@link #getRange(String, boolean)} setting {@code positive} flag to {@code false}.
     *
     * @param rangeStr
     *            range definition string to parse
     * @return double range parsed from range definition string
     * @throws Exception
     *             if range string can't be parsed
     * @see #getRange(String, boolean)
     */
    public static DoubleRange getRange(String rangeStr) throws Exception {
        return getRange(rangeStr, false);
    }

    /**
     * Makes range object using values parsed from {@code rangeStr}.
     * <p>
     * If {@code rangeStr} has missing range bound values, default ones are set: lower
     * {@code positive ? 0 : -Double.MAX_VALUE}, upper {@code Double.MAX_VALUE}.
     * <p>
     * Range separator symbol is '{@value com.jkoolcloud.tnt4j.streams.utils.Range#RANGE_SEPARATOR}'.
     *
     * @param rangeStr
     *            range definition string to parse
     * @param positive
     *            {@code true} means range has only positive values, {@code} - range can have negative values.
     * @return double range parsed from range definition string
     * @throws Exception
     *             if range string can't be parsed
     * @see Range#parseRange(String, Pattern)
     */
    public static DoubleRange getRange(String rangeStr, boolean positive) throws Exception {
        String[] rangeTokens = parseRange(rangeStr, positive ? D_PATTERN_POSITIVE : D_PATTERN);

        double from = NumberUtils.toDouble(rangeTokens[0], positive ? 0 : -Double.MAX_VALUE);
        double to = NumberUtils.toDouble(rangeTokens[1], Double.MAX_VALUE);

        return new DoubleRange(from, to);
    }
}