Stay organized with collections
Save and categorize content based on your preferences.
UploadDataSink
public
abstract
class
UploadDataSink
extends Object
Defines callbacks methods for UploadDataProvider
. All methods may be called synchronously
or asynchronously, on any thread.
Summary
Inherited methods |
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object .
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait(long timeoutMillis, int nanos)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait(long timeoutMillis)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait()
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted.
|
|
Public constructors
UploadDataSink
public UploadDataSink ()
Public methods
onReadError
public abstract void onReadError (Exception exception)
Called by UploadDataProvider
when a read fails.
Parameters |
exception |
Exception : Exception passed on to the embedder.
This value cannot be null . |
onReadSucceeded
public abstract void onReadSucceeded (boolean finalChunk)
Called by UploadDataProvider
when a read succeeds.
Parameters |
finalChunk |
boolean : For chunked uploads, true if this is the final read. It must be
false for non-chunked uploads. |
onRewindError
public abstract void onRewindError (Exception exception)
Called by UploadDataProvider
when a rewind fails, or if rewinding uploads is not
supported.
Parameters |
exception |
Exception : Exception passed on to the embedder.
This value cannot be null . |
onRewindSucceeded
public abstract void onRewindSucceeded ()
Called by UploadDataProvider
when a rewind succeeds.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[null,null,["Last updated 2025-02-10 UTC."],[],[],null,["# UploadDataSink\n\nAdded in [API level 34](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nAlso in [S Extensions 7](/sdkExtensions) \nSummary: [Ctors](#pubctors) \\| [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nUploadDataSink\n==============\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/net/http/UploadDataSink \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\n\n\nabstract\nclass\nUploadDataSink\n`\n\n\n`\n\nextends `[Object](/reference/java/lang/Object)`\n\n\n`\n\n`\n\n\n`\n\n|---|---------------------------------|\n| [java.lang.Object](/reference/java/lang/Object) ||\n| ↳ | android.net.http.UploadDataSink |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nDefines callbacks methods for [UploadDataProvider](/reference/android/net/http/UploadDataProvider). All methods may be called synchronously\nor asynchronously, on any thread.\n\nSummary\n-------\n\n| ### Public constructors ||\n|---------------------------------------------------------------------------------------|---|\n| ` `[UploadDataSink](/reference/android/net/http/UploadDataSink#UploadDataSink())`() ` |\n\n| ### Public methods ||\n|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` abstract void` | ` `[onReadError](/reference/android/net/http/UploadDataSink#onReadError(java.lang.Exception))`(`[Exception](/reference/java/lang/Exception)` exception) ` Called by [UploadDataProvider](/reference/android/net/http/UploadDataProvider) when a read fails. |\n| ` abstract void` | ` `[onReadSucceeded](/reference/android/net/http/UploadDataSink#onReadSucceeded(boolean))`(boolean finalChunk) ` Called by [UploadDataProvider](/reference/android/net/http/UploadDataProvider) when a read succeeds. |\n| ` abstract void` | ` `[onRewindError](/reference/android/net/http/UploadDataSink#onRewindError(java.lang.Exception))`(`[Exception](/reference/java/lang/Exception)` exception) ` Called by [UploadDataProvider](/reference/android/net/http/UploadDataProvider) when a rewind fails, or if rewinding uploads is not supported. |\n| ` abstract void` | ` `[onRewindSucceeded](/reference/android/net/http/UploadDataSink#onRewindSucceeded())`() ` Called by [UploadDataProvider](/reference/android/net/http/UploadDataProvider) when a rewind succeeds. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` `[java.lang.Object](/reference/java/lang/Object)` ` |---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](/reference/java/lang/Object) | ` `[clone](/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](/reference/java/lang/Object)` obj) ` Indicates whether some other object is \"equal to\" this one. | | ` void` | ` `[finalize](/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](/reference/java/lang/Class)`\u003c?\u003e` | ` `[getClass](/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`. | | ` int` | ` `[hashCode](/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](/reference/java/lang/String) | ` `[toString](/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||\n\nPublic constructors\n-------------------\n\n### UploadDataSink\n\nAdded in [API level 34](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nAlso in [S Extensions 7](/sdkExtensions) \n\n```\npublic UploadDataSink ()\n```\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nPublic methods\n--------------\n\n### onReadError\n\nAdded in [API level 34](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nAlso in [S Extensions 7](/sdkExtensions) \n\n```\npublic abstract void onReadError (Exception exception)\n```\n\nCalled by [UploadDataProvider](/reference/android/net/http/UploadDataProvider) when a read fails.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------|\n| `exception` | `Exception`: Exception passed on to the embedder. This value cannot be `null`. \u003cbr /\u003e |\n\n### onReadSucceeded\n\nAdded in [API level 34](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nAlso in [S Extensions 7](/sdkExtensions) \n\n```\npublic abstract void onReadSucceeded (boolean finalChunk)\n```\n\nCalled by [UploadDataProvider](/reference/android/net/http/UploadDataProvider) when a read succeeds.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|--------------|----------------------------------------------------------------------------------------------------------------------|\n| `finalChunk` | `boolean`: For chunked uploads, `true` if this is the final read. It must be `false` for non-chunked uploads. \u003cbr /\u003e |\n\n### onRewindError\n\nAdded in [API level 34](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nAlso in [S Extensions 7](/sdkExtensions) \n\n```\npublic abstract void onRewindError (Exception exception)\n```\n\nCalled by [UploadDataProvider](/reference/android/net/http/UploadDataProvider) when a rewind fails, or if rewinding uploads is not\nsupported.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------|\n| `exception` | `Exception`: Exception passed on to the embedder. This value cannot be `null`. \u003cbr /\u003e |\n\n### onRewindSucceeded\n\nAdded in [API level 34](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nAlso in [S Extensions 7](/sdkExtensions) \n\n```\npublic abstract void onRewindSucceeded ()\n```\n\nCalled by [UploadDataProvider](/reference/android/net/http/UploadDataProvider) when a rewind succeeds.\n\n\u003cbr /\u003e"]]