An SQL object handling a single-byte value that represents the concept of boolean true and false. More...

Inheritance diagram for Deveel.Data.Sql.Objects.SqlBoolean:

Public Member Functions
	SqlBoolean (byte value)
	Constructs a given boolean object with a defined byte value. More...

	SqlBoolean (bool value)
	Constructs an object from a runtime boolean object. More...

int IComparable.	CompareTo (object obj)

void ISerializable.	GetData (SerializeData data)

int	CompareTo (ISqlObject other)

bool	IsComparableTo (ISqlObject other)
	Indicates if the given ISqlObject can be compared to this SqlBoolean. More...

override bool	Equals (object obj)

bool	Equals (SqlBoolean other)

SqlBoolean	Not ()

SqlBoolean	Or (SqlBoolean other)

SqlBoolean	And (SqlBoolean other)

SqlBoolean	XOr (SqlBoolean other)

override int	GetHashCode ()

TypeCode IConvertible.	GetTypeCode ()

bool IConvertible.	ToBoolean (IFormatProvider provider)

char IConvertible.	ToChar (IFormatProvider provider)

sbyte IConvertible.	ToSByte (IFormatProvider provider)

byte IConvertible.	ToByte (IFormatProvider provider)

short IConvertible.	ToInt16 (IFormatProvider provider)

ushort IConvertible.	ToUInt16 (IFormatProvider provider)

int IConvertible.	ToInt32 (IFormatProvider provider)

uint IConvertible.	ToUInt32 (IFormatProvider provider)

long IConvertible.	ToInt64 (IFormatProvider provider)

ulong IConvertible.	ToUInt64 (IFormatProvider provider)

float IConvertible.	ToSingle (IFormatProvider provider)

double IConvertible.	ToDouble (IFormatProvider provider)

decimal IConvertible.	ToDecimal (IFormatProvider provider)

DateTime IConvertible.	ToDateTime (IFormatProvider provider)

string IConvertible.	ToString (IFormatProvider provider)

object IConvertible.	ToType (Type conversionType, IFormatProvider provider)

int	CompareTo (SqlBoolean other)

override string	ToString ()

Static Public Member Functions
static SqlBoolean	operator== (SqlBoolean a, SqlBoolean b)
	Operates an equality check between the two SQL boolean objects. More...

static SqlBoolean	operator!= (SqlBoolean a, SqlBoolean b)
	Operates an inequality check between the two SQL booleans More...

static SqlBoolean	operator== (SqlBoolean a, ISqlObject b)

static SqlBoolean	operator!= (SqlBoolean a, ISqlObject b)

static SqlBoolean	operator& (SqlBoolean a, SqlBoolean b)

static SqlBoolean	operator\| (SqlBoolean a, SqlBoolean b)

static SqlBoolean	operator^ (SqlBoolean a, SqlBoolean b)

static SqlBoolean	operator! (SqlBoolean a)

static implicit	operator bool (SqlBoolean value)
	Implicitly converts the SQL boolean object to a native boolean. More...

static implicit	operator SqlBoolean (bool value)
	Implicitly converts a given native boolean to the SQL object equivalent. More...

static SqlBoolean	Parse (string s)
	Parses the given string to extract a boolean value equivalent. More...

static bool	TryParse (string s, out SqlBoolean value)
	Attempts to parse a given string to an instance of SqlBoolean. More...

Static Public Attributes
static readonly SqlBoolean	True = new SqlBoolean(1)
	Represents the materialization of a `true` boolean. More...

static readonly SqlBoolean	False = new SqlBoolean(0)
	Represents the materialization of a `false` boolean. More...

static readonly SqlBoolean	Null = new SqlBoolean((byte?)null)
	Defines a `null` boolean. More...

Properties
bool	IsNull `[get]`

Properties inherited from Deveel.Data.Sql.Objects.ISqlObject
bool	IsNull `[get]`
	Gets a boolean value indicating if the object is `NULL`. More...

Private Member Functions
	SqlBoolean (byte?value)

	SqlBoolean (ObjectData data)

Private Attributes
readonly byte	value

Detailed Description

An SQL object handling a single-byte value that represents the concept of boolean true and false.

On a byte level, this object handles only 0 or 1, that represents respectively the concepts of false and true.

Additionally, a boolean object can be represented as NULL, when the state cannot be determined.

Definition at line 35 of file SqlBoolean.cs.

Constructor & Destructor Documentation

Deveel.Data.Sql.Objects.SqlBoolean.SqlBoolean ( byte value )

inline

Constructs a given boolean object with a defined byte value.

Parameters

value The single byte representing the boolean.

Exceptions

ArgumentOutOfRangeException If the value specified is not equivalent to 0 or 1.

Definition at line 61 of file SqlBoolean.cs.

             : this() {
             if (value != 0 &&
                 value != 1)
                 throw new ArgumentOutOfRangeException("value");
 
             this.value = value;
         }

Deveel.Data.Sql.Objects.SqlBoolean.SqlBoolean ( bool value )

inline

Constructs an object from a runtime boolean object.

Parameters

value The native boolean value that represents the object.

Definition at line 74 of file SqlBoolean.cs.

75 : this((byte)(value ? 1 : 0)) {

76 }

Deveel.Data.Sql.Objects.SqlBoolean.value

readonly byte value

Definition: SqlBoolean.cs:36

Deveel.Data.Sql.Objects.SqlBoolean.SqlBoolean ( byte? value )

inlineprivate

Definition at line 78 of file SqlBoolean.cs.

             : this() {
             this.value = value;
         }

Deveel.Data.Sql.Objects.SqlBoolean.SqlBoolean ( ObjectData data )

inlineprivate

Definition at line 83 of file SqlBoolean.cs.

             : this() {
             if (data.HasValue("Value"))
                 value = data.GetByte("Value");
         }

Member Function Documentation

SqlBoolean Deveel.Data.Sql.Objects.SqlBoolean.And ( SqlBoolean other )

inline

Definition at line 207 of file SqlBoolean.cs.

                                                 {
             if (value == null ||
                 other.IsNull)
                 return Null;
 
             if (value == 1 && other.value == 1)
                 return True;
 
             return False;           
         }

int IComparable. Deveel.Data.Sql.Objects.SqlBoolean.CompareTo ( object obj )

inline

Definition at line 89 of file SqlBoolean.cs.

                                               {
             if (!(obj is ISqlObject))
                 throw new ArgumentException();
 
             return CompareTo((ISqlObject) obj);
         }

int Deveel.Data.Sql.Objects.SqlBoolean.CompareTo ( ISqlObject other )

inline

Definition at line 102 of file SqlBoolean.cs.

                                                {
             if (other is SqlNull) {
                 if (IsNull)
                     return 0;
                 return 1;
             }
 
             SqlBoolean otherBoolean;
             if (other is SqlNumber) {
                 var num = (SqlNumber) other;
                 if (num.IsNull) {
                     otherBoolean = Null;
                 } else if (num == SqlNumber.One) {
                     otherBoolean = True;
                 } else if (num == SqlNumber.Zero) {
                     otherBoolean = False;
                 } else {
                     throw new ArgumentOutOfRangeException("other", "The given numeric value is out of range for a comparison with SQL BOOLEAN.");
                 }
             } else if (other is SqlBoolean) {
                 otherBoolean = (SqlBoolean) other;
             } else {
                 throw new ArgumentException(String.Format("Object of type {0} cannot be compared to SQL BOOLEAN", other.GetType().FullName));
             }
 
             return CompareTo(otherBoolean);
         }

int Deveel.Data.Sql.Objects.SqlBoolean.CompareTo ( SqlBoolean other )

inline

Definition at line 314 of file SqlBoolean.cs.

                                                {
             if (other.IsNull && IsNull)
                 return 0;
 
             if (IsNull && !other.IsNull)
                 return -1;
             if (!IsNull && other.IsNull)
                 return 1;
 
             return value.Value.CompareTo(other.value.Value);
         }

override bool Deveel.Data.Sql.Objects.SqlBoolean.Equals ( object obj )

inline

Definition at line 162 of file SqlBoolean.cs.

                                                 {
             if (obj is SqlNull && IsNull)
                 return true;
 
             if (!(obj is SqlBoolean))
                 return false;
 
             return Equals((SqlBoolean) obj);
         }

bool Deveel.Data.Sql.Objects.SqlBoolean.Equals ( SqlBoolean other )

inline

Definition at line 173 of file SqlBoolean.cs.

                                              {
             if (IsNull && other.IsNull)
                 return true;
             if (IsNull && !other.IsNull)
                 return false;
             if (!IsNull && other.IsNull)
                 return false;
 
             return value.Equals(other.value);
         }

void ISerializable. Deveel.Data.Sql.Objects.SqlBoolean.GetData ( SerializeData data )

inline

Implements Deveel.Data.Serialization.ISerializable.

Definition at line 96 of file SqlBoolean.cs.

                                                        {
             if (value != null)
                 data.SetValue("Value", value.Value);
         }

override int Deveel.Data.Sql.Objects.SqlBoolean.GetHashCode ( )

inline

Definition at line 232 of file SqlBoolean.cs.

                                           {
             return value == null ? 0 : value.Value.GetHashCode();
         }

TypeCode IConvertible. Deveel.Data.Sql.Objects.SqlBoolean.GetTypeCode ( )

inline

Definition at line 236 of file SqlBoolean.cs.

                                             {
             return TypeCode.Boolean;
         }

bool Deveel.Data.Sql.Objects.SqlBoolean.IsComparableTo ( ISqlObject other )

inline

Indicates if the given ISqlObject can be compared to this SqlBoolean.

Parameters

other The other object to verifiy compatibility.

Comparable objects are SqlBoolean, SqlNull or SqlNumber with a value equals to SqlNumber.One, SqlNumber.Zero or SqlNumber.Null.

Returns: Returns true if the given object can be compared to this boolean instance, or false otherwise.

Implements Deveel.Data.Sql.Objects.ISqlObject.

Definition at line 149 of file SqlBoolean.cs.

                                                      {
             if (other is SqlBoolean || other is SqlNull)
                 return true;
 
             if (other is SqlNumber) {
                 var num = (SqlNumber) other;
                 return num == SqlNumber.Zero || num == SqlNumber.One;
             }
 
             return false;
         }

SqlBoolean Deveel.Data.Sql.Objects.SqlBoolean.Not ( )

inline

Definition at line 184 of file SqlBoolean.cs.

                                 {
             if (value == null)
                 return Null;
 
             if (value == 1)
                 return False;
             if (value == 0)
                 return True;
 
             throw new InvalidOperationException();
         }

static implicit Deveel.Data.Sql.Objects.SqlBoolean.operator bool ( SqlBoolean value )

inlinestatic

Implicitly converts the SQL boolean object to a native boolean.

Parameters

value The SQL boolean to convert.

Returns: Returns an instance of bool which is equivalent to this object.

Definition at line 380 of file SqlBoolean.cs.

                                                                {
             if (value.IsNull)
                 throw new InvalidCastException();
 
             return value.value == 1;
         }

static implicit Deveel.Data.Sql.Objects.SqlBoolean.operator SqlBoolean ( bool value )

inlinestatic

Implicitly converts a given native boolean to the SQL object equivalent.

Parameters

value The boolean value to convert.

Returns: Returns an instance of SqlBoolean that is equivalent to the boolean value given.

Definition at line 395 of file SqlBoolean.cs.

                                                                {
             return new SqlBoolean(value);
         }

static SqlBoolean Deveel.Data.Sql.Objects.SqlBoolean.operator! ( SqlBoolean a )

inlinestatic

Definition at line 368 of file SqlBoolean.cs.

                                                           {
             return a.Not();
         }

static SqlBoolean Deveel.Data.Sql.Objects.SqlBoolean.operator!=	(	SqlBoolean	a,
		SqlBoolean	b
	)

inlinestatic

Operates an inequality check between the two SQL booleans

Parameters

a	The left term of comparison.
b	The right term of comparison.

Returns

Definition at line 344 of file SqlBoolean.cs.

                                                                          {
             return !(a == b);
         }

static SqlBoolean Deveel.Data.Sql.Objects.SqlBoolean.operator!=	(	SqlBoolean	a,
		ISqlObject	b
	)

inlinestatic

Definition at line 352 of file SqlBoolean.cs.

                                                                          {
             return !(a == b);
         }

static SqlBoolean Deveel.Data.Sql.Objects.SqlBoolean.operator&	(	SqlBoolean	a,
		SqlBoolean	b
	)

inlinestatic

Definition at line 356 of file SqlBoolean.cs.

                                                                         {
             return a.And(b);
         }

static SqlBoolean Deveel.Data.Sql.Objects.SqlBoolean.operator==	(	SqlBoolean	a,
		SqlBoolean	b
	)

inlinestatic

Operates an equality check between the two SQL boolean objects.

Parameters

a	The left term of comparison.
b	The right term of comparison.

Returns

See also: Equals(SqlBoolean), Equals(object)

Definition at line 334 of file SqlBoolean.cs.

                                                                          {
             return a.Equals(b);
         }

static SqlBoolean Deveel.Data.Sql.Objects.SqlBoolean.operator==	(	SqlBoolean	a,
		ISqlObject	b
	)

inlinestatic

Definition at line 348 of file SqlBoolean.cs.

                                                                          {
             return a.Equals(b);
         }

static SqlBoolean Deveel.Data.Sql.Objects.SqlBoolean.operator^	(	SqlBoolean	a,
		SqlBoolean	b
	)

inlinestatic

Definition at line 364 of file SqlBoolean.cs.

                                                                         {
             return a.XOr(b);
         }

static SqlBoolean Deveel.Data.Sql.Objects.SqlBoolean.operator\|	(	SqlBoolean	a,
		SqlBoolean	b
	)

inlinestatic

Definition at line 360 of file SqlBoolean.cs.

                                                                         {
             return a.Or(b);
         }

SqlBoolean Deveel.Data.Sql.Objects.SqlBoolean.Or ( SqlBoolean other )

inline

Definition at line 196 of file SqlBoolean.cs.

                                                {
             if (value == null ||
                 other.IsNull)
                 return Null;
 
             if (value == 1 || other.value == 1)
                 return True;
 
             return False;
         }

static SqlBoolean Deveel.Data.Sql.Objects.SqlBoolean.Parse ( string s )

inlinestatic

Parses the given string to extract a boolean value equivalent.

Parameters

s	The string to parse.

Returns: Returns an instance of SqlBoolean as defined by the given string.

Exceptions

ArgumentNullException	If the string argument s is `null` or empty.
FormatException	If the given string argument cannot be parsed to a valid SQL boolean.

See also: TryParse

Definition at line 414 of file SqlBoolean.cs.

                                                  {
             if (String.IsNullOrEmpty(s))
                 throw new ArgumentNullException("s");
 
             SqlBoolean value;
             if (!TryParse(s, out value))
                 throw new FormatException();
 
             return value;
         }

bool IConvertible. Deveel.Data.Sql.Objects.SqlBoolean.ToBoolean ( IFormatProvider provider )

inline

Definition at line 240 of file SqlBoolean.cs.

                                                               {
             return this;
         }

byte IConvertible. Deveel.Data.Sql.Objects.SqlBoolean.ToByte ( IFormatProvider provider )

inline

Definition at line 252 of file SqlBoolean.cs.

                                                            {
             if (value == null)
                 throw new NullReferenceException();
 
             return value.Value;
         }

char IConvertible. Deveel.Data.Sql.Objects.SqlBoolean.ToChar ( IFormatProvider provider )

inline

Definition at line 244 of file SqlBoolean.cs.

                                                            {
             throw new InvalidCastException();
         }

DateTime IConvertible. Deveel.Data.Sql.Objects.SqlBoolean.ToDateTime ( IFormatProvider provider )

inline

Definition at line 298 of file SqlBoolean.cs.

                                                                    {
             throw new InvalidCastException();
         }

decimal IConvertible. Deveel.Data.Sql.Objects.SqlBoolean.ToDecimal ( IFormatProvider provider )

inline

Definition at line 294 of file SqlBoolean.cs.

                                                                  {
             return (this as IConvertible).ToInt32(provider);
         }

double IConvertible. Deveel.Data.Sql.Objects.SqlBoolean.ToDouble ( IFormatProvider provider )

inline

Definition at line 290 of file SqlBoolean.cs.

                                                                {
             return (this as IConvertible).ToInt32(provider);
         }

short IConvertible. Deveel.Data.Sql.Objects.SqlBoolean.ToInt16 ( IFormatProvider provider )

inline

Definition at line 259 of file SqlBoolean.cs.

                                                              {
             return (short) (this as IConvertible).ToInt32(provider);
         }

int IConvertible. Deveel.Data.Sql.Objects.SqlBoolean.ToInt32 ( IFormatProvider provider )

inline

Definition at line 267 of file SqlBoolean.cs.

                                                            {
             if (value == null)
                 throw new NullReferenceException();
 
             return value.Value;
         }

long IConvertible. Deveel.Data.Sql.Objects.SqlBoolean.ToInt64 ( IFormatProvider provider )

inline

Definition at line 278 of file SqlBoolean.cs.

                                                             {
             return (this as IConvertible).ToInt64(provider);
         }

sbyte IConvertible. Deveel.Data.Sql.Objects.SqlBoolean.ToSByte ( IFormatProvider provider )

inline

Definition at line 248 of file SqlBoolean.cs.

                                                              {
             return (sbyte) (this as IConvertible).ToInt32(provider);
         }

float IConvertible. Deveel.Data.Sql.Objects.SqlBoolean.ToSingle ( IFormatProvider provider )

inline

Definition at line 286 of file SqlBoolean.cs.

                                                               {
             return (this as IConvertible).ToInt32(provider);
         }

string IConvertible. Deveel.Data.Sql.Objects.SqlBoolean.ToString ( IFormatProvider provider )

inline

Definition at line 302 of file SqlBoolean.cs.

                                                                {
             return ToString();
         }

override string Deveel.Data.Sql.Objects.SqlBoolean.ToString ( )

inline

Definition at line 463 of file SqlBoolean.cs.

                                           {
             if (value == null)
                 return "NULL";
             if (value == 1)
                 return "true";
             if (value == 0)
                 return "false";
 
             throw new InvalidOperationException("Should never happen!");
         }

object IConvertible. Deveel.Data.Sql.Objects.SqlBoolean.ToType	(	Type	conversionType,
		IFormatProvider	provider
	)

inline

Definition at line 306 of file SqlBoolean.cs.

                                                                                   {
             if (conversionType == typeof (bool))
                 return (bool) this;
 
             throw new InvalidCastException(String.Format("Cannot convert a SQL BOOLEAN to {0}", conversionType.FullName));
         }

ushort IConvertible. Deveel.Data.Sql.Objects.SqlBoolean.ToUInt16 ( IFormatProvider provider )

inline

Definition at line 263 of file SqlBoolean.cs.

                                                                {
             return (ushort) (this as IConvertible).ToInt32(provider);
         }

uint IConvertible. Deveel.Data.Sql.Objects.SqlBoolean.ToUInt32 ( IFormatProvider provider )

inline

Definition at line 274 of file SqlBoolean.cs.

                                                              {
             return (uint) (this as IConvertible).ToInt32(provider);
         }

ulong IConvertible. Deveel.Data.Sql.Objects.SqlBoolean.ToUInt64 ( IFormatProvider provider )

inline

Definition at line 282 of file SqlBoolean.cs.

                                                               {
             return (this as IConvertible).ToUInt64(provider);
         }

static bool Deveel.Data.Sql.Objects.SqlBoolean.TryParse	(	string	s,
		out SqlBoolean	value
	)

inlinestatic

Attempts to parse a given string to an instance of SqlBoolean.

Parameters

s	The string to parse.
value	The output SqlBoolean that will be emitted if the given string represents a valid boolean.

A valid SQL boolean is either a numeric value, expressed by 1 or 0, or alternatively a string value expressed as true or false.

The case of the string is insensitive (as for general SQL syntax rule).

Returns: Returns true if the string passed is a valid SQL boolean and the value was set to a valid SqlBoolean, or false otherwise.

Definition at line 442 of file SqlBoolean.cs.

                                                                     {
             value = new SqlBoolean();
 
             if (String.IsNullOrEmpty(s))
                 return false;
 
             if (String.Equals(s, "true", StringComparison.OrdinalIgnoreCase) ||
                 String.Equals(s, "1")) {
                 value = True;
                 return true;
             }
             if (String.Equals(s, "false", StringComparison.OrdinalIgnoreCase) ||
                 String.Equals(s, "0")) {
                 value = False;
                 return true;
             }
 
             return false;
         }

SqlBoolean Deveel.Data.Sql.Objects.SqlBoolean.XOr ( SqlBoolean other )

inline

Definition at line 218 of file SqlBoolean.cs.

                                                 {
             if (value == null ||
                 other.IsNull)
                 return Null;
 
             if (value == 1 && other.value == 0)
                 return True;
             if (value == 0 && other.value == 1)
                 return True;
 
             return False;
         }

Member Data Documentation

readonly SqlBoolean Deveel.Data.Sql.Objects.SqlBoolean.False = new SqlBoolean(0)

static

Represents the materialization of a false boolean.

Definition at line 46 of file SqlBoolean.cs.

readonly SqlBoolean Deveel.Data.Sql.Objects.SqlBoolean.Null = new SqlBoolean((byte?)null)

static

Defines a null boolean.

Definition at line 51 of file SqlBoolean.cs.

readonly SqlBoolean Deveel.Data.Sql.Objects.SqlBoolean.True = new SqlBoolean(1)

static

Represents the materialization of a true boolean.

Definition at line 41 of file SqlBoolean.cs.

readonly byte Deveel.Data.Sql.Objects.SqlBoolean.value

private

Definition at line 36 of file SqlBoolean.cs.

Property Documentation

bool Deveel.Data.Sql.Objects.SqlBoolean.IsNull

get

Definition at line 131 of file SqlBoolean.cs.

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

/var/calculate/remote/distfiles/egit-src/deveeldb.git/src/deveeldb/Deveel.Data.Sql.Objects/SqlBoolean.cs

Public Member Functions

Static Public Member Functions

Static Public Attributes

Properties

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation