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    *      https://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  
18  package org.apache.commons.validator.routines.checkdigit;
19  
20  import java.util.IllegalFormatException;
21  
22  /**
23   * Check Digit calculation/validation error.
24   *
25   * @since 1.4
26   */
27  public class CheckDigitException extends Exception {
28  
29      private static final long serialVersionUID = -3519894732624685477L;
30  
31      /**
32       * Constructs a new exception with no message.
33       */
34      public CheckDigitException() {
35      }
36  
37      /**
38       * Constructs a new exception with a message.
39       *
40       * @param msg The error message.
41       */
42      public CheckDigitException(final String msg) {
43          super(msg);
44      }
45  
46      /**
47       * Constructs a new exception with a message and the underlying cause.
48       *
49       * @param format See {@link String#format(String, Object...)}.
50       * @param args   See {@link String#format(String, Object...)}.
51       * @throws IllegalFormatException See {@link String#format(String, Object...)}.
52       * @since 1.11.0
53       */
54      public CheckDigitException(final String format, final Object... args) {
55          super(String.format(format, args));
56      }
57  
58      /**
59       * Constructs an Exception with a message and the underlying cause.
60       *
61       * @param msg   The error message.
62       * @param cause The underlying cause of the error.
63       */
64      public CheckDigitException(final String msg, final Throwable cause) {
65          super(msg, cause);
66      }
67  }