ResultSegment<T> Class

  • Reference
Package:
com.microsoft.azure.storage
  • java.lang.Object
    • com.microsoft.azure.storage.ResultSegment<T>

Type Parameters

T

The type of the result that the segment contains.

public class ResultSegment

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

Constructor Summary

Constructor Description
ResultSegment(final ArrayList<T> results, final Integer pageSize, final ResultContinuation token)

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

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.

Constructor Details

ResultSegment

public ResultSegment(final ArrayList results, final Integer pageSize, final ResultContinuation token)

Reserved for internal use. Creates an instance of the 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 Details

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 getResults()

Returns an enumerable set of results from the service.

Returns:

The results retrieved from the service.

Applies to