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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DocumentReply
createReply()
Creates and returns a reply to this message.int
getApproxSize()
com.yahoo.document.BucketId
getBucketId()
java.util.List<DocumentListEntry>
getDocuments()
int
getType()
void
setBucketId(com.yahoo.document.BucketId id)
java.lang.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
-
-
-
-
Constructor Detail
-
DocumentListMessage
public DocumentListMessage()
-
DocumentListMessage
public DocumentListMessage(DocumentListMessage cmd)
-
-
Method Detail
-
getBucketId
public com.yahoo.document.BucketId getBucketId()
-
setBucketId
public void setBucketId(com.yahoo.document.BucketId id)
-
getDocuments
public java.util.List<DocumentListEntry> getDocuments()
-
createReply
public DocumentReply createReply()
Description copied from class:DocumentMessage
Creates and returns a reply to this message.- Specified by:
createReply
in classDocumentMessage
- Returns:
- The created reply.
-
getType
public int getType()
- Specified by:
getType
in classcom.yahoo.messagebus.Routable
-
getApproxSize
public int getApproxSize()
- Overrides:
getApproxSize
in classDocumentMessage
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-