Java tutorial
/* * The MIT License (MIT) * * Copyright (c) 2016. Diorite (by Bartomiej Mazur (aka GotoFinal)) * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ package org.diorite.utils.math; import java.util.Random; import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.builder.ToStringBuilder; import org.apache.commons.lang3.builder.ToStringStyle; /** * Class defining range in short, may be used to validate numbers. */ public class ShortRange { /** * Range from 1 to 1. */ public static final ShortRange ONE = new ShortRange(1, 1); /** * Range from 0 to 0. */ public static final ShortRange EMPTY = new ShortRange(0, 0); /** * Range from {@link Short#MIN_VALUE} to {@link Short#MAX_VALUE} */ public static final ShortRange FULL = new ShortRange(Short.MIN_VALUE, Short.MAX_VALUE); private final short min; private final short max; /** * Construct new range. * * @param min min value of range. * @param max max value of range. */ public ShortRange(final short min, final short max) { this.min = min; this.max = max; } /** * Construct new range. * * @param min min value of range. * @param max max value of range. */ public ShortRange(final int min, final int max) { this((short) min, (short) max); } /** * @return min value in range. */ public short getMin() { return this.min; } /** * @return max value in range. */ public short getMax() { return this.max; } /** * @return random value in range. */ public short getRandom() { return ((this.max - this.min) == 0) ? this.max : (short) DioriteRandomUtils.getRandomInt(this.min, this.max); } /** * Returns random value in range. * * @param random random instance to use. * * @return random value in range. */ public short getRandom(final Random random) { return ((this.max - this.min) == 0) ? this.max : (short) DioriteRandomUtils.getRandomInt(random, this.min, this.max); } /** * @return size of range. (max - min + 1) */ public int size() { return ((this.max - this.min) + 1); } /** * Check if given number is in range. * * @param i number to check. * * @return true if it is in range */ public boolean isIn(final int i) { return (i >= this.min) && (i <= this.max); } /** * Check if given number is in range. * * @param i number to check. * * @return true if it is in range */ public boolean isIn(final short i) { return (i >= this.min) && (i <= this.max); } /** * Return given number if it is in range, or closest value in range. * {@code i > max -> max} * {@code i < min -> min} * {@code else -> i} * * @param i number to validate. * * @return closest number in range. */ public int getIn(final short i) { if (i > this.max) { return this.max; } if (i < this.min) { return this.min; } return i; } /** * Return given number if it is in range, or default value. * {@code i > max -> def} * {@code i < min -> def} * {@code else -> i} * * @param i number to validate. * @param def default value. * * @return given number or default value. */ public int getIn(final short i, final short def) { if (!this.isIn(i)) { return def; } return i; } /** * Return given number if it is in range, or default value. * {@code i > max -> def} * {@code i < min -> def} * {@code else -> i} * * @param i number to validate. * @param def default value. * * @return given number or default value. */ public int getIn(final short i, final int def) { if (!this.isIn(i)) { return def; } return i; } /** * Return given number if it is in range, or closest value in range. * {@code i > max -> max} * {@code i < min -> min} * {@code else -> i} * * @param i number to validate. * * @return closest number in range. */ public short getIn(final int i) { if (i > this.max) { return this.max; } if (i < this.min) { return this.min; } return (short) i; } /** * Return given number if it is in range, or closest value in range. * {@code i > max -> def} * {@code i < min -> def} * {@code else -> i} * * @param i number to validate. * @param def default value. * * @return closest number in range. */ public short getIn(final int i, final int def) { if (!this.isIn(i)) { return (short) def; } return (short) i; } @Override public int hashCode() { int result = (int) this.min; result = (31 * result) + (int) this.max; return result; } @Override public boolean equals(final Object o) { if (this == o) { return true; } if (!(o instanceof ShortRange)) { return false; } final ShortRange byteRange = (ShortRange) o; return (this.max == byteRange.max) && (this.min == byteRange.min); } @Override public String toString() { return new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE).appendSuper(super.toString()) .append("min", this.min).append("max", this.max).toString(); } /** * Create range with only gived value in range. * * @param num min and max of range. * * @return range with only one value in range. */ public static ShortRange fixed(final int num) { return new ShortRange(num, num); } /** * Create range with only gived value in range. * * @param num min and max of range. * * @return range with only one value in range. */ public static ShortRange fixed(final short num) { return new ShortRange(num, num); } /** * Parses given string to range, string is valid range when contains 2 numbers (second greater than first) and splt char: <br> * " - ", " : ", " ; ", ", ", " ", ",", ";", ":", "-" * * @param string string to parse. * * @return parsed range or null. */ public static ShortRange valueOf(String string) { if (string.isEmpty()) { return null; } String[] nums = null; int i = 0; final boolean firstMinus = string.charAt(0) == '-'; if (firstMinus) { string = string.substring(1); } while ((i < ByteRange.SPLITS.length) && ((nums == null) || (nums.length != 2))) { nums = StringUtils.splitByWholeSeparator(string, ByteRange.SPLITS[i++], 2); } if ((nums == null) || (nums.length != 2)) { return null; } final Integer min = DioriteMathUtils.asInt(firstMinus ? ("-" + nums[0]) : nums[0]); if ((min == null) || (min < Short.MIN_VALUE)) { return null; } final Integer max = DioriteMathUtils.asInt(nums[1]); if ((max == null) || (max > Short.MAX_VALUE) || (min > max)) { return null; } return new ShortRange(min.shortValue(), max.shortValue()); } }