/azure-docs-sdk-dotnet

Permalink
Switch branches/tags
Nothing to show
Find file
azure-docs-sdk-dotnet/xml/Microsoft.Azure.Documents.Partitioning/Range`1.xml
Fetching contributors…
Cannot retrieve contributors at this time
Raw Blame History
390 lines (390 sloc) 19.6 KB
<Type Name="Range&lt;T&gt;" FullName="Microsoft.Azure.Documents.Partitioning.Range&lt;T&gt;">
<TypeSignature Language="C#" Value="public class Range&lt;T&gt; : IComparable&lt;Microsoft.Azure.Documents.Partitioning.Range&lt;T&gt;&gt;, IEquatable&lt;Microsoft.Azure.Documents.Partitioning.Range&lt;T&gt;&gt; where T : IComparable&lt;T&gt;, IEquatable&lt;T&gt;" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Range`1&lt;(class System.IComparable`1&lt;!T&gt;, class System.IEquatable`1&lt;!T&gt;) T&gt; extends System.Object implements class System.IComparable`1&lt;class Microsoft.Azure.Documents.Partitioning.Range`1&lt;!T&gt;&gt;, class System.IEquatable`1&lt;class Microsoft.Azure.Documents.Partitioning.Range`1&lt;!T&gt;&gt;" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.Partitioning.Range`1" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="T">
<Constraints>
<InterfaceName>System.IComparable&lt;T&gt;</InterfaceName>
<InterfaceName>System.IEquatable&lt;T&gt;</InterfaceName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IComparable&lt;Microsoft.Azure.Documents.Partitioning.Range&lt;T&gt;&gt;</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IEquatable&lt;Microsoft.Azure.Documents.Partitioning.Range&lt;T&gt;&gt;</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Support for classes used with IPartitionResolver is now obsolete. It's recommended that you use partitioned collections for higher storage and throughput.")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<typeparam name="T">Any type that can be used for range comparison.</typeparam>
<summary>
A class that represents a range used by the <see cref="T:Microsoft.Azure.Documents.Partitioning.RangePartitionResolver`1" /> class in the Azure DocumentDB database service.
</summary>
<remarks>
Support for classes used with IPartitionResolver is now obsolete. It's recommended that you use
<a href="https://azure.microsoft.com/documentation/articles/documentdb-partition-data">Partitioned Collections</a> for higher storage and throughput.
</remarks>
<altmember cref="T:Microsoft.Azure.Documents.Partitioning.RangePartitionResolver`1" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Range (T point);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(!T point) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Partitioning.Range`1.#ctor(`0)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="point" Type="T" />
</Parameters>
<Docs>
<param name="point">A value that is used to create the range.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Documents.Partitioning.Range`1" /> class for a single value.
</summary>
<remarks>
Use this constructor for building a partitioning scheme for discrete/single values.
The Range class that represents a range used by the <see cref="T:Microsoft.Azure.Documents.Partitioning.RangePartitionResolver`1" /> class in the Azure DocumentDB database service.
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Range (T low, T high);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(!T low, !T high) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Partitioning.Range`1.#ctor(`0,`0)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="low" Type="T" />
<Parameter Name="high" Type="T" />
</Parameters>
<Docs>
<param name="low">The low value in the range.</param>
<param name="high">The high value in the range.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Documents.Partitioning.Range`1" /> class using the specified low and high values.
</summary>
<remarks>
The Range class that represents a range used by the <see cref="T:Microsoft.Azure.Documents.Partitioning.RangePartitionResolver`1" /> class in the Azure DocumentDB database service.
</remarks>
<exception cref="T:System.ArgumentException">Throws an exception if the range is invalid (low is greater than high).</exception>
</Docs>
</Member>
<Member MemberName="CompareTo">
<MemberSignature Language="C#" Value="public int CompareTo (Microsoft.Azure.Documents.Partitioning.Range&lt;T&gt; other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 CompareTo(class Microsoft.Azure.Documents.Partitioning.Range`1&lt;!T&gt; other) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Partitioning.Range`1.CompareTo(Microsoft.Azure.Documents.Partitioning.Range{`0})" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="other" Type="Microsoft.Azure.Documents.Partitioning.Range&lt;T&gt;" />
</Parameters>
<Docs>
<param name="other">The other range to compare to.</param>
<summary>
Compares two ranges.
</summary>
<returns>Returns -1 if the range is smaller than the passed range, 1 if bigger and 0 if equal.</returns>
<remarks>
The Range class that represents a range used by the <see cref="T:Microsoft.Azure.Documents.Partitioning.RangePartitionResolver`1" /> class in the Azure DocumentDB database service.
</remarks>
</Docs>
</Member>
<Member MemberName="Contains">
<MemberSignature Language="C#" Value="public bool Contains (Microsoft.Azure.Documents.Partitioning.Range&lt;T&gt; other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Contains(class Microsoft.Azure.Documents.Partitioning.Range`1&lt;!T&gt; other) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Partitioning.Range`1.Contains(Microsoft.Azure.Documents.Partitioning.Range{`0})" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="other" Type="Microsoft.Azure.Documents.Partitioning.Range&lt;T&gt;" />
</Parameters>
<Docs>
<param name="other">The input range to be checked if it's contained in this range.</param>
<summary>
Checks if the range contains another range..
</summary>
<returns>Returns true if the input range is contained in the range.</returns>
<remarks>
The Range class that represents a range used by the <see cref="T:Microsoft.Azure.Documents.Partitioning.RangePartitionResolver`1" /> class in the Azure DocumentDB database service.
</remarks>
</Docs>
</Member>
<Member MemberName="Contains">
<MemberSignature Language="C#" Value="public bool Contains (T point);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Contains(!T point) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Partitioning.Range`1.Contains(`0)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="point" Type="T" />
</Parameters>
<Docs>
<param name="point">The key to be checked if in the range.</param>
<summary>
Checks if the range contains a key.
</summary>
<returns>Returns true if the key is in the range.</returns>
<remarks>
The Range class that represents a range used by the <see cref="T:Microsoft.Azure.Documents.Partitioning.RangePartitionResolver`1" /> class in the Azure DocumentDB database service.
</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public bool Equals (Microsoft.Azure.Documents.Partitioning.Range&lt;T&gt; other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(class Microsoft.Azure.Documents.Partitioning.Range`1&lt;!T&gt; other) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Partitioning.Range`1.Equals(Microsoft.Azure.Documents.Partitioning.Range{`0})" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="other" Type="Microsoft.Azure.Documents.Partitioning.Range&lt;T&gt;" />
</Parameters>
<Docs>
<param name="other">the input range to be compared with this range.</param>
<summary>
Checks if two ranges are equal.
</summary>
<returns>Returns true if the input range is equal to this range.</returns>
<remarks>
The Range class that represents a range used by the <see cref="T:Microsoft.Azure.Documents.Partitioning.RangePartitionResolver`1" /> class in the Azure DocumentDB database service.
</remarks>
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Partitioning.Range`1.GetHashCode" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Creates the hashcode for the range.
</summary>
<returns>Returns the hashcode for the range.</returns>
<remarks>
The Range class that represents a range used by the <see cref="T:Microsoft.Azure.Documents.Partitioning.RangePartitionResolver`1" /> class in the Azure DocumentDB database service.
</remarks>
</Docs>
</Member>
<Member MemberName="High">
<MemberSignature Language="C#" Value="public T High { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance !T High" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Partitioning.Range`1.High" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the high value in the range.
</summary>
<value>
The high value in the range.
</value>
<remarks>
The Range class that represents a range used by the <see cref="T:Microsoft.Azure.Documents.Partitioning.RangePartitionResolver`1" /> class in the Azure DocumentDB database service.
</remarks>
</Docs>
</Member>
<Member MemberName="Intersect">
<MemberSignature Language="C#" Value="public bool Intersect (Microsoft.Azure.Documents.Partitioning.Range&lt;T&gt; other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Intersect(class Microsoft.Azure.Documents.Partitioning.Range`1&lt;!T&gt; other) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Partitioning.Range`1.Intersect(Microsoft.Azure.Documents.Partitioning.Range{`0})" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="other" Type="Microsoft.Azure.Documents.Partitioning.Range&lt;T&gt;" />
</Parameters>
<Docs>
<param name="other">the input <see cref="T:Microsoft.Azure.Documents.Partitioning.Range`1" /> to be compared with this range.</param>
<summary>
Checks if the range <paramref name="other" /> intersects with this range.
</summary>
<returns>Returns true if the two ranges intersect with each other.</returns>
<remarks>
The Range class that represents a range used by the <see cref="T:Microsoft.Azure.Documents.Partitioning.RangePartitionResolver`1" /> class in the Azure DocumentDB database service.
</remarks>
</Docs>
</Member>
<Member MemberName="Low">
<MemberSignature Language="C#" Value="public T Low { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance !T Low" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Partitioning.Range`1.Low" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the low value in the range.
</summary>
<value>
The low value in the range.
</value>
<remarks>
The Range class that represents a range used by the <see cref="T:Microsoft.Azure.Documents.Partitioning.RangePartitionResolver`1" /> class in the Azure DocumentDB database service.
</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Partitioning.Range`1.ToString" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Converts the range to a string in the form of "low,high"
</summary>
<returns>Returns A string representation of the range.</returns>
<remarks>
The Range class that represents a range used by the <see cref="T:Microsoft.Azure.Documents.Partitioning.RangePartitionResolver`1" /> class in the Azure DocumentDB database service.
</remarks>
</Docs>
</Member>
</Members>
</Type>