Java Integer Clamp clamp(int value, final int minimum, final int maximum)

Description

clamp

License

Open Source License

Parameter

Parameter	Description
value	the value to clamp.
minimum	lower boundary of the range, inclusive.
maximum	upper boundary of the range, inclusive.

Return

the value clamped to the specified range.

Declaration

@SuppressWarnings({ "AssignmentToMethodParameter" })
public static int clamp(int value, final int minimum, final int maximum) 

Method Source Code

//package com.java2s;
/*//w w w  .j  av  a  2  s  .  co m
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2007-2008, Open Source Geospatial Foundation (OSGeo)
 *
 *    This library 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;
 *    version 2.1 of the License.
 *
 *    This library 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.
 */

public class Main {
    /**
     * @param value   the value to clamp.
     * @param minimum lower boundary of the range, inclusive.
     * @param maximum upper boundary of the range, inclusive.
     *
     * @return the value clamped to the specified range.
     */
    @SuppressWarnings({ "AssignmentToMethodParameter" })
    public static int clamp(int value, final int minimum, final int maximum) {
        if (minimum > maximum) {
            throw new IllegalArgumentException(
                    "The minimum " + minimum + " is larger than the maximum " + maximum + ", possible bug?");
        }

        if (value < minimum) {
            value = minimum;
        } else if (value > maximum) {
            value = maximum;
        }

        return value;
    }
}

Related

1. clamp(int ptr, int size)
2. clamp(int v, int min, int max)
3. clamp(int v, int min, int max)
4. clamp(int v, int min, int max)
5. clamp(int val, int min, int max)
6. clamp(int value, int a, int b)
7. clamp(int value, int low, int high)
8. clamp(int value, int low, int high)
9. clamp(int value, int min, int max)