Lucene.Net.Core.Search.Spans (SpanNearPayLoadQuery + SpanPayloadCheckQuery): added documentation about the importance of passing a collection that implements one of the 3 primary types or provides an overload of Equals and GetHashCode()
Project: http://git-wip-us.apache.org/repos/asf/lucenenet/repo Commit: http://git-wip-us.apache.org/repos/asf/lucenenet/commit/1a251a1c Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/1a251a1c Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/1a251a1c Branch: refs/heads/api-work Commit: 1a251a1c4fe9af25384322876ad80b880e184b18 Parents: 3ffcd7f Author: Shad Storhaug <[email protected]> Authored: Thu Mar 30 08:04:38 2017 +0700 Committer: Shad Storhaug <[email protected]> Committed: Thu Mar 30 09:12:31 2017 +0700 ---------------------------------------------------------------------- .../Search/Spans/SpanNearPayloadCheckQuery.cs | 8 ++++++-- src/Lucene.Net.Core/Search/Spans/SpanPayloadCheckQuery.cs | 8 ++++++-- 2 files changed, 12 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucenenet/blob/1a251a1c/src/Lucene.Net.Core/Search/Spans/SpanNearPayloadCheckQuery.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Core/Search/Spans/SpanNearPayloadCheckQuery.cs b/src/Lucene.Net.Core/Search/Spans/SpanNearPayloadCheckQuery.cs index a523fb6..e590644 100644 --- a/src/Lucene.Net.Core/Search/Spans/SpanNearPayloadCheckQuery.cs +++ b/src/Lucene.Net.Core/Search/Spans/SpanNearPayloadCheckQuery.cs @@ -34,8 +34,12 @@ namespace Lucene.Net.Search.Spans { protected readonly ICollection<byte[]> m_payloadToMatch; - /// <param name="match"> The underlying <seealso cref="SpanQuery"/> to check </param> - /// <param name="payloadToMatch"> The <seealso cref="java.util.Collection"/> of payloads to match </param> + /// <param name="match"> The underlying <see cref="SpanQuery"/> to check </param> + /// <param name="payloadToMatch"> The <see cref="T:ICollection{byte[]}"/> of payloads to match. + /// IMPORTANT: If the type provided does not implement <see cref="IList{T}"/> (including arrays), + /// <see cref="ISet{T}"/>, or <see cref="IDictionary{TKey, TValue}"/>, it should provide an + /// <see cref="object.Equals(object)"/> and <see cref="object.GetHashCode()"/> implementation + /// that compares the values of the byte arrays to ensure they are the same. </param> public SpanNearPayloadCheckQuery(SpanNearQuery match, ICollection<byte[]> payloadToMatch) : base(match) { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/1a251a1c/src/Lucene.Net.Core/Search/Spans/SpanPayloadCheckQuery.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Core/Search/Spans/SpanPayloadCheckQuery.cs b/src/Lucene.Net.Core/Search/Spans/SpanPayloadCheckQuery.cs index 466d894..dade50a 100644 --- a/src/Lucene.Net.Core/Search/Spans/SpanPayloadCheckQuery.cs +++ b/src/Lucene.Net.Core/Search/Spans/SpanPayloadCheckQuery.cs @@ -39,8 +39,12 @@ namespace Lucene.Net.Search.Spans protected readonly ICollection<byte[]> m_payloadToMatch; /// - /// <param name="match"> The underlying <seealso cref="Lucene.Net.Search.Spans.SpanQuery"/> to check </param> - /// <param name="payloadToMatch"> The <seealso cref="java.util.Collection"/> of payloads to match </param> + /// <param name="match"> The underlying <see cref="SpanQuery"/> to check </param> + /// <param name="payloadToMatch"> The <see cref="T:ICollection<byte[]>"/> of payloads to match. + /// IMPORTANT: If the type provided does not implement <see cref="IList{T}"/> (including arrays), + /// <see cref="ISet{T}"/>, or <see cref="IDictionary{TKey, TValue}"/>, it should provide an + /// <see cref="object.Equals(object)"/> and <see cref="object.GetHashCode()"/> implementation + /// that compares the values of the byte arrays to ensure they are the same.</param> public SpanPayloadCheckQuery(SpanQuery match, ICollection<byte[]> payloadToMatch) : base(match) {
