com.microsoft.azure.storage

Class ResultSegment<T>

java.lang.Object

com.microsoft.azure.storage.ResultSegment<T>

Type Parameters:

T - The type of the result that the segment contains.

public class ResultSegment<T>
extends Object

Represents a segment of results and contains continuation and pagination information.

Constructor Summary

Constructors

Constructor and Description
ResultSegment(ArrayList<T> results, Integer pageSize, ResultContinuation token) Reserved for internal use.

Method Summary

Modifier and Type	Method and Description
ResultContinuation	getContinuationToken() Returns the continuation token for the result segment.
boolean	getHasMoreResults() Returns a value that indicates whether there are more results available from the server.
boolean	getIsPageComplete() Returns a value that indicates whether the page has more results.
int	getLength() Returns the number of results in the segment.
Integer	getPageSize() Returns the size of the requested page.
int	getRemainingPageResults() Returns the count of remaining results needed to fulfill the requested page size.
ArrayList<T>	getResults() Returns an enumerable set of results from the service.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultSegment

public ResultSegment(ArrayList<T> results,
                     Integer pageSize,
                     ResultContinuation token)

Reserved for internal use. Creates an instance of the ResultSegment class.

Parameters:

results - An ArrayList object that represents the results for the segment.

pageSize - The number of elements in a page of results.

token - A ResultContinuation object that represents the continuation token.

Method Detail

getContinuationToken

public ResultContinuation getContinuationToken()

Returns the continuation token for the result segment.

Returns:

A ResultContinuation object that represents the continuation token.

getHasMoreResults

public boolean getHasMoreResults()

Returns a value that indicates whether there are more results available from the server.

Returns:

true if there are more results available from the server; otherwise, false.

getIsPageComplete

public boolean getIsPageComplete()

Returns a value that indicates whether the page has more results.

Returns:

true if the page has more results; otherwise, false.

getLength

public int getLength()

Returns the number of results in the segment.

Returns:

The actual number of the results in the segment.

getPageSize

public Integer getPageSize()

Returns the size of the requested page.

Returns:

The size of the requested page.

getRemainingPageResults

public int getRemainingPageResults()

Returns the count of remaining results needed to fulfill the requested page size.

Returns:

The count of remaining results needed to fulfill the requested page size.

getResults

public ArrayList<T> getResults()

Returns an enumerable set of results from the service.

Returns:

The results retrieved from the service.