EntityStream

open class EntityStream

A stream of entity values.

See Also:

DataService.entityStream, {@link com.sap.cloud.mobile.kotlin.odata.DeltaStream}.

Properties

Link copied to clipboard
open val deltaLink: String?
Link copied to clipboard
open val isClosed: Boolean
Link copied to clipboard
open val nextLink: String?
Link copied to clipboard
open val readLink: String?

Functions

Link copied to clipboard
open fun abort()

Close this stream and release all associated resources, without checking first that the end of stream has been reached.

See Also:

{@link com.sap.cloud.mobile.kotlin.odata.EntityStream#close() EntityStream.close}.

Link copied to clipboard
open fun close()

Close this stream and release all associated resources, checking first that the end of stream has been reached. Can safely be called even if the stream was previously closed. If a delta link was encountered before the stream was closed, it will be available via the {@link com.sap.cloud.mobile.kotlin.odata.EntityStream#deltaLink EntityStream.deltaLink} property only after the stream is closed. If a next link was encountered before the stream was closed, it will be available via the {@link com.sap.cloud.mobile.kotlin.odata.EntityStream#nextLink EntityStream.nextLink} property only after the stream is closed.

See Also:

{@link com.sap.cloud.mobile.kotlin.odata.EntityStream#abort() EntityStream.abort}.

Link copied to clipboard
open fun hasNext(): Boolean

Return true If this stream has not been {@link com.sap.cloud.mobile.kotlin.odata.EntityStream#close() EntityStream.close} and has a next entity value. Otherwise return false.

Link copied to clipboard
open fun next(): EntityValue

Return the next entity value in this stream. Only call this if a previous call to {@link com.sap.cloud.mobile.kotlin.odata.EntityStream#hasNext() EntityStream.hasNext} returned true.