Class BooleanConversion
java.lang.Object
com.univocity.parsers.conversions.NullConversion<String,T>
com.univocity.parsers.conversions.ObjectConversion<Boolean>
com.univocity.parsers.conversions.BooleanConversion
- All Implemented Interfaces:
Conversion<String,
Boolean>
Converts Strings to Booleans and vice versa
This class supports multiple representations of boolean values. For example, you can define conversions from different Strings such as "Yes, Y, 1" to true, and "No, N, 0" to false.
The reverse conversion from a Boolean to String (in revert(Boolean)
will return the first String provided in this class constructor
Using the previous example, a call to revert(true)
will produce "Yes" and a call revert(false)
will produce "No".
- Author:
- Univocity Software Pty Ltd - parsers@univocity.com
-
Constructor Summary
ConstructorsConstructorDescriptionBooleanConversion
(Boolean valueIfStringIsNull, String valueIfObjectIsNull, String[] valuesForTrue, String[] valuesForFalse) Creates a Conversion from String to Boolean with default values to return when the input is null.BooleanConversion
(String[] valuesForTrue, String[] valuesForFalse) Creates conversions from String to Boolean. -
Method Summary
Modifier and TypeMethodDescriptionprotected Boolean
fromString
(String input) Converts a String to a Booleanstatic Boolean
getBoolean
(String booleanString, String[] trueValues, String[] falseValues) Returns theBoolean
value represented by aString
, as defined by sets of Strings that representtrue
andfalse
values.Converts a Boolean back to a StringMethods inherited from class com.univocity.parsers.conversions.ObjectConversion
execute, fromInput, getValueIfObjectIsNull, getValueIfStringIsNull, setValueIfObjectIsNull, setValueIfStringIsNull, undo
Methods inherited from class com.univocity.parsers.conversions.NullConversion
getValueOnNullInput, getValueOnNullOutput, setValueOnNullInput, setValueOnNullOutput
-
Constructor Details
-
BooleanConversion
Creates conversions from String to Boolean. This default constructor assumes the output of a conversion should be null when input is nullThe list of Strings that identify "true" the list of Strings that identify "false" are mandatory.
- Parameters:
valuesForTrue
- Strings that identify the boolean value true. The first element will be returned when executingrevert(true)
valuesForFalse
- Strings that identify the boolean value false. The first element will be returned when executing#revert(false)
-
BooleanConversion
public BooleanConversion(Boolean valueIfStringIsNull, String valueIfObjectIsNull, String[] valuesForTrue, String[] valuesForFalse) Creates a Conversion from String to Boolean with default values to return when the input is null.The list of Strings that identify "true" the list of Strings that identify "false" are mandatory.
- Parameters:
valueIfStringIsNull
- default Boolean value to be returned when the input String is null. Used whenObjectConversion.execute(String)
is invoked.valueIfObjectIsNull
- default String value to be returned when a Boolean input is null. Used whenrevert(Boolean)
is invoked.valuesForTrue
- Strings that identify the boolean value true. The first element will be returned when executingrevert(true)
valuesForFalse
- Strings that identify the boolean value false. The first element will be returned when executing#revert(false)
-
-
Method Details
-
revert
Converts a Boolean back to a StringThe return value depends on the list of values for true/false provided in the constructor of this class.
- Specified by:
revert
in interfaceConversion<String,
Boolean> - Overrides:
revert
in classObjectConversion<Boolean>
- Parameters:
input
- the Boolean to be converted to a String- Returns:
- a String representation for this boolean value, or the value of
ObjectConversion.getValueIfObjectIsNull()
if the Boolean input is null.
-
fromString
Converts a String to a Boolean- Specified by:
fromString
in classObjectConversion<Boolean>
- Parameters:
input
- a String to be converted into a Boolean value.- Returns:
- true if the input String is part of
trueValues
, false if the input String is part offalseValues
, orObjectConversion.getValueIfStringIsNull()
if the input String is null.
-
getBoolean
Returns theBoolean
value represented by aString
, as defined by sets of Strings that representtrue
andfalse
values.- Parameters:
booleanString
- the value that represents eithertrue
orfalse
trueValues
- a set of possible string values that representtrue
. If empty, then "true" will be assumed as the only acceptable representation.falseValues
- a set of possible string values that representfalse
. If empty, then "false" will be assumed as the only acceptable representation.- Returns:
- the boolean value that the input string represents
- Throws:
DataProcessingException
- if the input string does not match any value provided in neither set of possible values.
-