Package com.yahoo.documentapi.messagebus.protocol

Class DocumentListMessage

java.lang.Object

com.yahoo.messagebus.Routable

com.yahoo.messagebus.Message

com.yahoo.documentapi.messagebus.protocol.DocumentMessage

com.yahoo.documentapi.messagebus.protocol.VisitorMessage

com.yahoo.documentapi.messagebus.protocol.DocumentListMessage

public class DocumentListMessage
extends VisitorMessage

Constructor Summary

Constructors

Constructor	Description
DocumentListMessage()
DocumentListMessage(DocumentListMessage cmd)

Method Summary

Modifier and Type	Method	Description
DocumentReply	createReply()	Creates and returns a reply to this message.
int	getApproxSize()
com.yahoo.document.BucketId	getBucketId()
List<DocumentListEntry>	getDocuments()
int	getType()
void	setBucketId(com.yahoo.document.BucketId id)
String	toString()

Methods inherited from class com.yahoo.documentapi.messagebus.protocol.DocumentMessage

getLoadType, getPriority, getProtocol, setLoadType, setPriority, swapState

Methods inherited from class com.yahoo.messagebus.Message

getBucketSequence, getRetry, getRetryEnabled, getRoute, getSequenceId, getTimeReceived, getTimeRemaining, getTimeRemainingNow, hasBucketSequence, hasSequenceId, isExpired, setRetry, setRetryEnabled, setRoute, setTimeReceived, setTimeReceivedNow, setTimeRemaining

Methods inherited from class com.yahoo.messagebus.Routable

discard, getCallStack, getContext, getTrace, popHandler, pushHandler, setContext

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentListMessage

public DocumentListMessage()

DocumentListMessage

public DocumentListMessage(DocumentListMessage cmd)

Method Details

getBucketId

public com.yahoo.document.BucketId getBucketId()

setBucketId

public void setBucketId(com.yahoo.document.BucketId id)

getDocuments

public List<DocumentListEntry> getDocuments()

createReply

public DocumentReply createReply()

Description copied from class: DocumentMessage

Creates and returns a reply to this message.

Specified by:

createReply in class DocumentMessage

Returns:

The created reply.

getType

public int getType()

Specified by:

getType in class com.yahoo.messagebus.Routable

getApproxSize

public int getApproxSize()

Overrides:

getApproxSize in class DocumentMessage

toString

public String toString()

Overrides:

toString in class Object