SequoiaDB.Bson.BsonElement Class Reference

Represents a BSON element. More...

Inheritance diagram for SequoiaDB.Bson.BsonElement:

Public Member Functions
	BsonElement (string name, BsonValue value)
	Initializes a new instance of the BsonElement class.
BsonElement	Clone ()
	Creates a shallow clone of the element (see also DeepClone).
BsonElement	DeepClone ()
	Creates a deep clone of the element (see also Clone).
int	CompareTo (BsonElement other)
	Compares this BsonElement to another BsonElement.
bool	Equals (BsonElement rhs)
	Compares this BsonElement to another BsonElement.
override bool	Equals (object obj)
	Compares this BsonElement to another object.
override int	GetHashCode ()
	Gets the hash code.
override string	ToString ()
	Returns a string representation of the value.

Static Public Member Functions
static bool	operator== (BsonElement lhs, BsonElement rhs)
	Compares two BsonElements.
static bool	operator!= (BsonElement lhs, BsonElement rhs)
	Compares two BsonElements.
static BsonElement	Create (bool condition, string name, BsonValue value)
	Creates a new instance of the BsonElement class.
static BsonElement	Create (string name, BsonValue value)
	Creates a new instance of the BsonElement class.

Properties
string	Name [get]
	Gets the name of the element.
BsonValue	Value [get, set]
	Gets or sets the value of the element.

Detailed Description

Represents a BSON element.

Constructor & Destructor Documentation

SequoiaDB.Bson.BsonElement.BsonElement ( string  name, BsonValue  value  )

inline

Initializes a new instance of the BsonElement class.

Parameters

name	The name of the element.
value	The value of the element.

Member Function Documentation

BsonElement SequoiaDB.Bson.BsonElement.Clone ( )

inline

Creates a shallow clone of the element (see also DeepClone).

Returns

A shallow clone of the element.

int SequoiaDB.Bson.BsonElement.CompareTo ( BsonElement  other )

inline

Compares this BsonElement to another BsonElement.

Parameters

other

The other BsonElement.

Returns

A 32-bit signed integer that indicates whether this BsonElement is less than, equal to, or greather than the other.

static BsonElement SequoiaDB.Bson.BsonElement.Create ( bool  condition, string  name, BsonValue  value  )

inlinestatic

Creates a new instance of the BsonElement class.

Parameters

condition	Whether to create the BsonElement or return null.
name	The name of the element.
value	The value of the element.

Returns

A BsonElement or null.

static BsonElement SequoiaDB.Bson.BsonElement.Create ( string  name, BsonValue  value  )

inlinestatic

Creates a new instance of the BsonElement class.

Parameters

name	The name of the element.
value	The value of the element.

Returns

A BsonElement or null.

BsonElement SequoiaDB.Bson.BsonElement.DeepClone ( )

inline

Creates a deep clone of the element (see also Clone).

Returns

A deep clone of the element.

bool SequoiaDB.Bson.BsonElement.Equals ( BsonElement  rhs )

inline

Compares this BsonElement to another BsonElement.

Parameters

rhs	The other BsonElement.

Returns

True if the two BsonElement values are equal.

override bool SequoiaDB.Bson.BsonElement.Equals ( object  obj )

inline

Compares this BsonElement to another object.

Parameters

obj	The other object.

Returns

True if the other object is a BsonElement and equal to this one.

override int SequoiaDB.Bson.BsonElement.GetHashCode ( )

inline

Gets the hash code.

Returns

The hash code.

static bool SequoiaDB.Bson.BsonElement.operator!= ( BsonElement  lhs, BsonElement  rhs  )

inlinestatic

Compares two BsonElements.

Parameters

lhs	The first BsonElement.
rhs	The other BsonElement.

Returns

True if the two BsonElements are not equal (or one is null and the other is not).

static bool SequoiaDB.Bson.BsonElement.operator== ( BsonElement  lhs, BsonElement  rhs  )

inlinestatic

Compares two BsonElements.

Parameters

lhs	The first BsonElement.
rhs	The other BsonElement.

Returns

True if the two BsonElements are equal (or both null).

override string SequoiaDB.Bson.BsonElement.ToString ( )

inline

Returns a string representation of the value.

Returns

A string representation of the value.

Property Documentation

string SequoiaDB.Bson.BsonElement.Name

get

Gets the name of the element.

BsonValue SequoiaDB.Bson.BsonElement.Value

getset

Gets or sets the value of the element.

---

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

• BsonElement.cs