Constrains an amount between upper and lower bounds, inclusive. - Android java.lang

Android examples for java.lang:Math

Description

Constrains an amount between upper and lower bounds, inclusive.

Demo Code

/*//from w w w. j  a  v  a2 s  .com
 * Copyright (C) 2013 Google Inc.
 *
 * 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.java2s;

public class Main {
    /**
     * Constrains an amount between upper and lower bounds, inclusive.
     *
     * @param amount The amount to constrain.
     * @param lower The lower bound, inclusive.
     * @param upper The upper bound, inclusive.
     * @return The closest amount between the {@code upper} and {@code lower}
     *         bounds.
     */
    public static int constrain(int amount, int lower, int upper) {
        return ((amount < lower) ? lower : ((amount > upper) ? upper
                : amount));
    }

    /**
     * Constrains an amount between upper and lower bounds, inclusive.
     *
     * @param amount The amount to constrain.
     * @param lower The lower bound, inclusive.
     * @param upper The upper bound, inclusive.
     * @return The closest amount between the {@code upper} and {@code lower}
     *         bounds.
     */
    public static long constrain(long amount, long lower, long upper) {
        return ((amount < lower) ? lower : ((amount > upper) ? upper
                : amount));
    }

    /**
     * Constrains an amount between upper and lower bounds, inclusive.
     *
     * @param amount The amount to constrain.
     * @param lower The lower bound, inclusive.
     * @param upper The upper bound, inclusive.
     * @return The closest amount between the {@code upper} and {@code lower}
     *         bounds.
     */
    public static float constrain(float amount, float lower, float upper) {
        return ((amount < lower) ? lower : ((amount > upper) ? upper
                : amount));
    }
}

Related Tutorials