io.github.palexdev.materialfx.beans.NumberRange Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of materialfx Show documentation
Material Desgin components for JavaFX
The newest version!
/*
 * Copyright (C) 2022 Parisi Alessandro
 * This file is part of MaterialFX (https://github.com/palexdev/MaterialFX).
 *
 * MaterialFX is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MaterialFX is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with MaterialFX.  If not, see .
 */

package io.github.palexdev.materialfx.beans;

import java.util.*;
import java.util.stream.IntStream;

/**
 * Simple bean to represent a range of values from min to max.
 *
 * @param  The type of Number to represent
 */
public class NumberRange {
	//================================================================================
	// Properties
	//================================================================================
	private final T min;
	private final T max;

	//================================================================================
	// Constructors
	//================================================================================
	public NumberRange(T min, T max) {
		this.min = min;
		this.max = max;
	}

	//================================================================================
	// Methods
	//================================================================================

	/**
	 * @return the lower bound
	 */
	public T getMin() {
		return min;
	}

	/**
	 * @return the upper bound
	 */
	public T getMax() {
		return max;
	}

	@Override
	public boolean equals(Object o) {
		if (this == o) return true;
		if (o == null || getClass() != o.getClass()) return false;
		NumberRange that = (NumberRange) o;
		return Objects.equals(min, that.min) && Objects.equals(max, that.max);
	}

	@Override
	public int hashCode() {
		return Objects.hash(min, max);
	}

	@Override
	public String toString() {
		return "Min[" + min + "], Max[" + max + "]";
	}
	//================================================================================
	// Static Methods
	//================================================================================

	/**
	 * Returns a new instance of NumberRange with the given min and max bounds.
	 */
	public static  NumberRange of(T min, T max) {
		return new NumberRange<>(min, max);
	}

	/**
	 * Returns a new instance of NumberRange with the given val as both min and max bounds.
	 */
	public static  NumberRange of(T val) {
		return new NumberRange<>(val, val);
	}

	/**
	 * Checks if the given value is contained in the given range (bounds are included).
	 */
	public static boolean inRangeOf(double val, NumberRange range) {
		return Math.max(range.getMin(), val) == Math.min(val, range.getMax());
	}

	/**
	 * Checks if the given value is contained in the given range (bounds are included).
	 */
	public static boolean inRangeOf(float val, NumberRange range) {
		return Math.max(range.getMin(), val) == Math.min(val, range.getMax());
	}

	/**
	 * Checks if the given value is contained in the given range (bounds are included).
	 */
	public static boolean inRangeOf(int val, NumberRange range) {
		return Math.max(range.getMin(), val) == Math.min(val, range.getMax());
	}

	/**
	 * Checks if the given value is contained in the given range (bounds are included).
	 */
	public static boolean inRangeOf(long val, NumberRange range) {
		return Math.max(range.getMin(), val) == Math.min(val, range.getMax());
	}

	/**
	 * Checks if the given value is contained in any of the given ranges (bounds are included).
	 */
	public static boolean inRangeOf(double val, List> ranges) {
		return ranges.stream().anyMatch(range -> inRangeOf(val, range));
	}

	/**
	 * Checks if the given value is contained in any of the given ranges (bounds are included).
	 */
	public static boolean inRangeOf(float val, List> ranges) {
		return ranges.stream().anyMatch(range -> inRangeOf(val, range));
	}

	/**
	 * Checks if the given value is contained in any of the given ranges (bounds are included).
	 */
	public static boolean inRangeOf(int val, List> ranges) {
		return ranges.stream().anyMatch(range -> inRangeOf(val, range));
	}

	/**
	 * Checks if the given value is contained in any of the given ranges (bounds are included).
	 */
	public static boolean inRangeOf(long val, List> ranges) {
		return ranges.stream().anyMatch(range -> inRangeOf(val, range));
	}

	/**
	 * Expands a range of integers to a List of integers.
	 */
	public static List expandRange(NumberRange range) {
		return IntStream.rangeClosed(range.getMin(), range.getMax()).collect(ArrayList::new, ArrayList::add, ArrayList::addAll);
	}

	/**
	 * Expands a range of integers to a List of integers.
	 */
	public static List expandRange(int min, int max) {
		return IntStream.rangeClosed(min, max).collect(ArrayList::new, ArrayList::add, ArrayList::addAll);
	}

	/**
	 * Expands a range of integers to a Set of integers.
	 */
	public static Set expandRangeToSet(NumberRange range) {
		return IntStream.rangeClosed(range.getMin(), range.getMax()).collect(HashSet::new, HashSet::add, HashSet::addAll);
	}

	/**
	 * Expands a range of integers to a Set of integers.
	 */
	public static Set expandRangeToSet(int min, int max) {
		return IntStream.rangeClosed(min, max).collect(HashSet::new, HashSet::add, HashSet::addAll);
	}

	/**
	 * Expands a range of integers to an array of integers.
	 */
	public static Integer[] expandRangeToArray(int min, int max) {
		return IntStream.rangeClosed(min, max).boxed().toArray(Integer[]::new);
	}
}