DocumentsWindow.cs

/* Copyright 2010-present MongoDB Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

usingMongoDB.Driver.Core.Misc;

namespaceMongoDB.Driver
{
/// <summary>
/// Represents a documents window for a SetWindowFields window method.
/// </summary>
publicsealedclassDocumentsWindow:SetWindowFieldsWindow
{
 #region static
privatestaticreadonlyKeywordDocumentsWindowBoundary__current=newKeywordDocumentsWindowBoundary("current");
privatestaticreadonlyKeywordDocumentsWindowBoundary__unbounded=newKeywordDocumentsWindowBoundary("unbounded");

/// <summary>
/// Returns a "current" documents window boundary.
/// </summary>
publicstaticKeywordDocumentsWindowBoundaryCurrent=>__current;

/// <summary>
/// Returns an "unbounded" documents window boundary.
/// </summary>
publicstaticKeywordDocumentsWindowBoundaryUnbounded=>__unbounded;

/// <summary>
/// Creates a documents window.
/// </summary>
/// <param name="lowerBoundary">The lower boundary.</param>
/// <param name="upperBoundary">The upper boundary.</param>
/// <returns>A documents window.</returns>
publicstaticDocumentsWindowCreate(intlowerBoundary,intupperBoundary)
{
returnnewDocumentsWindow(newPositionDocumentsWindowBoundary(lowerBoundary),newPositionDocumentsWindowBoundary(upperBoundary));
}

/// <summary>
/// Creates a documents window.
/// </summary>
/// <param name="lowerBoundary">The lower boundary.</param>
/// <param name="upperBoundary">The upper boundary.</param>
/// <returns>A documents window.</returns>
publicstaticDocumentsWindowCreate(intlowerBoundary,KeywordDocumentsWindowBoundaryupperBoundary)
{
returnnewDocumentsWindow(newPositionDocumentsWindowBoundary(lowerBoundary),upperBoundary);
}

/// <summary>
/// Creates a documents window.
/// </summary>
/// <param name="lowerBoundary">The lower boundary.</param>
/// <param name="upperBoundary">The upper boundary.</param>
/// <returns>A documents window.</returns>
publicstaticDocumentsWindowCreate(KeywordDocumentsWindowBoundarylowerBoundary,intupperBoundary)
{
returnnewDocumentsWindow(lowerBoundary,newPositionDocumentsWindowBoundary(upperBoundary));
}

/// <summary>
/// Creates a documents window.
/// </summary>
/// <param name="lowerBoundary">The lower boundary.</param>
/// <param name="upperBoundary">The upper boundary.</param>
/// <returns>A documents window.</returns>
publicstaticDocumentsWindowCreate(KeywordDocumentsWindowBoundarylowerBoundary,KeywordDocumentsWindowBoundaryupperBoundary)
{
returnnewDocumentsWindow(lowerBoundary,upperBoundary);
}
 #endregion

privatereadonlyDocumentsWindowBoundary_lowerBoundary;
privatereadonlyDocumentsWindowBoundary_upperBoundary;

/// <summary>
/// Initializes an instance of DocumentsWindow.
/// </summary>
/// <param name="lowerBoundary">The lower boundary.</param>
/// <param name="upperBoundary">The upper boundary.</param>
internalDocumentsWindow(DocumentsWindowBoundarylowerBoundary,DocumentsWindowBoundaryupperBoundary)
{
_lowerBoundary=Ensure.IsNotNull(lowerBoundary,nameof(lowerBoundary));
_upperBoundary=Ensure.IsNotNull(upperBoundary,nameof(upperBoundary));
}

/// <summary>
/// The lower boundary.
/// </summary>
publicDocumentsWindowBoundaryLowerBoundary=>_lowerBoundary;

/// <summary>
/// The upper boundary.
/// </summary>
publicDocumentsWindowBoundaryUpperBoundary=>_upperBoundary;

/// <inheritdoc/>
publicoverridestringToString()=>$"documents : [{_lowerBoundary}, {_upperBoundary}]";
}
}