Mark methods without uncacheableCollections parameter as obsolete

Author: Iwanow, Mihail (EXT)

src/NHibernate/Async/Engine/Loading/CollectionLoadContext.cs

@@ -33,7 +33,24 @@ public partial class CollectionLoadContext
 		/// complete. 
 		/// </summary>
 		/// <param name="persister">The persister for which to complete loading. </param>
-		/// <param name="uncacheableCollections">Indicates if collcetions can be put in cache</param>
+		/// <param name="cancellationToken">A cancellation token that can be used to cancel the work</param>
+		[Obsolete("Please use EndLoadingCollections(ICollectionPersister, HashSet<string>) instead.")]
+		public Task EndLoadingCollectionsAsync(ICollectionPersister persister, CancellationToken cancellationToken)
+		{
+			if (cancellationToken.IsCancellationRequested)
+			{
+				return Task.FromCanceled<object>(cancellationToken);
+			}
+			return EndLoadingCollectionsAsync(persister, null, cancellationToken);
+		}
+
+		/// <summary> 
+		/// Finish the process of collection-loading for this bound result set.  Mainly this
+		/// involves cleaning up resources and notifying the collections that loading is
+		/// complete. 
+		/// </summary>
+		/// <param name="persister">The persister for which to complete loading. </param>
+		/// <param name="uncacheableCollections">Indicates if collections can be put in cache</param>
 		/// <param name="cancellationToken">A cancellation token that can be used to cancel the work</param>
 		public async Task EndLoadingCollectionsAsync(ICollectionPersister persister, HashSet<string> uncacheableCollections, CancellationToken cancellationToken)
 		{
@@ -115,8 +132,11 @@ private async Task EndLoadingCollectionsAsync(ICollectionPersister persister, IL
 			var cacheBatcher = new CacheBatcher(LoadContext.PersistenceContext.Session);
 			for (int i = 0; i < count; i++)
 			{
-				await (EndLoadingCollectionAsync(matchedCollectionEntries[i], persister,
-									 data => cacheBatcher.AddToBatch(persister, data), uncacheableCollections, cancellationToken)).ConfigureAwait(false);
+				await (EndLoadingCollectionAsync(
+					matchedCollectionEntries[i], 
+					persister,
+					data => cacheBatcher.AddToBatch(persister, data),
+					uncacheableCollections, cancellationToken)).ConfigureAwait(false);
 			}
 			await (cacheBatcher.ExecuteBatchAsync(cancellationToken)).ConfigureAwait(false);
 
@@ -126,8 +146,11 @@ private async Task EndLoadingCollectionsAsync(ICollectionPersister persister, IL
 			}
 		}
 
-		private async Task EndLoadingCollectionAsync(LoadingCollectionEntry lce, ICollectionPersister persister,
-										  Action<CachePutData> cacheBatchingHandler, HashSet<string> uncacheableCollections, CancellationToken cancellationToken)
+		private async Task EndLoadingCollectionAsync(
+			LoadingCollectionEntry lce, 
+			ICollectionPersister persister,
+			Action<CachePutData> cacheBatchingHandler, 
+			HashSet<string> uncacheableCollections, CancellationToken cancellationToken)
 		{
 			cancellationToken.ThrowIfCancellationRequested();
 			if (log.IsDebugEnabled())

src/NHibernate/Async/Loader/Criteria/CriteriaLoader.cs

@@ -36,7 +36,7 @@ public Task<IList> ListAsync(ISessionImplementor session, CancellationToken canc
 			}
 			try
 			{
-            	return ListAsync(session, translator.GetQueryParameters(), querySpaces, cancellationToken);
+				return ListAsync(session, translator.GetQueryParameters(), querySpaces, cancellationToken);
 			}
 			catch (Exception ex)
 			{

src/NHibernate/Engine/Loading/CollectionLoadContext.cs

@@ -145,7 +145,19 @@ public IPersistentCollection GetLoadingCollection(ICollectionPersister persister
 		/// complete. 
 		/// </summary>
 		/// <param name="persister">The persister for which to complete loading. </param>
-		/// <param name="uncacheableCollections">Indicates if collcetions can be put in cache</param>
+		[Obsolete("Please use EndLoadingCollections(ICollectionPersister, HashSet<string>) instead.")]
+		public void EndLoadingCollections(ICollectionPersister persister)
+		{
+			EndLoadingCollections(persister, null);
+		}
+
+		/// <summary> 
+		/// Finish the process of collection-loading for this bound result set.  Mainly this
+		/// involves cleaning up resources and notifying the collections that loading is
+		/// complete. 
+		/// </summary>
+		/// <param name="persister">The persister for which to complete loading. </param>
+		/// <param name="uncacheableCollections">Indicates if collections can be put in cache</param>
 		public void EndLoadingCollections(ICollectionPersister persister, HashSet<string> uncacheableCollections)
 		{
 			if (!loadContexts.HasLoadingCollectionEntries && (localLoadingCollectionKeys.Count == 0))
@@ -224,8 +236,11 @@ private void EndLoadingCollections(ICollectionPersister persister, IList<Loading
 			var cacheBatcher = new CacheBatcher(LoadContext.PersistenceContext.Session);
 			for (int i = 0; i < count; i++)
 			{
-				EndLoadingCollection(matchedCollectionEntries[i], persister,
-									 data => cacheBatcher.AddToBatch(persister, data), uncacheableCollections);
+				EndLoadingCollection(
+					matchedCollectionEntries[i], 
+					persister,
+					data => cacheBatcher.AddToBatch(persister, data),
+					uncacheableCollections);
 			}
 			cacheBatcher.ExecuteBatch();
 
@@ -235,8 +250,11 @@ private void EndLoadingCollections(ICollectionPersister persister, IList<Loading
 			}
 		}
 
-		private void EndLoadingCollection(LoadingCollectionEntry lce, ICollectionPersister persister,
-										  Action<CachePutData> cacheBatchingHandler, HashSet<string> uncacheableCollections)
+		private void EndLoadingCollection(
+			LoadingCollectionEntry lce, 
+			ICollectionPersister persister,
+			Action<CachePutData> cacheBatchingHandler, 
+			HashSet<string> uncacheableCollections)
 		{
 			if (log.IsDebugEnabled())
 			{

src/NHibernate/Engine/QueryParameters.cs

@@ -40,14 +40,22 @@ public QueryParameters(IType[] positionalParameterTypes, object[] postionalParam
 			: this(positionalParameterTypes, postionalParameterValues, namedParameters, null, null, false, false, false, null, null, collectionKeys, null, null) {}
 
 		public QueryParameters(IType[] positionalParameterTypes, object[] positionalParameterValues, IDictionary<string, LockMode> lockModes, RowSelection rowSelection,
-							bool isReadOnlyInitialized, bool readOnly, bool cacheable, string cacheRegion, string comment, bool isLookupByNaturalKey, IResultTransformer transformer)
+							   bool isReadOnlyInitialized, bool readOnly, bool cacheable, string cacheRegion, string comment, bool isLookupByNaturalKey, IResultTransformer transformer)
 			: this(positionalParameterTypes, positionalParameterValues, null, lockModes, rowSelection, isReadOnlyInitialized, readOnly, cacheable, cacheRegion, comment, null, transformer, null)
 		{
 			NaturalKeyLookup = isLookupByNaturalKey;
 		}
 
+		[Obsolete("Please use QueryParameters(IDictionary<string, TypedValue>, IDictionary<string, LockMode>, " +
+			"RowSelection, bool, bool, bool, string, string, bool, IResultTransformer, HashSet<string>) instead.")]
 		public QueryParameters(IDictionary<string, TypedValue> namedParameters, IDictionary<string, LockMode> lockModes, RowSelection rowSelection, bool isReadOnlyInitialized,
-							bool readOnly, bool cacheable, string cacheRegion, string comment, bool isLookupByNaturalKey, IResultTransformer transformer, HashSet<string> uncacheableCollections)
+							   bool readOnly, bool cacheable, string cacheRegion, string comment, bool isLookupByNaturalKey, IResultTransformer transformer)
+			: this(
+				namedParameters, lockModes, rowSelection, isReadOnlyInitialized, readOnly, cacheable, cacheRegion, comment, isLookupByNaturalKey,
+				transformer, null) {}
+
+		public QueryParameters(IDictionary<string, TypedValue> namedParameters, IDictionary<string, LockMode> lockModes, RowSelection rowSelection, bool isReadOnlyInitialized,
+							   bool readOnly, bool cacheable, string cacheRegion, string comment, bool isLookupByNaturalKey, IResultTransformer transformer, HashSet<string> uncacheableCollections)
 			: this(
 				TypeHelper.EmptyTypeArray, Array.Empty<object>(), namedParameters, lockModes, rowSelection, isReadOnlyInitialized, readOnly, cacheable, cacheRegion, comment, null,
 				transformer, uncacheableCollections)
@@ -56,9 +64,18 @@ public QueryParameters(IDictionary<string, TypedValue> namedParameters, IDiction
 			NaturalKeyLookup = isLookupByNaturalKey;
 		}
 
+		[Obsolete("Please use QueryParameters(IType[], object[], IDictionary<string, TypedValue>, " +
+			"IDictionary<string, LockMode>, RowSelection, bool, bool, bool, string, string, object[], IResultTransformer, HashSet<string>) instead.")]
 		public QueryParameters(IType[] positionalParameterTypes, object[] positionalParameterValues, IDictionary<string, TypedValue> namedParameters,
-							IDictionary<string, LockMode> lockModes, RowSelection rowSelection, bool isReadOnlyInitialized, bool readOnly, bool cacheable, string cacheRegion,
-							string comment, object[] collectionKeys, IResultTransformer transformer, HashSet<string> uncacheableCollections)
+							   IDictionary<string, LockMode> lockModes, RowSelection rowSelection, bool isReadOnlyInitialized, bool readOnly, bool cacheable, string cacheRegion,
+							   string comment, object[] collectionKeys, IResultTransformer transformer)
+			: this(
+				TypeHelper.EmptyTypeArray, Array.Empty<object>(), namedParameters, lockModes, rowSelection, isReadOnlyInitialized, readOnly, cacheable, cacheRegion, comment, null,
+				transformer, null) {}
+
+		public QueryParameters(IType[] positionalParameterTypes, object[] positionalParameterValues, IDictionary<string, TypedValue> namedParameters,
+							   IDictionary<string, LockMode> lockModes, RowSelection rowSelection, bool isReadOnlyInitialized, bool readOnly, bool cacheable, string cacheRegion,
+							   string comment, object[] collectionKeys, IResultTransformer transformer, HashSet<string> uncacheableCollections)
 		{
 			PositionalParameterTypes = positionalParameterTypes ?? Array.Empty<IType>();
 			PositionalParameterValues = positionalParameterValues ?? Array.Empty<object>();
@@ -141,7 +158,7 @@ public bool HasRowSelection
 		public bool Callable { get; set; }
 
 		/// <summary>
-		/// Indicates if we can add loaded child collections to second lvl cache.
+		/// Indicates if we can add loaded child collections to second level cache.
 		/// </summary>
 		public HashSet<string> UncacheableCollections { get; set; }
 

src/NHibernate/Impl/CriteriaImpl.cs

@@ -699,7 +699,7 @@ internal Subcriteria(CriteriaImpl root, ICriteria parent, string path, string al
 				this.joinType = joinType;
 				this.withClause = withClause;
 				JoinEntityName = joinEntityName;
-			    hasRestrictions = withClause != null;
+				hasRestrictions = withClause != null;
 
 				root.subcriteriaList.Add(this);
 
@@ -733,10 +733,10 @@ public string Path
 				get { return path; }
 			}
 
-		    public bool HasRestrictions
-		    {
-		        get { return hasRestrictions; }
-		    }
+			public bool HasRestrictions
+			{
+				get { return hasRestrictions; }
+			}
 
 			public ICriteria Parent
 			{
@@ -777,7 +777,7 @@ public ICriteria SetLockMode(LockMode lockMode)
 
 			public ICriteria Add(ICriterion expression)
 			{
-			    hasRestrictions = true;
+				hasRestrictions = true;
 				root.Add(this, expression);
 				return this;
 			}

src/NHibernate/Loader/Criteria/CriteriaLoader.cs

@@ -94,7 +94,7 @@ protected override bool IsChildFetchEntity(int i)
 
 		public IList List(ISessionImplementor session)
 		{
-            return List(session, translator.GetQueryParameters(), querySpaces);
+			return List(session, translator.GetQueryParameters(), querySpaces);
 		}
 
 		protected override IResultTransformer ResolveResultTransformer(IResultTransformer resultTransformer)

src/NHibernate/Loader/Criteria/CriteriaQueryTranslator.cs

@@ -922,10 +922,10 @@ private void CreateSubQuerySpaces()
 
 			var subQueries =
 				rootCriteria.IterateExpressionEntries()
-							.Select(x => x.Criterion)
-							.OfType<SubqueryExpression>()
-							.Select(x => x.Criteria)
-							.OfType<CriteriaImpl>();
+				            .Select(x => x.Criterion)
+				            .OfType<SubqueryExpression>()
+				            .Select(x => x.Criteria)
+				            .OfType<CriteriaImpl>();
 
 			foreach (var criteriaImpl in subQueries)
 			{

src/NHibernate/Loader/Loader.cs

@@ -849,7 +849,7 @@ internal void HandleEmptyCollections(object[] keys, object resultSetId, ISession
 						if (Log.IsDebugEnabled())
 						{
 							Log.Debug("result set contains (possibly empty) collection: {0}",
-									  MessageHelper.CollectionInfoString(collectionPersisters[j], keys[i]));
+							          MessageHelper.CollectionInfoString(collectionPersisters[j], keys[i]));
 						}
 						session.PersistenceContext.LoadContexts.GetCollectionLoadContext((DbDataReader)resultSetId).GetLoadingCollection(
 							collectionPersisters[j], keys[i]);