C# Class MongoDB.Bson.MaterializedOnDemandBsonDocument

Inheritance: BsonDocument, IDisposable

Datei anzeigen Open project: egametang/Egametang

Private Properties

Property	Type	Description
Add	BsonDocument
Add	BsonDocument
Add	BsonDocument
Add	BsonDocument
Add	BsonDocument
Add	BsonDocument
Add	BsonDocument
Add	BsonDocument
EnsureIsMaterialized	void
GetDocumentId	bool
SetDocumentId	void
this	BsonValue

Public Methods

Method	Description
Add ( BsonElement element ) : BsonDocument	Adds an element to the document.
Add ( string name, BsonValue value ) : BsonDocument	Creates and adds an element to the document.
Add ( string name, BsonValue value, bool condition ) : BsonDocument	Creates and adds an element to the document, but only if the condition is true.
Add ( string name, Func valueFactory, bool condition ) : BsonDocument	Creates and adds an element to the document, but only if the condition is true. If the condition is false the value factory is not called at all.
AddRange ( object>.Dictionary dictionary ) : BsonDocument	Adds elements to the document from a dictionary of key/value pairs.
AddRange ( IDictionary dictionary ) : BsonDocument	Adds elements to the document from a dictionary of key/value pairs.
AddRange ( IEnumerable elements ) : BsonDocument	Adds a list of elements to the document.
AddRange ( object>.IEnumerable dictionary ) : BsonDocument	Adds elements to the document from a dictionary of key/value pairs.
Clear ( ) : void	Clears the document (removes all elements).
Clone ( ) : BsonValue	Creates a shallow clone of the document (see also DeepClone).
CompareTo ( BsonDocument other ) : int	Compares this document to another document.
CompareTo ( BsonValue other ) : int	Compares the BsonDocument to another BsonValue.
Contains ( string name ) : bool	Tests whether the document contains an element with the specified name.
ContainsValue ( BsonValue value ) : bool	Tests whether the document contains an element with the specified value.
DeepClone ( ) : BsonValue	Creates a deep clone of the document (see also Clone).
Dispose ( ) : void	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Equals ( object obj ) : bool	Determines whether the specified System.Object, is equal to this instance.
GetElement ( int index ) : BsonElement	Gets an element of this document.
GetElement ( string name ) : BsonElement	Gets an element of this document.
GetEnumerator ( ) : IEnumerator	Gets an enumerator that can be used to enumerate the elements of this document.
GetHashCode ( ) : int	Returns a hash code for this instance.
GetValue ( int index ) : BsonValue	Gets the value of an element.
GetValue ( string name ) : BsonValue	Gets the value of an element.
GetValue ( string name, BsonValue defaultValue ) : BsonValue	Gets the value of an element or a default value if the element is not found.
InsertAt ( int index, BsonElement element ) : void	Inserts a new element at a specified position.
Merge ( BsonDocument document ) : BsonDocument	Merges another document into this one. Existing elements are not overwritten.
Merge ( BsonDocument document, bool overwriteExistingElements ) : BsonDocument	Merges another document into this one, specifying whether existing elements are overwritten.
Remove ( string name ) : void	Removes an element from this document (if duplicate element names are allowed then all elements with this name will be removed).
RemoveAt ( int index ) : void	Removes an element from this document.
RemoveElement ( BsonElement element ) : void	Removes an element from this document.
Set ( int index, BsonValue value ) : BsonDocument	Sets the value of an element.
Set ( string name, BsonValue value ) : BsonDocument	Sets the value of an element (an element will be added if no element with this name is found).
SetElement ( BsonElement element ) : BsonDocument	Sets an element of the document (replaces any existing element with the same name or adds a new element if an element with the same name is not found).
SetElement ( int index, BsonElement element ) : BsonDocument	Sets an element of the document (replacing the existing element at that position).
TryGetElement ( string name, BsonElement &value ) : bool	Tries to get an element of this document.
TryGetValue ( string name, BsonValue &value ) : bool	Tries to get the value of an element of this document.
this ( int index ) : BsonValue	Gets or sets a value by position.
this ( string name ) : BsonValue	Gets or sets a value by name.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Releases unmanaged and - optionally - managed resources.
Materialize ( ) : IEnumerable	Materializes the BsonDocument.
MaterializeCompleted ( ) : void	Informs subclasses that the Materialize process completed so they can free any resources related to the unmaterialized state.
MaterializedOnDemandBsonDocument ( ) : System	Initializes a new instance of the MaterializedOnDemandBsonDocument class.
ThrowIfDisposed ( ) : void	Throws if disposed.

Private Methods

Method	Description
Add ( ) : BsonDocument
Add ( object>.Dictionary dictionary ) : BsonDocument
Add ( object>.Dictionary dictionary, IEnumerable keys ) : BsonDocument
Add ( IDictionary dictionary ) : BsonDocument
Add ( IDictionary dictionary, IEnumerable keys ) : BsonDocument
Add ( object>.IDictionary dictionary ) : BsonDocument
Add ( object>.IDictionary dictionary, IEnumerable keys ) : BsonDocument
Add ( IEnumerable elements ) : BsonDocument
EnsureIsMaterialized ( ) : void
GetDocumentId ( object &id, Type &idNominalType, IIdGenerator &idGenerator ) : bool
SetDocumentId ( object id ) : void
this ( string name, BsonValue defaultValue ) : BsonValue

Method Details

Add() public method

Adds an element to the document.

public Add ( BsonElement element ) : BsonDocument
element	BsonElement	The element to add.
return	BsonDocument

Add() public method

Creates and adds an element to the document.

public Add ( string name, BsonValue value ) : BsonDocument
name	string	The name of the element.
value	BsonValue	The value of the element.
return	BsonDocument

Add() public method

Creates and adds an element to the document, but only if the condition is true.

public Add ( string name, BsonValue value, bool condition ) : BsonDocument
name	string	The name of the element.
value	BsonValue	The value of the element.
condition	bool	Whether to add the element to the document.
return	BsonDocument

Add() public method

Creates and adds an element to the document, but only if the condition is true. If the condition is false the value factory is not called at all.

public Add ( string name, Func valueFactory, bool condition ) : BsonDocument
name	string	The name of the element.
valueFactory	Func	A delegate called to compute the value of the element if condition is true.
condition	bool	Whether to add the element to the document.
return	BsonDocument

AddRange() public method

Adds elements to the document from a dictionary of key/value pairs.

public AddRange ( object>.Dictionary dictionary ) : BsonDocument
dictionary	object>.Dictionary	The dictionary.
return	BsonDocument

AddRange() public method

Adds elements to the document from a dictionary of key/value pairs.

public AddRange ( IDictionary dictionary ) : BsonDocument
dictionary	IDictionary	The dictionary.
return	BsonDocument

AddRange() public method

Adds a list of elements to the document.

public AddRange ( IEnumerable elements ) : BsonDocument
elements	IEnumerable	The list of elements.
return	BsonDocument

AddRange() public method

Adds elements to the document from a dictionary of key/value pairs.

public AddRange ( object>.IEnumerable dictionary ) : BsonDocument
dictionary	object>.IEnumerable	The dictionary.
return	BsonDocument

Clear() public method

Clears the document (removes all elements).

public Clear ( ) : void
return	void

Clone() public method

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

public Clone ( ) : BsonValue
return	BsonValue

CompareTo() public method

Compares this document to another document.

public CompareTo ( BsonDocument other ) : int
other	BsonDocument	The other document.
return	int

CompareTo() public method

Compares the BsonDocument to another BsonValue.

public CompareTo ( BsonValue other ) : int
other	BsonValue	The other BsonValue.
return	int

Contains() public method

Tests whether the document contains an element with the specified name.

public Contains ( string name ) : bool
name	string	The name of the element to look for.
return	bool

ContainsValue() public method

Tests whether the document contains an element with the specified value.

public ContainsValue ( BsonValue value ) : bool
value	BsonValue	The value of the element to look for.
return	bool

DeepClone() public method

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

public DeepClone ( ) : BsonValue
return	BsonValue

Dispose() public method

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public Dispose ( ) : void
return	void

Dispose() protected method

Releases unmanaged and - optionally - managed resources.

protected Dispose ( bool disposing ) : void
disposing	bool	true to release both managed and unmanaged resources; false to release only unmanaged resources.
return	void

Equals() public method

Determines whether the specified System.Object, is equal to this instance.

public Equals ( object obj ) : bool
obj	object	The to compare with this instance.
return	bool

GetElement() public method

Gets an element of this document.

public GetElement ( int index ) : BsonElement
index	int	The zero based index of the element.
return	BsonElement

GetElement() public method

Gets an element of this document.

public GetElement ( string name ) : BsonElement
name	string	The name of the element.
return	BsonElement

GetEnumerator() public method

Gets an enumerator that can be used to enumerate the elements of this document.

public GetEnumerator ( ) : IEnumerator
return	IEnumerator

GetHashCode() public method

Returns a hash code for this instance.

public GetHashCode ( ) : int
return	int

GetValue() public method

Gets the value of an element.

public GetValue ( int index ) : BsonValue
index	int	The zero based index of the element.
return	BsonValue

GetValue() public method

Gets the value of an element.

public GetValue ( string name ) : BsonValue
name	string	The name of the element.
return	BsonValue

GetValue() public method

Gets the value of an element or a default value if the element is not found.

public GetValue ( string name, BsonValue defaultValue ) : BsonValue
name	string	The name of the element.
defaultValue	BsonValue	The default value returned if the element is not found.
return	BsonValue

InsertAt() public method

Inserts a new element at a specified position.

public InsertAt ( int index, BsonElement element ) : void
index	int	The position of the new element.
element	BsonElement	The element.
return	void

Materialize() protected abstract method

Materializes the BsonDocument.

protected abstract Materialize ( ) : IEnumerable
return	IEnumerable

MaterializeCompleted() protected abstract method

Informs subclasses that the Materialize process completed so they can free any resources related to the unmaterialized state.

protected abstract MaterializeCompleted ( ) : void
return	void

MaterializedOnDemandBsonDocument() protected method

Initializes a new instance of the MaterializedOnDemandBsonDocument class.

protected MaterializedOnDemandBsonDocument ( ) : System
return	System

Merge() public method

Merges another document into this one. Existing elements are not overwritten.

public Merge ( BsonDocument document ) : BsonDocument
document	BsonDocument	The other document.
return	BsonDocument

Merge() public method

Merges another document into this one, specifying whether existing elements are overwritten.

public Merge ( BsonDocument document, bool overwriteExistingElements ) : BsonDocument
document	BsonDocument	The other document.
overwriteExistingElements	bool	Whether to overwrite existing elements.
return	BsonDocument

Remove() public method

Removes an element from this document (if duplicate element names are allowed then all elements with this name will be removed).

public Remove ( string name ) : void
name	string	The name of the element to remove.
return	void

RemoveAt() public method

Removes an element from this document.

public RemoveAt ( int index ) : void
index	int	The zero based index of the element to remove.
return	void

RemoveElement() public method

Removes an element from this document.

public RemoveElement ( BsonElement element ) : void
element	BsonElement	The element to remove.
return	void

Set() public method

Sets the value of an element.

public Set ( int index, BsonValue value ) : BsonDocument
index	int	The zero based index of the element whose value is to be set.
value	BsonValue	The new value.
return	BsonDocument

Set() public method

Sets the value of an element (an element will be added if no element with this name is found).

public Set ( string name, BsonValue value ) : BsonDocument
name	string	The name of the element whose value is to be set.
value	BsonValue	The new value.
return	BsonDocument

SetElement() public method

Sets an element of the document (replaces any existing element with the same name or adds a new element if an element with the same name is not found).

public SetElement ( BsonElement element ) : BsonDocument
element	BsonElement	The new element.
return	BsonDocument

SetElement() public method

Sets an element of the document (replacing the existing element at that position).

public SetElement ( int index, BsonElement element ) : BsonDocument
index	int	The zero based index of the element to replace.
element	BsonElement	The new element.
return	BsonDocument

ThrowIfDisposed() protected method

Throws if disposed.

protected ThrowIfDisposed ( ) : void
return	void

TryGetElement() public method

Tries to get an element of this document.

public TryGetElement ( string name, BsonElement &value ) : bool
name	string	The name of the element.
value	BsonElement	The element.
return	bool

TryGetValue() public method

Tries to get the value of an element of this document.

public TryGetValue ( string name, BsonValue &value ) : bool
name	string	The name of the element.
value	BsonValue	The value of the element.
return	bool

this() public method

Gets or sets a value by position.

public this ( int index ) : BsonValue
index	int	The position.
return	BsonValue

this() public method

Gets or sets a value by name.

public this ( string name ) : BsonValue
name	string	The name.
return	BsonValue