com.univocity.parsers.conversions.FormattedBigDecimalConversion Maven / Gradle / Ivy
Show all versions of univocity-parsers Show documentation
/*******************************************************************************
* Copyright 2014 Univocity Software Pty Ltd
*
* Licensed 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
*
* http://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 com.univocity.parsers.conversions;
import java.math.*;
import java.text.*;
/**
* Converts formatted Strings to instances of {@link java.math.BigDecimal} and vice versa.
*
* This class supports multiple numeric formats. For example, you can define conversions from numbers represented by different Strings such as "1,000,000.00 and $5.00".
*
The reverse conversion from a BigDecimal to String (in {@code revert(BigDecimal)} will return a formatted String using the pattern provided in this class constructor
*
The numeric patterns must follow the pattern rules of {@link java.text.DecimalFormat}
*
* @see java.text.DecimalFormat
*
* @author Univocity Software Pty Ltd - [email protected]
*
*/
public class FormattedBigDecimalConversion extends NumericConversion {
/**
* Defines a conversion from String to {@link java.math.BigDecimal} using a sequence of acceptable numeric patterns.
* This constructor assumes the output of a conversion should be null when input is null
* @param valueIfStringIsNull default BigDecimal to be returned when the input String is null. Used when {@link ObjectConversion#execute(String)} is invoked.
* @param valueIfObjectIsNull default String value to be returned when a BigDecimal input is null. Used when {@code revert(BigDecimal)} is invoked.
* @param numericFormats list of acceptable numeric patterns. The first pattern in this sequence will be used to convert a BigDecimal into a String in {@code revert(BigDecimal)}.
*/
public FormattedBigDecimalConversion(BigDecimal valueIfStringIsNull, String valueIfObjectIsNull, String... numericFormats) {
super(valueIfStringIsNull, valueIfObjectIsNull, numericFormats);
}
/**
* Defines a conversion from String to {@link java.math.BigDecimal} using a sequence of acceptable numeric patterns. The patterns
* must be added to this conversion class through the {@link #addFormat(String, String...)} method.
*
* @param valueIfStringIsNull default BigDecimal to be returned when the input String is null. Used when {@link ObjectConversion#execute(String)} is invoked.
* @param valueIfObjectIsNull default String value to be returned when a BigDecimal input is null. Used when {@link NumericConversion#revert(Number)} is invoked.
*/
public FormattedBigDecimalConversion(BigDecimal valueIfStringIsNull, String valueIfObjectIsNull) {
super(valueIfStringIsNull, valueIfObjectIsNull);
}
/**
* Defines a conversion from String to {@link java.math.BigDecimal} using a sequence of acceptable numeric patterns.
* This constructor assumes the output of a conversion should be null when input is null
* @param numericFormats list of acceptable numeric patterns. The first pattern in this sequence will be used to convert a BigDecimal into a String in {@link NumericConversion#revert(Number)}.
*/
public FormattedBigDecimalConversion(String... numericFormats) {
super(null, null, numericFormats);
}
/**
* Defines a conversion from String to{@link java.math.BigDecimal} using a sequence of acceptable numeric patterns.
* This constructor assumes the output of a conversion should be null when input is null
* @param numericFormatters list formatters of acceptable numeric patterns. The first formatter in this sequence will be used to convert a BigDecimal into a String in {@link NumericConversion#revert(Number)}.
*/
public FormattedBigDecimalConversion(DecimalFormat... numericFormatters) {
super(numericFormatters);
}
/**
* Defines a conversion from String to {@link java.math.BigDecimal} using a sequence of acceptable numeric patterns. The patterns
* must be added to this conversion class through the {@link #addFormat(String, String...)} method.
*
* This constructor assumes the output of a conversion should be null when input is null
*
*/
public FormattedBigDecimalConversion() {
super();
}
/**
* Configures the Decimal format instance created by the parent class to parse BigDecimals.
*/
@Override
protected void configureFormatter(DecimalFormat formatter) {
formatter.setParseBigDecimal(true);
}
}