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  
18  package org.apache.commons.beanutils2;
19  
20  /**
21   * A <strong>ConversionException</strong> indicates that a call to {@code Converter.convert()} has failed to complete successfully.
22   *
23   * @since 1.3
24   */
25  public class ConversionException extends RuntimeException {
26  
27      private static final long serialVersionUID = 1L;
28  
29      /**
30       * Constructs a new instance with a message formatted using {@link String#format(String, Object...)}.
31       *
32       * @param format See {@link String#format(String, Object...)}.
33       * @param args   See {@link String#format(String, Object...)}.
34       * @return a new instance with a message formatted using {@link String#format(String, Object...)}.
35       * @since 2.0.0
36       */
37      public static ConversionException format(final String format, final Object... args) {
38          return new ConversionException(String.format(format, args));
39      }
40  
41      /**
42       * Constructs a new exception with the specified message.
43       *
44       * @param message The message describing this exception
45       */
46      public ConversionException(final String message) {
47          super(message);
48      }
49  
50      /**
51       * Constructs a new exception with the specified message and root cause.
52       *
53       * @param message The message describing this exception
54       * @param cause   The root cause of this exception
55       */
56      public ConversionException(final String message, final Throwable cause) {
57          super(message, cause);
58      }
59  
60      /**
61       * Constructs a new exception with the specified root cause.
62       *
63       * @param cause The root cause of this exception
64       */
65      public ConversionException(final Throwable cause) {
66          super(cause.getMessage());
67      }
68  
69  }