com.yahoo.persistence.spi.result

Class IterateResult

java.lang.Object

com.yahoo.persistence.spi.result.Result

com.yahoo.persistence.spi.result.IterateResult

public class IterateResult
extends Result

Result class for iterate requests

Nested Class Summary

Nested classes/interfaces inherited from class com.yahoo.persistence.spi.result.Result

Result.ErrorType

Field Summary

Fields

Modifier and Type	Field and Description
(package private) List<DocEntry>	entries
(package private) boolean	isCompleted

Fields inherited from class com.yahoo.persistence.spi.result.Result

message, type

Constructor Summary

Constructors

Constructor and Description
IterateResult(List<DocEntry> entries, boolean isCompleted) Creates a successful result.
IterateResult(Result.ErrorType type, String message) Creates a result with an error.

Method Summary

Modifier and Type	Method and Description
List<DocEntry>	getEntries()
boolean	isCompleted()

Methods inherited from class com.yahoo.persistence.spi.result.Result

equals, equals, getErrorMessage, getErrorType, hasError, toString

Methods inherited from class java.lang.Object

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

Field Detail

entries

List<DocEntry> entries

isCompleted

boolean isCompleted

Constructor Detail

IterateResult

public IterateResult(Result.ErrorType type,
                     String message)

Creates a result with an error.

Parameters:

type - The type of error

message - A human-readable error message to further detail the error.

IterateResult

public IterateResult(List<DocEntry> entries,
                     boolean isCompleted)

Creates a successful result.

Parameters:

entries - The next chunk of entries that were found during iteration.

isCompleted - Set to true if there are no more entries to iterate through.

Method Detail

getEntries

public List<DocEntry> getEntries()

isCompleted

public boolean isCompleted()