SequoiaDB
 All Classes Namespaces Files Functions Variables Enumerations Properties Pages
Public Member Functions | Static Public Member Functions | List of all members
SequoiaDB.Bson.BsonDocumentWrapper Class Reference

Represents a BsonDocument wrapper. More...

Inheritance diagram for SequoiaDB.Bson.BsonDocumentWrapper:
SequoiaDB.Bson.BsonValue

Public Member Functions

 BsonDocumentWrapper (object wrappedObject)
 Initializes a new instance of the BsonDocumentWrapper class.
 
 BsonDocumentWrapper (Type wrappedNominalType, object wrappedObject)
 Initializes a new instance of the BsonDocumentWrapper class.
 
 BsonDocumentWrapper (Type wrappedNominalType, object wrappedObject, bool isUpdateDocument)
 Initializes a new instance of the BsonDocumentWrapper class.
 
override int CompareTo (BsonValue other)
 CompareTo is an invalid operation for BsonDocumentWrapper.
 
object Deserialize (BsonReader bsonReader, Type nominalType, IBsonSerializationOptions options)
 Deserialize is an invalid operation for BsonDocumentWrapper.
 
bool GetDocumentId (out object id, out Type idNominalType, out IIdGenerator idGenerator)
 GetDocumentId is an invalid operation for BsonDocumentWrapper.
 
override bool Equals (object obj)
 Equals is an invalid operation for BsonDocumentWrapper.
 
override int GetHashCode ()
 GetHashCode is an invalid operation for BsonDocumentWrapper.
 
void Serialize (BsonWriter bsonWriter, Type nominalType, IBsonSerializationOptions options)
 Serializes the wrapped object to a BsonWriter.
 
void SetDocumentId (object Id)
 SetDocumentId is an invalid operation for BsonDocumentWrapper.
 
override string ToString ()
 Returns a string representation of the wrapped document.
 
- Public Member Functions inherited from SequoiaDB.Bson.BsonValue
virtual BsonValue Clone ()
 Creates a shallow clone of the BsonValue (see also DeepClone).
 
int CompareTypeTo (BsonValue other)
 Compares the type of this BsonValue to the type of another BsonValue.
 
virtual BsonValue DeepClone ()
 Creates a deep clone of the BsonValue (see also Clone).
 
bool Equals (BsonValue rhs)
 Compares this BsonValue to another BsonValue.
 
override bool Equals (object obj)
 Compares this BsonValue to another object.
 
override int GetHashCode ()
 Gets the hash code.
 
bool ToBoolean ()
 Converts this BsonValue to a Boolean (using the JavaScript definition of truthiness).
 
double ToDouble ()
 Converts this BsonValue to a Double.
 
int ToInt32 ()
 Converts this BsonValue to an Int32.
 
long ToInt64 ()
 Converts this BsonValue to an Int64.
 
void WriteTo (BsonWriter bsonWriter)
 Writes the BsonValue to a BsonWriter.
 

Static Public Member Functions

static BsonDocumentWrapper Create< TNominalType > (TNominalType value)
 Creates a new instance of the BsonDocumentWrapper class.
 
static BsonDocumentWrapper Create< TNominalType > (TNominalType value, bool isUpdateDocument)
 Creates a new instance of the BsonDocumentWrapper class.
 
static BsonDocumentWrapper Create (Type nominalType, object value)
 Creates a new instance of the BsonDocumentWrapper class.
 
static BsonDocumentWrapper Create (Type nominalType, object value, bool isUpdateDocument)
 Creates a new instance of the BsonDocumentWrapper class.
 
static IEnumerable
< BsonDocumentWrapper
CreateMultiple< TNominalType > (IEnumerable< TNominalType > values)
 Creates a list of new instances of the BsonDocumentWrapper class.
 
static IEnumerable
< BsonDocumentWrapper
CreateMultiple (Type nominalType, IEnumerable values)
 Creates a list of new instances of the BsonDocumentWrapper class.
 
- Static Public Member Functions inherited from SequoiaDB.Bson.BsonValue
static operator bool (BsonValue value)
 Casts a BsonValue to a bool.
 
static operator bool? (BsonValue value)
 Casts a BsonValue to a bool?.
 
static implicit operator BsonValue (bool value)
 Converts a bool to a BsonValue.
 
static implicit operator BsonValue (bool?value)
 Converts a bool? to a BsonValue.
 
static implicit operator BsonValue (byte[] value)
 Converts a byte[] to a BsonValue.
 
static implicit operator BsonValue (DateTime value)
 Converts a DateTime to a BsonValue.
 
static implicit operator BsonValue (DateTime?value)
 Converts a DateTime? to a BsonValue.
 
static implicit operator BsonValue (double value)
 Converts a double to a BsonValue.
 
static implicit operator BsonValue (double?value)
 Converts a double? to a BsonValue.
 
static implicit operator BsonValue (Enum value)
 Converts an Enum to a BsonValue.
 
static implicit operator BsonValue (Guid value)
 Converts a Guid to a BsonValue.
 
static implicit operator BsonValue (Guid?value)
 Converts a Guid? to a BsonValue.
 
static implicit operator BsonValue (int value)
 Converts an int to a BsonValue.
 
static implicit operator BsonValue (int?value)
 Converts an int? to a BsonValue.
 
static implicit operator BsonValue (long value)
 Converts a long to a BsonValue.
 
static implicit operator BsonValue (long?value)
 Converts a long? to a BsonValue.
 
static implicit operator BsonValue (decimal value)
 Converts a decimal to a BsonValue.
 
static implicit operator BsonValue (decimal?value)
 Converts a decimal? to a BsonValue.
 
static implicit operator BsonValue (ObjectId value)
 Converts an ObjectId to a BsonValue.
 
static implicit operator BsonValue (ObjectId?value)
 Converts an ObjectId? to a BsonValue.
 
static implicit operator BsonValue (Regex value)
 Converts a Regex to a BsonValue.
 
static implicit operator BsonValue (string value)
 Converts a string to a BsonValue.
 
static operator byte[] (BsonValue value)
 Casts a BsonValue to a byte[].
 
static operator DateTime (BsonValue value)
 Casts a BsonValue to a DateTime.
 
static operator DateTime? (BsonValue value)
 Casts a BsonValue to a DateTime?.
 
static operator double (BsonValue value)
 Casts a BsonValue to a double.
 
static operator double? (BsonValue value)
 Casts a BsonValue to a double?.
 
static operator Guid (BsonValue value)
 Casts a BsonValue to a Guid.
 
static operator Guid? (BsonValue value)
 Casts a BsonValue to a Guid?.
 
static operator int (BsonValue value)
 Casts a BsonValue to an int.
 
static operator int? (BsonValue value)
 Casts a BsonValue to an int?.
 
static operator long (BsonValue value)
 Casts a BsonValue to a long.
 
static operator long? (BsonValue value)
 Casts a BsonValue to a long?.
 
static operator decimal (BsonValue value)
 Casts a BsonValue to a decimal.
 
static operator decimal? (BsonValue value)
 Casts a BsonValue to a decimal?.
 
static operator ObjectId (BsonValue value)
 Casts a BsonValue to an ObjectId.
 
static operator ObjectId? (BsonValue value)
 Casts a BsonValue to an ObjectId?.
 
static operator Regex (BsonValue value)
 Casts a BsonValue to a Regex.
 
static operator string (BsonValue value)
 Casts a BsonValue to a string.
 
static bool operator< (BsonValue lhs, BsonValue rhs)
 Compares two BsonValues.
 
static bool operator<= (BsonValue lhs, BsonValue rhs)
 Compares two BsonValues.
 
static bool operator!= (BsonValue lhs, BsonValue rhs)
 Compares two BsonValues.
 
static bool operator== (BsonValue lhs, BsonValue rhs)
 Compares two BsonValues.
 
static bool operator> (BsonValue lhs, BsonValue rhs)
 Compares two BsonValues.
 
static bool operator>= (BsonValue lhs, BsonValue rhs)
 Compares two BsonValues.
 
static BsonValue Create (object value)
 Creates a new instance of the BsonValue class.
 
static BsonValue ReadFrom (BsonReader bsonReader)
 Reads one BsonValue from a BsonReader.
 

Additional Inherited Members

- Protected Member Functions inherited from SequoiaDB.Bson.BsonValue
 BsonValue (BsonType bsonType)
 Initializes a new instance of the BsonValue class.
 
virtual bool OperatorEqualsImplementation (BsonValue rhs)
 Implementation of operator ==.
 
- Properties inherited from SequoiaDB.Bson.BsonValue
bool AsBoolean [get]
 Casts the BsonValue to a Boolean (throws an InvalidCastException if the cast is not valid).
 
BsonArray AsBsonArray [get]
 Casts the BsonValue to a BsonArray (throws an InvalidCastException if the cast is not valid).
 
BsonBinaryData AsBsonBinaryData [get]
 Casts the BsonValue to a BsonBinaryData (throws an InvalidCastException if the cast is not valid).
 
BsonDateTime AsBsonDateTime [get]
 Casts the BsonValue to a BsonDateTime (throws an InvalidCastException if the cast is not valid).
 
BsonDocument AsBsonDocument [get]
 Casts the BsonValue to a BsonDocument (throws an InvalidCastException if the cast is not valid).
 
BsonJavaScript AsBsonJavaScript [get]
 Casts the BsonValue to a BsonJavaScript (throws an InvalidCastException if the cast is not valid).
 
BsonJavaScriptWithScope AsBsonJavaScriptWithScope [get]
 Casts the BsonValue to a BsonJavaScriptWithScope (throws an InvalidCastException if the cast is not valid).
 
BsonMaxKey AsBsonMaxKey [get]
 Casts the BsonValue to a BsonMaxKey (throws an InvalidCastException if the cast is not valid).
 
BsonMinKey AsBsonMinKey [get]
 Casts the BsonValue to a BsonMinKey (throws an InvalidCastException if the cast is not valid).
 
BsonNull AsBsonNull [get]
 Casts the BsonValue to a BsonNull (throws an InvalidCastException if the cast is not valid).
 
BsonRegularExpression AsBsonRegularExpression [get]
 Casts the BsonValue to a BsonRegularExpression (throws an InvalidCastException if the cast is not valid).
 
BsonSymbol AsBsonSymbol [get]
 Casts the BsonValue to a BsonSymbol (throws an InvalidCastException if the cast is not valid).
 
BsonTimestamp AsBsonTimestamp [get]
 Casts the BsonValue to a BsonTimestamp (throws an InvalidCastException if the cast is not valid).
 
BsonDecimal AsBsonDecimal [get]
 Casts the BsonValue to a BsonDecimal (throws an InvalidCastException if the cast is not valid).
 
decimal AsDecimal [get]
 Casts the BsonValue to a decimal (throws an InvalidCastException if the cast is not valid).
 
BsonUndefined AsBsonUndefined [get]
 Casts the BsonValue to a BsonUndefined (throws an InvalidCastException if the cast is not valid).
 
BsonValue AsBsonValue [get]
 Casts the BsonValue to a BsonValue (a way of upcasting subclasses of BsonValue to BsonValue at compile time).
 
byte[] AsByteArray [get]
 Casts the BsonValue to a Byte[] (throws an InvalidCastException if the cast is not valid).
 
DateTime AsDateTime [get]
 Casts the BsonValue to a DateTime in UTC (throws an InvalidCastException if the cast is not valid).
 
double AsDouble [get]
 Casts the BsonValue to a Double (throws an InvalidCastException if the cast is not valid).
 
Guid AsGuid [get]
 Casts the BsonValue to a Guid (throws an InvalidCastException if the cast is not valid).
 
int AsInt32 [get]
 Casts the BsonValue to an Int32 (throws an InvalidCastException if the cast is not valid).
 
DateTime AsLocalTime [get]
 Casts the BsonValue to a DateTime in the local timezone (throws an InvalidCastException if the cast is not valid).
 
long AsInt64 [get]
 Casts the BsonValue to a Int64 (throws an InvalidCastException if the cast is not valid).
 
bool AsNullableBoolean [get]
 Casts the BsonValue to a Nullable{Boolean} (throws an InvalidCastException if the cast is not valid).
 
DateTime AsNullableDateTime [get]
 Casts the BsonValue to a Nullable{DateTime} (throws an InvalidCastException if the cast is not valid).
 
double AsNullableDouble [get]
 Casts the BsonValue to a Nullable{Double} (throws an InvalidCastException if the cast is not valid).
 
Guid AsNullableGuid [get]
 Casts the BsonValue to a Nullable{Guid} (throws an InvalidCastException if the cast is not valid).
 
int AsNullableInt32 [get]
 Casts the BsonValue to a Nullable{Int32} (throws an InvalidCastException if the cast is not valid).
 
long AsNullableInt64 [get]
 Casts the BsonValue to a Nullable{Int64} (throws an InvalidCastException if the cast is not valid).
 
decimal AsNullableDecimal [get]
 Casts the BsonValue to a Nullable{decimal} (throws an InvalidCastException if the cast is not valid).
 
ObjectId AsNullableObjectId [get]
 Casts the BsonValue to a Nullable{ObjectId} (throws an InvalidCastException if the cast is not valid).
 
ObjectId AsObjectId [get]
 Casts the BsonValue to an ObjectId (throws an InvalidCastException if the cast is not valid).
 
Regex AsRegex [get]
 Casts the BsonValue to a Regex (throws an InvalidCastException if the cast is not valid).
 
string AsString [get]
 Casts the BsonValue to a String (throws an InvalidCastException if the cast is not valid).
 
DateTime AsUniversalTime [get]
 Casts the BsonValue to a DateTime in UTC (throws an InvalidCastException if the cast is not valid).
 
BsonType BsonType [get]
 Gets the BsonType of this BsonValue.
 
bool IsBoolean [get]
 Tests whether this BsonValue is a Boolean.
 
bool IsBsonArray [get]
 Tests whether this BsonValue is a BsonArray.
 
bool IsBsonBinaryData [get]
 Tests whether this BsonValue is a BsonBinaryData.
 
bool IsBsonDateTime [get]
 Tests whether this BsonValue is a BsonDateTime.
 
bool IsBsonDocument [get]
 Tests whether this BsonValue is a BsonDocument.
 
bool IsBsonJavaScript [get]
 Tests whether this BsonValue is a BsonJavaScript.
 
bool IsBsonJavaScriptWithScope [get]
 Tests whether this BsonValue is a BsonJavaScriptWithScope.
 
bool IsBsonMaxKey [get]
 Tests whether this BsonValue is a BsonMaxKey.
 
bool IsBsonMinKey [get]
 Tests whether this BsonValue is a BsonMinKey.
 
bool IsBsonNull [get]
 Tests whether this BsonValue is a BsonNull.
 
bool IsBsonRegularExpression [get]
 Tests whether this BsonValue is a BsonRegularExpression.
 
bool IsBsonSymbol [get]
 Tests whether this BsonValue is a BsonSymbol .
 
bool IsBsonTimestamp [get]
 Tests whether this BsonValue is a BsonTimestamp.
 
bool IsBsonDecimal [get]
 Tests whether this BsonValue is a BsonDecimal.
 
bool IsBsonUndefined [get]
 Tests whether this BsonValue is a BsonUndefined.
 
bool IsDateTime [get]
 Tests whether this BsonValue is a DateTime.
 
bool IsDouble [get]
 Tests whether this BsonValue is a Double.
 
bool IsGuid [get]
 Tests whether this BsonValue is a Guid.
 
bool IsInt32 [get]
 Tests whether this BsonValue is an Int32.
 
bool IsInt64 [get]
 Tests whether this BsonValue is an Int64.
 
bool IsNumeric [get]
 Tests whether this BsonValue is a numeric value.
 
bool IsObjectId [get]
 Tests whether this BsonValue is an ObjectId .
 
bool IsString [get]
 Tests whether this BsonValue is a String.
 
virtual object RawValue [get]
 Gets the raw value of this BsonValue (or null if this BsonValue doesn't have a single scalar value).
 

Detailed Description

Represents a BsonDocument wrapper.

Constructor & Destructor Documentation

SequoiaDB.Bson.BsonDocumentWrapper.BsonDocumentWrapper ( object  wrappedObject)
inline

Initializes a new instance of the BsonDocumentWrapper class.

Parameters
wrappedObjectThe wrapped object.
SequoiaDB.Bson.BsonDocumentWrapper.BsonDocumentWrapper ( Type  wrappedNominalType,
object  wrappedObject 
)
inline

Initializes a new instance of the BsonDocumentWrapper class.

Parameters
wrappedNominalTypeThe nominal type of the wrapped object.
wrappedObjectThe wrapped object.
SequoiaDB.Bson.BsonDocumentWrapper.BsonDocumentWrapper ( Type  wrappedNominalType,
object  wrappedObject,
bool  isUpdateDocument 
)
inline

Initializes a new instance of the BsonDocumentWrapper class.

Parameters
wrappedNominalTypeThe nominal type of the wrapped object.
wrappedObjectThe wrapped object.
isUpdateDocumentWhether the wrapped object is an update document that needs to be checked.

Member Function Documentation

override int SequoiaDB.Bson.BsonDocumentWrapper.CompareTo ( BsonValue  other)
inlinevirtual

CompareTo is an invalid operation for BsonDocumentWrapper.

Parameters
otherNot applicable.
Returns
Not applicable.

Implements SequoiaDB.Bson.BsonValue.

static BsonDocumentWrapper SequoiaDB.Bson.BsonDocumentWrapper.Create ( Type  nominalType,
object  value 
)
inlinestatic

Creates a new instance of the BsonDocumentWrapper class.

Parameters
nominalTypeThe nominal type of the wrapped object.
valueThe wrapped object.
Returns
A BsonDocumentWrapper.
static BsonDocumentWrapper SequoiaDB.Bson.BsonDocumentWrapper.Create ( Type  nominalType,
object  value,
bool  isUpdateDocument 
)
inlinestatic

Creates a new instance of the BsonDocumentWrapper class.

Parameters
nominalTypeThe nominal type of the wrapped object.
valueThe wrapped object.
isUpdateDocumentWhether the wrapped object is an update document.
Returns
A BsonDocumentWrapper.
static BsonDocumentWrapper SequoiaDB.Bson.BsonDocumentWrapper.Create< TNominalType > ( TNominalType  value)
inlinestatic

Creates a new instance of the BsonDocumentWrapper class.

Template Parameters
TNominalTypeThe nominal type of the wrapped object.
Parameters
valueThe wrapped object.
Returns
A BsonDocumentWrapper.
static BsonDocumentWrapper SequoiaDB.Bson.BsonDocumentWrapper.Create< TNominalType > ( TNominalType  value,
bool  isUpdateDocument 
)
inlinestatic

Creates a new instance of the BsonDocumentWrapper class.

Template Parameters
TNominalTypeThe nominal type of the wrapped object.
Parameters
valueThe wrapped object.
isUpdateDocumentWhether the wrapped object is an update document.
Returns
A BsonDocumentWrapper.
static IEnumerable<BsonDocumentWrapper> SequoiaDB.Bson.BsonDocumentWrapper.CreateMultiple ( Type  nominalType,
IEnumerable  values 
)
inlinestatic

Creates a list of new instances of the BsonDocumentWrapper class.

Parameters
nominalTypeThe nominal type of the wrapped object.
valuesA list of wrapped objects.
Returns
A list of BsonDocumentWrappers.
static IEnumerable<BsonDocumentWrapper> SequoiaDB.Bson.BsonDocumentWrapper.CreateMultiple< TNominalType > ( IEnumerable< TNominalType >  values)
inlinestatic

Creates a list of new instances of the BsonDocumentWrapper class.

Template Parameters
TNominalTypeThe nominal type of the wrapped objects.
Parameters
valuesA list of wrapped objects.
Returns
A list of BsonDocumentWrappers.
object SequoiaDB.Bson.BsonDocumentWrapper.Deserialize ( BsonReader  bsonReader,
Type  nominalType,
IBsonSerializationOptions  options 
)
inline

Deserialize is an invalid operation for BsonDocumentWrapper.

Parameters
bsonReaderNot applicable.
nominalTypeNot applicable.
optionsNot applicable.
Returns
Not applicable.
override bool SequoiaDB.Bson.BsonDocumentWrapper.Equals ( object  obj)
inline

Equals is an invalid operation for BsonDocumentWrapper.

Parameters
objNot applicable.
Returns
Not applicable.
bool SequoiaDB.Bson.BsonDocumentWrapper.GetDocumentId ( out object  id,
out Type  idNominalType,
out IIdGenerator  idGenerator 
)
inline

GetDocumentId is an invalid operation for BsonDocumentWrapper.

Parameters
idNot applicable.
idNominalTypeNot applicable.
idGeneratorNot applicable.
Returns
Not applicable.
override int SequoiaDB.Bson.BsonDocumentWrapper.GetHashCode ( )
inline

GetHashCode is an invalid operation for BsonDocumentWrapper.

Returns
Not applicable.
void SequoiaDB.Bson.BsonDocumentWrapper.Serialize ( BsonWriter  bsonWriter,
Type  nominalType,
IBsonSerializationOptions  options 
)
inline

Serializes the wrapped object to a BsonWriter.

Parameters
bsonWriterThe writer.
nominalTypeThe nominal type (overridded by the wrapped nominal type).
optionsThe serialization options.
void SequoiaDB.Bson.BsonDocumentWrapper.SetDocumentId ( object  Id)
inline

SetDocumentId is an invalid operation for BsonDocumentWrapper.

Parameters
IdNot applicable.
override string SequoiaDB.Bson.BsonDocumentWrapper.ToString ( )
inline

Returns a string representation of the wrapped document.

Returns
A string representation of the wrapped document.

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