View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.numbers.combinatorics;
18  
19  /**
20   * Package private exception class with constants for frequently used messages.
21   */
22  class CombinatoricsException extends IllegalArgumentException {
23      /** Error message for "out of range" condition. */
24      static final String OUT_OF_RANGE = "Number %s is out of range [%s, %s]";
25      /** Error message for "out of range" condition. */
26      static final String NEGATIVE = "Number %s is negative";
27      /** Error message for "mismatch" condition. */
28      static final String MISMATCH = "Expected %s but was %s";
29  
30      /** Serializable version identifier. */
31      private static final long serialVersionUID = 20170515L;
32  
33      /**
34       * Create an exception where the message is constructed by applying
35       * {@link String#format(String, Object...)}.
36       *
37       * @param message Exception message format string
38       * @param formatArguments Arguments for formatting the message
39       */
40      CombinatoricsException(String message,
41                             Object... formatArguments) {
42          super(String.format(message, formatArguments));
43      }
44  }