001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.imaging.internal;
018
019import java.util.Arrays;
020
021/**
022 * Provides safe arithmetic operations to avoid, for example, numeric overflows.
023 *
024 * @since 1.0-alpha4
025 */
026public final class SafeOperations {
027
028    /**
029     * Applies {@link Math#addExact(int, int)} to a variable length array of integers.
030     *
031     * @param values variable length array of integers.
032     * @return the values safely added.
033     */
034    public static int add(final int... values) {
035        if (values == null || values.length < 2) {
036            throw new IllegalArgumentException("You must provide at least two elements to be added");
037        }
038        return Arrays.stream(values).reduce(0, Math::addExact);
039    }
040
041    private SafeOperations() {
042    }
043
044}