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  import java.text.MessageFormat;
20  
21  /**
22   * Package private exception class with constants for frequently used messages.
23   */
24  class CombinatoricsException extends IllegalArgumentException {
25      /** Error message for "out of range" condition. */
26      static final String OUT_OF_RANGE = "Number {0} is out of range [{1}, {2}]";
27      /** Error message for "out of range" condition. */
28      static final String NEGATIVE = "Number {0} is negative";
29      /** Error message for "mismatch" condition. */
30      static final String MISMATCH = "Expected {1} but was {0}";
31  
32      /** Serializable version identifier. */
33      private static final long serialVersionUID = 20170515L;
34  
35      /**
36       * Create an exception where the message is constructed by applying
37       * the {@code format()} method from {@code java.text.MessageFormat}.
38       *
39       * @param message Exception message with replaceable parameters.
40       * @param formatArguments 1rguments for formatting the message.
41       */
42      CombinatoricsException(String message,
43                             Object... formatArguments) {
44          super(MessageFormat.format(message, formatArguments));
45      }
46  }