Class Conversions
- java.lang.Object
-
- com.univocity.parsers.conversions.Conversions
-
public class Conversions extends java.lang.Object
This class provides default instances of common implementations ifcom.univocity.parsers.conversions.Conversion
, as well as useful methods for obtaining new instances of these.- Author:
- uniVocity Software Pty Ltd - parsers@univocity.com
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static FormattedBigDecimalConversion
formatToBigDecimal(java.lang.String... numberFormats)
Returns a new instance ofFormattedBigDecimalConversion
static FormattedBigDecimalConversion
formatToBigDecimal(java.math.BigDecimal defaultValueForNullString, java.lang.String... numberFormats)
Returns a new instance ofFormattedBigDecimalConversion
static FormattedBigDecimalConversion
formatToBigDecimal(java.math.BigDecimal defaultValueForNullString, java.lang.String stringIfNull, java.lang.String... numberFormats)
Returns a new instance ofFormattedBigDecimalConversion
static <T extends java.lang.Number>
NumericConversion<T>formatToNumber(java.lang.Class<T> numberType, java.lang.String... numberFormats)
Returns a new instance ofNumericConversion
static NumericConversion<java.lang.Number>
formatToNumber(java.lang.String... numberFormats)
Returns a new instance ofNumericConversion
static RegexConversion
replace(java.lang.String replaceRegex, java.lang.String replacement)
Returns a new instance ofRegexConversion
static ToStringConversion
string()
Returns a singleton instance ofToStringConversion
static BigDecimalConversion
toBigDecimal()
Returns a new instance ofBigDecimalConversion
static BigIntegerConversion
toBigInteger()
Returns a new instance ofBigIntegerConversion
static BooleanConversion
toBoolean()
Returns a new instance ofBooleanConversion
that converts the string "true" to true, and the String "false" to false.static BooleanConversion
toBoolean(java.lang.Boolean defaultValueForNullString, java.lang.String defaultValueForNullBoolean, java.lang.String[] valuesForTrue, java.lang.String[] valuesForFalse)
Returns a new instance ofBooleanConversion
static BooleanConversion
toBoolean(java.lang.Boolean defaultValueForNullString, java.lang.String defaultValueForNullBoolean, java.lang.String valueForTrue, java.lang.String valueForFalse)
Returns a new instance ofBooleanConversion
static BooleanConversion
toBoolean(java.lang.String[] valuesForTrue, java.lang.String[] valuesForFalse)
Returns a new instance ofBooleanConversion
static BooleanConversion
toBoolean(java.lang.String valueForTrue, java.lang.String valueForFalse)
Returns a new instance ofBooleanConversion
static ByteConversion
toByte()
Returns a new instance ofByteConversion
static CalendarConversion
toCalendar(java.lang.String... dateFormats)
Returns a new instance ofCalendarConversion
static CalendarConversion
toCalendar(java.util.Calendar dateIfNull, java.lang.String... dateFormats)
Returns a new instance ofCalendarConversion
static CalendarConversion
toCalendar(java.util.Calendar dateIfNull, java.lang.String stringIfNull, java.lang.String... dateFormats)
Returns a new instance ofCalendarConversion
static CharacterConversion
toChar()
Returns a new instance ofCharacterConversion
static CharacterConversion
toChar(java.lang.Character defaultValueForNullString)
Returns a new instance ofCharacterConversion
static CharacterConversion
toChar(java.lang.Character defaultValueForNullString, java.lang.String defaultValueForNullChar)
Returns a new instance ofCharacterConversion
static DateConversion
toDate(java.lang.String... dateFormats)
Returns a new instance ofDateConversion
static DateConversion
toDate(java.util.Date dateIfNull, java.lang.String... dateFormats)
Returns a new instance ofDateConversion
static DateConversion
toDate(java.util.Date dateIfNull, java.lang.String stringIfNull, java.lang.String... dateFormats)
Returns a new instance ofDateConversion
static DoubleConversion
toDouble()
Returns a new instance ofDoubleConversion
static <T extends java.lang.Enum<T>>
EnumConversion<T>toEnum(java.lang.Class<T> enumType)
Returns a new instance ofEnumConversion
static <T extends java.lang.Enum<T>>
EnumConversion<T>toEnum(java.lang.Class<T> enumType, EnumSelector... selectors)
Returns a new instance ofEnumConversion
static <T extends java.lang.Enum<T>>
EnumConversion<T>toEnum(java.lang.Class<T> enumType, java.lang.String customEnumElement, EnumSelector... selectors)
Returns a new instance ofEnumConversion
static <T extends java.lang.Enum<T>>
EnumConversion<T>toEnum(java.lang.Class<T> enumType, T valueIfStringIsNull, java.lang.String valueIfEnumIsNull, java.lang.String customEnumElement, EnumSelector... selectors)
Returns a new instance ofEnumConversion
static FloatConversion
toFloat()
Returns a new instance ofFloatConversion
static IntegerConversion
toInteger()
Returns a new instance ofIntegerConversion
static LongConversion
toLong()
Returns a new instance ofLongConversion
static LowerCaseConversion
toLowerCase()
Returns a singleton instance ofLowerCaseConversion
static NullStringConversion
toNull(java.lang.String... nullRepresentations)
Returns a new instance ofNullStringConversion
static ShortConversion
toShort()
Returns a new instance ofShortConversion
static UpperCaseConversion
toUpperCase()
Returns a singleton instance ofUpperCaseConversion
static TrimConversion
trim()
Returns a singleton instance ofTrimConversion
static TrimConversion
trim(int length)
Returns aTrimConversion
that limits the output to a fixed length
-
-
-
Method Detail
-
string
public static ToStringConversion string()
Returns a singleton instance ofToStringConversion
- Returns:
- a singleton instance of
ToStringConversion
-
toUpperCase
public static UpperCaseConversion toUpperCase()
Returns a singleton instance ofUpperCaseConversion
- Returns:
- a singleton instance of
UpperCaseConversion
-
toLowerCase
public static LowerCaseConversion toLowerCase()
Returns a singleton instance ofLowerCaseConversion
- Returns:
- a singleton instance of
LowerCaseConversion
-
trim
public static TrimConversion trim()
Returns a singleton instance ofTrimConversion
- Returns:
- a singleton instance of
TrimConversion
-
trim
public static TrimConversion trim(int length)
Returns aTrimConversion
that limits the output to a fixed length- Parameters:
length
- the maximum length a value can contain. Characters after this limit will be discarded.- Returns:
- a trim-to-length conversion
-
replace
public static RegexConversion replace(java.lang.String replaceRegex, java.lang.String replacement)
Returns a new instance ofRegexConversion
- Parameters:
replaceRegex
- the regular expression used to match contents of a given input Stringreplacement
- the replacement content to replace any contents matched by the given regular expression- Returns:
- the new instance of
RegexConversion
created with the given parameters.
-
toNull
public static NullStringConversion toNull(java.lang.String... nullRepresentations)
Returns a new instance ofNullStringConversion
- Parameters:
nullRepresentations
- the sequence of Strings that represent a null value.- Returns:
- the new instance of
NullStringConversion
created with the given parameters.
-
toDate
public static DateConversion toDate(java.lang.String... dateFormats)
Returns a new instance ofDateConversion
- Parameters:
dateFormats
- list of acceptable date patterns. The first pattern in this sequence will be used to convert a Date into a String inDateConversion.revert(Date)
.- Returns:
- the new instance of
DateConversion
created with the given parameters.
-
toDate
public static DateConversion toDate(java.util.Date dateIfNull, java.lang.String... dateFormats)
Returns a new instance ofDateConversion
- Parameters:
dateIfNull
- default Date value to be returned when the input String is null. Used whenObjectConversion.execute(String)
is invoked.dateFormats
- list of acceptable date patterns. The first pattern in this sequence will be used to convert a Date into a String inDateConversion.revert(Date)
.- Returns:
- the new instance of
DateConversion
created with the given parameters.
-
toDate
public static DateConversion toDate(java.util.Date dateIfNull, java.lang.String stringIfNull, java.lang.String... dateFormats)
Returns a new instance ofDateConversion
- Parameters:
dateIfNull
- default Date value to be returned when the input String is null. Used whenObjectConversion.execute(String)
is invoked.stringIfNull
- default String value to be returned when a Date input is null. Used whenDateConversion.revert(Date)
is invoked.dateFormats
- list of acceptable date patterns. The first pattern in this sequence will be used to convert a Date into a String inDateConversion.revert(Date)
.- Returns:
- the new instance of
DateConversion
created with the given parameters.
-
toCalendar
public static CalendarConversion toCalendar(java.lang.String... dateFormats)
Returns a new instance ofCalendarConversion
- Parameters:
dateFormats
- list of acceptable date patterns. The first pattern in this sequence will be used to convert a Calendar into a String inCalendarConversion.revert(Calendar)
.- Returns:
- the new instance of
CalendarConversion
created with the given parameters.
-
toCalendar
public static CalendarConversion toCalendar(java.util.Calendar dateIfNull, java.lang.String... dateFormats)
Returns a new instance ofCalendarConversion
- Parameters:
dateIfNull
- default Calendar value to be returned when the input String is null. Used whenObjectConversion.execute(String)
is invoked.dateFormats
- list of acceptable date patterns. The first pattern in this sequence will be used to convert a Calendar into a String inCalendarConversion.revert(Calendar)
.- Returns:
- the new instance of
CalendarConversion
created with the given parameters.
-
toCalendar
public static CalendarConversion toCalendar(java.util.Calendar dateIfNull, java.lang.String stringIfNull, java.lang.String... dateFormats)
Returns a new instance ofCalendarConversion
- Parameters:
dateIfNull
- default Calendar value to be returned when the input String is null. Used whenObjectConversion.execute(String)
is invoked.stringIfNull
- default String value to be returned when a Date input is null. Used whenCalendarConversion.revert(Calendar)
is invoked.dateFormats
- list of acceptable date patterns. The first pattern in this sequence will be used to convert a Calendar into a String inCalendarConversion.revert(Calendar)
.- Returns:
- the new instance of
CalendarConversion
created with the given parameters.
-
toByte
public static ByteConversion toByte()
Returns a new instance ofByteConversion
- Returns:
- a new instance of
ByteConversion
-
toShort
public static ShortConversion toShort()
Returns a new instance ofShortConversion
- Returns:
- a new instance of
ShortConversion
-
toInteger
public static IntegerConversion toInteger()
Returns a new instance ofIntegerConversion
- Returns:
- a new instance of
IntegerConversion
-
toLong
public static LongConversion toLong()
Returns a new instance ofLongConversion
- Returns:
- a new instance of
LongConversion
-
toBigInteger
public static BigIntegerConversion toBigInteger()
Returns a new instance ofBigIntegerConversion
- Returns:
- a new instance of
BigIntegerConversion
-
toFloat
public static FloatConversion toFloat()
Returns a new instance ofFloatConversion
- Returns:
- a new instance of
FloatConversion
-
toDouble
public static DoubleConversion toDouble()
Returns a new instance ofDoubleConversion
- Returns:
- a new instance of
DoubleConversion
-
toBigDecimal
public static BigDecimalConversion toBigDecimal()
Returns a new instance ofBigDecimalConversion
- Returns:
- a new instance of
BigDecimalConversion
-
formatToNumber
public static NumericConversion<java.lang.Number> formatToNumber(java.lang.String... numberFormats)
Returns a new instance ofNumericConversion
- Parameters:
numberFormats
- list of acceptable numeric patterns. The first pattern in this sequence will be used to convert a Number into a String inNumericConversion.revert(Number)
.- Returns:
- a new instance of
NumericConversion
that supports the given number formats
-
formatToNumber
public static <T extends java.lang.Number> NumericConversion<T> formatToNumber(java.lang.Class<T> numberType, java.lang.String... numberFormats)
Returns a new instance ofNumericConversion
- Type Parameters:
T
- type of number- Parameters:
numberType
- type of number to be returned. The resulting instance ofNumber
will be cast to the expected type.numberFormats
- list of acceptable numeric patterns. The first pattern in this sequence will be used to convert a Number into a String inNumericConversion.revert(Number)
.- Returns:
- a new instance of
NumericConversion
that supports the given number formats
-
formatToBigDecimal
public static FormattedBigDecimalConversion formatToBigDecimal(java.lang.String... numberFormats)
Returns a new instance ofFormattedBigDecimalConversion
- Parameters:
numberFormats
- list of acceptable numeric patterns. The first pattern in this sequence will be used to convert a BigDecimal into a String inNumericConversion.revert(Number)
.- Returns:
- a new instance of
FormattedBigDecimalConversion
that supports the given number formats
-
formatToBigDecimal
public static FormattedBigDecimalConversion formatToBigDecimal(java.math.BigDecimal defaultValueForNullString, java.lang.String... numberFormats)
Returns a new instance ofFormattedBigDecimalConversion
- Parameters:
defaultValueForNullString
- default BigDecimal to be returned when the input String is null. Used whenObjectConversion.execute(String)
is invoked.numberFormats
- list of acceptable numeric patterns. The first pattern in this sequence will be used to convert a BigDecimal into a String inNumericConversion.revert(Number)
.- Returns:
- a new instance of
FormattedBigDecimalConversion
that supports the given number formats
-
formatToBigDecimal
public static FormattedBigDecimalConversion formatToBigDecimal(java.math.BigDecimal defaultValueForNullString, java.lang.String stringIfNull, java.lang.String... numberFormats)
Returns a new instance ofFormattedBigDecimalConversion
- Parameters:
defaultValueForNullString
- default BigDecimal to be returned when the input String is null. Used whenObjectConversion.execute(String)
is invoked.stringIfNull
- default String value to be returned when a BigDecimal input is null. Used whenFormattedBigDecimalConversion#revert(BigDecimal)
is invoked.numberFormats
- list of acceptable numeric patterns. The first pattern in this sequence will be used to convert a BigDecimal into a String inNumericConversion.revert(Number)
.- Returns:
- a new instance of
FormattedBigDecimalConversion
that supports the given number formats
-
toBoolean
public static BooleanConversion toBoolean(java.lang.Boolean defaultValueForNullString, java.lang.String defaultValueForNullBoolean, java.lang.String[] valuesForTrue, java.lang.String[] valuesForFalse)
Returns a new instance ofBooleanConversion
- Parameters:
defaultValueForNullString
- default Boolean value to be returned when the input String is null. Used whenObjectConversion.execute(String)
is invoked.defaultValueForNullBoolean
- default String value to be returned when a Boolean input is null. Used whenBooleanConversion.revert(Boolean)
is invoked.valuesForTrue
- Strings that identify the boolean value true. The first element will be returned when executingBooleanConversion.revert(true)
valuesForFalse
- Strings that identify the boolean value false. The first element will be returned when executingBooleanConversion.revert(false)
- Returns:
- a new instance of
BooleanConversion
with support for multiple representations of true and false
-
toBoolean
public static BooleanConversion toBoolean(java.lang.Boolean defaultValueForNullString, java.lang.String defaultValueForNullBoolean, java.lang.String valueForTrue, java.lang.String valueForFalse)
Returns a new instance ofBooleanConversion
- Parameters:
defaultValueForNullString
- default Boolean value to be returned when the input String is null. Used whenObjectConversion.execute(String)
is invoked.defaultValueForNullBoolean
- default String value to be returned when a Boolean input is null. Used whenBooleanConversion.revert(Boolean)
is invoked.valueForTrue
- String that identify the boolean value true.valueForFalse
- String that identify the boolean value false.- Returns:
- a new instance of
BooleanConversion
with support for multiple representations of true and false
-
toBoolean
public static BooleanConversion toBoolean(java.lang.String[] valuesForTrue, java.lang.String[] valuesForFalse)
Returns a new instance ofBooleanConversion
- Parameters:
valuesForTrue
- Strings that identify the boolean value true. The first element will be returned when executingBooleanConversion.revert(true)
valuesForFalse
- Strings that identify the boolean value false. The first element will be returned when executingBooleanConversion.revert(false)
- Returns:
- a new instance of
BooleanConversion
with support for multiple representations of true and false
-
toBoolean
public static BooleanConversion toBoolean()
Returns a new instance ofBooleanConversion
that converts the string "true" to true, and the String "false" to false.- Returns:
- a new instance of
BooleanConversion
with support for multiple representations of true and false
-
toBoolean
public static BooleanConversion toBoolean(java.lang.String valueForTrue, java.lang.String valueForFalse)
Returns a new instance ofBooleanConversion
- Parameters:
valueForTrue
- String that identifies the boolean value true.valueForFalse
- String that identifies the boolean value false.- Returns:
- a new instance of
BooleanConversion
with support for multiple representations of true and false
-
toChar
public static CharacterConversion toChar()
Returns a new instance ofCharacterConversion
- Returns:
- a new instance of
CharacterConversion
-
toChar
public static CharacterConversion toChar(java.lang.Character defaultValueForNullString, java.lang.String defaultValueForNullChar)
Returns a new instance ofCharacterConversion
- Parameters:
defaultValueForNullString
- default Character value to be returned when the input String is null. Used whenObjectConversion.execute(String)
is invoked.defaultValueForNullChar
- default String value to be returned when a Character input is null. Used whenCharacterConversion#revert(Character)
is invoked.- Returns:
- a new instance of
CharacterConversion
-
toChar
public static CharacterConversion toChar(java.lang.Character defaultValueForNullString)
Returns a new instance ofCharacterConversion
- Parameters:
defaultValueForNullString
- default Character value to be returned when the input String is null. Used whenObjectConversion.execute(String)
is invoked.- Returns:
- a new instance of
CharacterConversion
-
toEnum
public static <T extends java.lang.Enum<T>> EnumConversion<T> toEnum(java.lang.Class<T> enumType)
Returns a new instance ofEnumConversion
- Type Parameters:
T
- theenum
type- Parameters:
enumType
- the enumeration type to be converted from/toString
- Returns:
- new instance of
EnumConversion
-
toEnum
public static <T extends java.lang.Enum<T>> EnumConversion<T> toEnum(java.lang.Class<T> enumType, EnumSelector... selectors)
Returns a new instance ofEnumConversion
- Type Parameters:
T
- theenum
type- Parameters:
enumType
- the enumeration type to be converted from/toString
selectors
- the selection elements of the enumeration to use for matchingString
s.- Returns:
- new instance of
EnumConversion
-
toEnum
public static <T extends java.lang.Enum<T>> EnumConversion<T> toEnum(java.lang.Class<T> enumType, java.lang.String customEnumElement, EnumSelector... selectors)
Returns a new instance ofEnumConversion
- Type Parameters:
T
- theenum
type- Parameters:
enumType
- the enumeration type to be converted from/toString
customEnumElement
- name of custom element of the enumeration (attribute or method) whose values should be used to match equivalentString
s.selectors
- the selection elements of the enumeration to use for matchingString
s.- Returns:
- new instance of
EnumConversion
-
toEnum
public static <T extends java.lang.Enum<T>> EnumConversion<T> toEnum(java.lang.Class<T> enumType, T valueIfStringIsNull, java.lang.String valueIfEnumIsNull, java.lang.String customEnumElement, EnumSelector... selectors)
Returns a new instance ofEnumConversion
- Type Parameters:
T
- theenum
type- Parameters:
enumType
- the enumeration type to be converted from/toString
valueIfStringIsNull
- the default enumeration constant to use if the inputString
isnull
valueIfEnumIsNull
- the defaultString
value to use if the inputenum
constant isnull
customEnumElement
- name of custom element of the enumeration (attribute or method) whose values should be used to match equivalentString
s.selectors
- the selection elements of the enumeration to use for matchingString
s.- Returns:
- new instance of
EnumConversion
-
-