-
Notifications
You must be signed in to change notification settings - Fork 241
/
com.azure.storage.blob.specialized.BlobInputStream.yml
83 lines (83 loc) · 7.24 KB
/
com.azure.storage.blob.specialized.BlobInputStream.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
### YamlMime:JavaType
uid: "com.azure.storage.blob.specialized.BlobInputStream"
fullName: "com.azure.storage.blob.specialized.BlobInputStream"
name: "BlobInputStream"
nameWithType: "BlobInputStream"
summary: "Provides an input stream to read a given blob resource."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.io.InputStream?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.storage.common.StorageInputStream?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.storage.common.StorageInputStream?alt=com.azure.storage.common.StorageInputStream&text=StorageInputStream\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.azure.storage.common.StorageInputStream.available()?alt=com.azure.storage.common.StorageInputStream.available&text=available\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.storage.common.StorageInputStream.close()?alt=com.azure.storage.common.StorageInputStream.close&text=close\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.storage.common.StorageInputStream.dispatchRead(int,long)?alt=com.azure.storage.common.StorageInputStream.dispatchRead&text=dispatchRead\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.storage.common.StorageInputStream.mark(int)?alt=com.azure.storage.common.StorageInputStream.mark&text=mark\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.storage.common.StorageInputStream.markSupported()?alt=com.azure.storage.common.StorageInputStream.markSupported&text=markSupported\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.storage.common.StorageInputStream.read()?alt=com.azure.storage.common.StorageInputStream.read&text=read\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.storage.common.StorageInputStream.read(byte[])?alt=com.azure.storage.common.StorageInputStream.read&text=read\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.storage.common.StorageInputStream.read(byte[],int,int)?alt=com.azure.storage.common.StorageInputStream.read&text=read\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.storage.common.StorageInputStream.reset()?alt=com.azure.storage.common.StorageInputStream.reset&text=reset\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.storage.common.StorageInputStream.skip(long)?alt=com.azure.storage.common.StorageInputStream.skip&text=skip\" data-throw-if-not-resolved=\"False\" />"
- classRef: "java.io.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html\">InputStream</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html#nullInputStream--\">nullInputStream</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html#readAllBytes--\">readAllBytes</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html#readNBytes-byte:A-int-int-\">readNBytes</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html#readNBytes-int-\">readNBytes</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html#skipNBytes-long-\">skipNBytes</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html#transferTo-java.io.OutputStream-\">transferTo</a>"
- 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 **BlobInputStream**</br> extends <xref href=\"com.azure.storage.common.StorageInputStream?alt=com.azure.storage.common.StorageInputStream&text=StorageInputStream\" data-throw-if-not-resolved=\"False\" />"
methods:
- uid: "com.azure.storage.blob.specialized.BlobInputStream.dispatchRead(int,long)"
fullName: "com.azure.storage.blob.specialized.BlobInputStream.dispatchRead(int readLength, long offset)"
name: "dispatchRead(int readLength, long offset)"
nameWithType: "BlobInputStream.dispatchRead(int readLength, long offset)"
summary: "Dispatches a read operation of N bytes."
modifiers:
- "protected"
- "synchronized"
overridden: "com.azure.storage.common.StorageInputStream.dispatchRead(int,long)"
parameters:
- description: "An <code>int</code> which represents the number of bytes to read."
name: "readLength"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- name: "offset"
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected synchronized ByteBuffer dispatchRead(int readLength, long offset)"
exceptions:
- description: "If an I/O error occurs."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Dispatches a read operation of N bytes. When using sparse page blobs, the page ranges are evaluated and zero bytes may be generated on the client side for some ranges that do not exist."
returns:
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html\">ByteBuffer</a>"
- uid: "com.azure.storage.blob.specialized.BlobInputStream.getProperties()"
fullName: "com.azure.storage.blob.specialized.BlobInputStream.getProperties()"
name: "getProperties()"
nameWithType: "BlobInputStream.getProperties()"
summary: "Gets the blob properties as fetched upon download."
syntax: "public BlobProperties getProperties()"
desc: "Gets the blob properties as fetched upon download."
returns:
description: "<xref uid=\"com.azure.storage.blob.models.BlobProperties\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobProperties\"></xref>"
type: "<xref href=\"com.azure.storage.blob.models.BlobProperties?alt=com.azure.storage.blob.models.BlobProperties&text=BlobProperties\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Provides an input stream to read a given blob resource."
metadata: {}
package: "com.azure.storage.blob.specialized"
artifact: com.azure:azure-storage-blob:12.27.1