CombinatoricsException.java

/*
 * 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.numbers.combinatorics;

/**
 * Package private exception class with constants for frequently used messages.
 */
class CombinatoricsException extends IllegalArgumentException {
    /** Error message for "out of range" condition. */
    static final String OUT_OF_RANGE = "Number %s is out of range [%s, %s]";
    /** Error message for "out of range" condition. */
    static final String NEGATIVE = "Number %s is negative";
    /** Error message for "mismatch" condition. */
    static final String MISMATCH = "Expected %s but was %s";

    /** Serializable version identifier. */
    private static final long serialVersionUID = 20170515L;

    /**
     * Create an exception where the message is constructed by applying
     * {@link String#format(String, Object...)}.
     *
     * @param message Exception message format string
     * @param formatArguments Arguments for formatting the message
     */
    CombinatoricsException(String message,
                           Object... formatArguments) {
        super(String.format(message, formatArguments));
    }
}