From: Michael D. <mik...@us...> - 2004-11-29 04:46:04
|
Update of /cvsroot/nhibernate/nhibernate/src/NHibernate/Engine In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv31197/src/NHibernate/Engine Modified Files: ICollectionSnapshot.cs Log Message: Added some comments about how the CollectionEntry is working and some more comments to individual collection classes. Index: ICollectionSnapshot.cs =================================================================== RCS file: /cvsroot/nhibernate/nhibernate/src/NHibernate/Engine/ICollectionSnapshot.cs,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** ICollectionSnapshot.cs 24 Mar 2004 19:54:02 -0000 1.3 --- ICollectionSnapshot.cs 29 Nov 2004 04:45:51 -0000 1.4 *************** *** 1,13 **** using System; ! namespace NHibernate.Engine { ! ! public interface ICollectionSnapshot { object Key { get; } string Role { get; } object Snapshot { get; } bool Dirty { get; } void SetDirty(); ! bool IsInitialized{get;} } } --- 1,46 ---- using System; ! namespace NHibernate.Engine ! { ! /// <summary> ! /// Defines a complete "snapshot" of a particular collection. ! /// </summary> ! public interface ICollectionSnapshot ! { ! /// <summary> ! /// Gets the identifier of the Entity that owns this Collection. ! /// </summary> object Key { get; } + + /// <summary> + /// Gets the role that identifies this Collection. + /// </summary> string Role { get; } + + /// <summary> + /// Gets the snapshot copy of the Collection's elements. + /// </summary> + /// <remarks> + /// In most cases this is the same collection type as the one being snapshotted. + /// ie - the snapshot of an IList will return an IList. + /// </remarks> object Snapshot { get; } + + /// <summary> + /// Gets a <see cref="Boolean"/> indicating if some action has been performed on the + /// actual collection instance that has modified it. + /// </summary> bool Dirty { get; } + + /// <summary> + /// Marks the <see cref="ICollectionSnapshot"/> as being dirty. + /// </summary> void SetDirty(); ! ! /// <summary> ! /// Gets a <see cref="Boolean"/> indicating if the underlying collection has been ! /// initialized yet. ! /// </summary> ! bool IsInitialized{ get; } } } |