Persistate API documentation
TreeSerialiser Class
NamespacesPersistateTreeSerialiser

[This is preliminary documentation and is subject to change.]

This class contains methods to serialise a persistent tree of objects to a Message, file or stream.
Declaration Syntax
C#
public class TreeSerialiser
Members
All MembersMethods



IconMemberDescription
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Serialise(Persistent, String, SerialiserFilter)
Serialises a tree of objects to a new file, filtered using an optional delegate.

Serialise(Persistent, SerialiserFilter)
Serialises a tree of objects to a new Message, filtered using an optional delegate.

ToString()()()()
Returns a String that represents the current Object.
(Inherited from Object.)
Write(array<Message>[]()[][], String)
Writes Messages to a file.

Write(array<Message>[]()[][], Stream)
Writes Messages to a stream.

Remarks

This serialises objects starting from the root object and including all objects under it in the containment tree. The tree can be already persisted, or can be provisional. It also stores associated collection contents. Once stored, the tree can be reproduced exactly using the TreeDeserialiser class. The serialisation process descends the tree twice, once for contained nodes and a second time for associations. Any associations which are not to objects within the serialised tree are serialised as MetaReferences.

You can optionally supply a SerialiserFilter delegate which will be called for every node being serialised. It is called for each contained node during the first serialisation pass, and during the second pass for each contained node and then each association within contained nodes which pass the filter.

Inheritance Hierarchy
Object
TreeSerialiser

Assembly: Persistate (Module: Persistate) Version: 0.6.1.20 (0.6.1.20)