-
Notifications
You must be signed in to change notification settings - Fork 221
/
com.azure.core.http.HttpRange.yml
105 lines (105 loc) · 7.05 KB
/
com.azure.core.http.HttpRange.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
### YamlMime:JavaType
uid: "com.azure.core.http.HttpRange"
fullName: "com.azure.core.http.HttpRange"
name: "HttpRange"
nameWithType: "HttpRange"
summary: "Represents a range of bytes within an HTTP resource."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **HttpRange**"
constructors:
- uid: "com.azure.core.http.HttpRange.HttpRange(long)"
fullName: "com.azure.core.http.HttpRange.HttpRange(long offset)"
name: "HttpRange(long offset)"
nameWithType: "HttpRange.HttpRange(long offset)"
summary: "Creates an instance of <xref uid=\"com.azure.core.http.HttpRange\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpRange\"></xref>."
parameters:
- description: "The offset to begin the range."
name: "offset"
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
syntax: "public HttpRange(long offset)"
desc: "Creates an instance of <xref uid=\"com.azure.core.http.HttpRange\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpRange\"></xref>.\n\nThis creates a range which has an unbounded length starting at the specified `offset`."
- uid: "com.azure.core.http.HttpRange.HttpRange(long,java.lang.Long)"
fullName: "com.azure.core.http.HttpRange.HttpRange(long offset, Long length)"
name: "HttpRange(long offset, Long length)"
nameWithType: "HttpRange.HttpRange(long offset, Long length)"
summary: "Creates an instance of <xref uid=\"com.azure.core.http.HttpRange\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpRange\"></xref>."
parameters:
- description: "The offset to begin the range."
name: "offset"
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- description: "The length of the range."
name: "length"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
syntax: "public HttpRange(long offset, Long length)"
desc: "Creates an instance of <xref uid=\"com.azure.core.http.HttpRange\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpRange\"></xref>."
methods:
- uid: "com.azure.core.http.HttpRange.equals(java.lang.Object)"
fullName: "com.azure.core.http.HttpRange.equals(Object obj)"
name: "equals(Object obj)"
nameWithType: "HttpRange.equals(Object obj)"
overridden: "java.lang.Object.equals(java.lang.Object)"
parameters:
- name: "obj"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
syntax: "public boolean equals(Object obj)"
returns:
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.http.HttpRange.getLength()"
fullName: "com.azure.core.http.HttpRange.getLength()"
name: "getLength()"
nameWithType: "HttpRange.getLength()"
summary: "Gets the length of the range."
syntax: "public Long getLength()"
desc: "Gets the length of the range.\n\nIf the length is null the range continues to the end of the HTTP resource."
returns:
description: "Length of the range or null if range continues to the end of the HTTP resource."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
- uid: "com.azure.core.http.HttpRange.getOffset()"
fullName: "com.azure.core.http.HttpRange.getOffset()"
name: "getOffset()"
nameWithType: "HttpRange.getOffset()"
summary: "Gets the offset of the range."
syntax: "public long getOffset()"
desc: "Gets the offset of the range."
returns:
description: "Offset of the range."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.http.HttpRange.hashCode()"
fullName: "com.azure.core.http.HttpRange.hashCode()"
name: "hashCode()"
nameWithType: "HttpRange.hashCode()"
overridden: "java.lang.Object.hashCode()"
syntax: "public int hashCode()"
returns:
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.http.HttpRange.toString()"
fullName: "com.azure.core.http.HttpRange.toString()"
name: "toString()"
nameWithType: "HttpRange.toString()"
summary: "Gets the string representation of the range."
overridden: "java.lang.Object.toString()"
syntax: "public String toString()"
desc: "Gets the string representation of the range.\n\nIf length is null the returned string will be `\"bytes=-\"`, if length is not null the returned string will be `\"bytes=-\"`."
returns:
description: "The string representation of the range."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
type: "class"
desc: "Represents a range of bytes within an HTTP resource.\n\nThis class encapsulates a range of bytes that can be requested from an HTTP resource. The range starts at the <xref uid=\"com.azure.core.http.HttpRange.getOffset()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getOffset()\"></xref> inclusively and ends at <xref uid=\"com.azure.core.http.HttpRange.getOffset()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getOffset()\"></xref> \\+ <xref uid=\"com.azure.core.http.HttpRange.getLength()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getLength()\"></xref> exclusively, or offset + length - 1.\n\nIf <xref uid=\"com.azure.core.http.HttpRange.getLength()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getLength()\"></xref> is unspecified or null, the range extends to the end of the HTTP resource.\n\nThis class is useful when you want to request a specific range of bytes from an HTTP resource, such as a part of a file. For example, you can use it to download a part of a file, to resume a download, or to stream a video from a specific point."
metadata: {}
package: "com.azure.core.http"
artifact: com.azure:azure-core:1.49.1