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.beanutils2.converters;
18
19 import java.math.BigInteger;
20
21 /**
22 * {@link NumberConverter} implementation that handles conversion to and from <strong>java.math.BigInteger</strong> objects.
23 * <p>
24 * This implementation can be configured to handle conversion either by using BigInteger's default String conversion, or by using a Locale's pattern or by
25 * specifying a format pattern. See the {@link NumberConverter} documentation for further details.
26 * <p>
27 * Can be configured to either return a <em>default value</em> or throw a {@code ConversionException} if a conversion error occurs.
28 *
29 * @since 1.3
30 */
31 public final class BigIntegerConverter extends NumberConverter<BigInteger> {
32
33 /**
34 * Constructs a <strong>java.math.BigInteger</strong> <em>Converter</em> that throws a {@code ConversionException} if an error occurs.
35 */
36 public BigIntegerConverter() {
37 super(false);
38 }
39
40 /**
41 * Constructs a <strong>java.math.BigInteger</strong> <em>Converter</em> that returns a default value if an error occurs.
42 *
43 * @param defaultValue The default value to be returned if the value to be converted is missing or an error occurs converting the value.
44 */
45 public BigIntegerConverter(final BigInteger defaultValue) {
46 super(false, defaultValue);
47 }
48
49 /**
50 * Constructs a <strong>java.math.BigInteger</strong> <em>Converter</em> that returns a default value if an error occurs.
51 *
52 * @param defaultValue The default value to be returned if the value to be converted is missing or an error occurs converting the value.
53 */
54 public BigIntegerConverter(final Number defaultValue) {
55 this(BigInteger.valueOf(defaultValue.longValue()));
56 }
57
58 /**
59 * Gets the default type this {@code Converter} handles.
60 *
61 * @return The default type this {@code Converter} handles.
62 * @since 1.8.0
63 */
64 @Override
65 protected Class<BigInteger> getDefaultType() {
66 return BigInteger.class;
67 }
68
69 }