org.apache.commons.compress.utils.ExactMath Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commons-compress Show documentation

Apache Commons Compress software defines an API for working with compression and archive formats. These include: bzip2, gzip, pack200, lzma, xz, Snappy, traditional Unix Compress, DEFLATE, DEFLATE64, LZ4, Brotli, Zstandard and ar, cpio, jar, tar, zip, dump, 7z, arj.

There is a newer version: 1.27.1

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.commons.compress.utils;

/**
 * PRIVATE.
 *
 * Performs exact math through {@link Math} "exact" APIs.
 */
public class ExactMath {

    /**
     * Returns the int result of adding an int and a long, and throws an exception if the result overflows an int.
     *
     * @param x the first value, an int.
     * @param y the second value, a long,
     * @return the addition of both values.
     * @throws IllegalArgumentException when y or the result overflows an int
     */
    public static int add(final int x, final long y) {
        try {
            return Math.addExact(x, Math.toIntExact(y));
        } catch (final ArithmeticException exp) {
            throw new IllegalArgumentException("Argument too large or result overflows", exp);
        }
    }

    private ExactMath() {
        // no instances
    }

}