PipServices3.Commons.Convert.BooleanConverter Class Reference

Converts arbitrary values to boolean values using extended conversion rules: More...

Static Public Member Functions
static bool	ToNullableBoolean (object value)
	Converts value into boolean or returns null when conversion is not possible. More...
static bool	ToBoolean (object value)
	Converts value into boolean or returns false when conversion is not possible. More...
static bool	ToBooleanWithDefault (object value, bool defaultValue)
	Converts value into boolean or returns default value when conversion is not possible More...

Detailed Description

Converts arbitrary values to boolean values using extended conversion rules:

• Numbers: above 0, less more 0 are true; equal to 0 are false
• Strings: "true", "yes", "T", "Y", "1" are true, "false", "no", "F", "N" are false
• DateTime: above 0, less more 0 total milliseconds are true, equal to 0 are false

var value1 = BooleanConverter.ToNullableBoolean(true); // true
var value2 = BooleanConverter.ToNullableBoolean("yes"); // true
var value3 = BooleanConverter.ToNullableBoolean(1); // true
var value4 = BooleanConverter.ToNullableBoolean({}); // null

Member Function Documentation

ToBoolean()

static bool PipServices3.Commons.Convert.BooleanConverter.ToBoolean ( object  value )

static

Converts value into boolean or returns false when conversion is not possible.

Parameters

value

the value to convert.

Returns

boolean value or false when conversion is not supported.

See BooleanConverter.ToNullableBoolean(object)

ToBooleanWithDefault()

static bool PipServices3.Commons.Convert.BooleanConverter.ToBooleanWithDefault ( object  value, bool  defaultValue  )

static

Converts value into boolean or returns default value when conversion is not possible

Parameters

value	the value to convert.
defaultValue	the default value

Returns

boolean value or default when conversion is not supported.

See BooleanConverter.ToNullableBoolean(object)

ToNullableBoolean()

static bool PipServices3.Commons.Convert.BooleanConverter.ToNullableBoolean ( object  value )

static

Converts value into boolean or returns null when conversion is not possible.

Parameters

value

the value to convert.

Returns

boolean value or null when conversion is not supported.

---

The documentation for this class was generated from the following file:

• src/Convert/BooleanConverter.cs