org.apache.commons.beanutils2.converters.BigDecimalConverter Maven / Gradle / Ivy
Show all versions of commons-beanutils2 Show documentation
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.beanutils2.converters;
import java.math.BigDecimal;
/**
* {@link NumberConverter} implementation that handles conversion to and from java.math.BigDecimal objects.
*
* This implementation can be configured to handle conversion either by using BigDecimal's default String conversion, or by using a Locale's pattern or by
* specifying a format pattern. See the {@link NumberConverter} documentation for further details.
*
* Can be configured to either return a default value or throw a {@code ConversionException} if a conversion error occurs.
*
* @since 1.3
*/
public final class BigDecimalConverter extends NumberConverter {
/**
* Constructs a java.math.BigDecimal Converter that throws a {@code ConversionException} if an error occurs.
*/
public BigDecimalConverter() {
super(true);
}
/**
* Constructs a java.math.BigDecimal Converter that returns a default value if an error occurs.
*
* @param defaultValue The default value to be returned if the value to be converted is missing or an error occurs converting the value.
*/
public BigDecimalConverter(final BigDecimal defaultValue) {
super(true, defaultValue);
}
/**
* Constructs a java.math.BigDecimal Converter that returns a default value if an error occurs.
*
* @param defaultValue The default value to be returned if the value to be converted is missing or an error occurs converting the value.
*/
public BigDecimalConverter(final Number defaultValue) {
this(BigDecimal.valueOf(defaultValue.doubleValue()));
}
/**
* Gets the default type this {@code Converter} handles.
*
* @return The default type this {@code Converter} handles.
* @since 1.8.0
*/
@Override
protected Class getDefaultType() {
return BigDecimal.class;
}
}