com.sap.cloud.server.odata

Class EntityStream

java.lang.Object

com.sap.cloud.server.odata.EntityStream

public class EntityStream
extends java.lang.Object

A stream of entity values.

See Also:

DataService.entityStream, DeltaStream.

Method Summary

Modifier and Type	Method and Description
void	abort() Close this stream and release all associated resources, without checking first that the end of stream has been reached.
void	close() Close this stream and release all associated resources, checking first that the end of stream has been reached.
java.lang.String	getDeltaLink() Return (nullable) The delta-link (if any) that was encountered when EntityStream.next was called repeatedly until end of stream and then EntityStream.close was called, otherwise null.
java.lang.String	getNextLink() Return (nullable) The next-link (if any) that was encountered when EntityStream.next was called repeatedly until end of stream and then EntityStream.close was called, otherwise null.
java.lang.String	getReadLink() Return (nullable) The read-link (if any) that was encountered when EntityStream.next was called repeatedly until end of stream and then EntityStream.close was called, otherwise null.
boolean	hasNext() Return true If this stream has not been EntityStream.close and has a next entity value.
boolean	isClosed() Return has EntityStream.close been called?
EntityValue	next() Return the next entity value in this stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

abort

public void abort()

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

See Also:

EntityStream.close.

close

public void 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 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 EntityStream.nextLink property only after the stream is closed.

See Also:

EntityStream.abort.

getDeltaLink

public java.lang.String getDeltaLink()

Return (nullable) The delta-link (if any) that was encountered when EntityStream.next was called repeatedly until end of stream and then EntityStream.close was called, otherwise null.

Returns:

(nullable) The delta-link (if any) that was encountered when EntityStream.next was called repeatedly until end of stream and then EntityStream.close was called, otherwise null.

getNextLink

public java.lang.String getNextLink()

Return (nullable) The next-link (if any) that was encountered when EntityStream.next was called repeatedly until end of stream and then EntityStream.close was called, otherwise null.

Returns:

(nullable) The next-link (if any) that was encountered when EntityStream.next was called repeatedly until end of stream and then EntityStream.close was called, otherwise null.

getReadLink

public java.lang.String getReadLink()

Return (nullable) The read-link (if any) that was encountered when EntityStream.next was called repeatedly until end of stream and then EntityStream.close was called, otherwise null.

Returns:

(nullable) The read-link (if any) that was encountered when EntityStream.next was called repeatedly until end of stream and then EntityStream.close was called, otherwise null.

hasNext

public boolean hasNext()

Return true If this stream has not been EntityStream.close and has a next entity value. Otherwise return false.

Returns:

True If this stream has not been EntityStream.close and has a next entity value. Otherwise return false.

isClosed

public boolean isClosed()

Return has EntityStream.close been called?

Returns:

Has EntityStream.close been called?

next

public EntityValue next()

Return the next entity value in this stream. Only call this if a previous call to EntityStream.hasNext returned true.

Returns:

The next entity value in this stream.