Class RemoveDocumentMessage
java.lang.Object
com.yahoo.messagebus.Routable
com.yahoo.messagebus.Message
com.yahoo.documentapi.messagebus.protocol.DocumentMessage
com.yahoo.documentapi.messagebus.protocol.TestAndSetMessage
com.yahoo.documentapi.messagebus.protocol.RemoveDocumentMessage
- Author:
- Simon Thoresen Hult
-
Constructor Summary
ConstructorDescriptionRemoveDocumentMessage
(com.yahoo.document.DocumentId documentId) Constructs a new document remove message.RemoveDocumentMessage
(com.yahoo.document.DocumentRemove remove) Constructs a new document remove message. -
Method Summary
Modifier and TypeMethodDescriptionCreates and returns a reply to this message.int
com.yahoo.document.TestAndSetCondition
com.yahoo.document.DocumentId
Returns the identifier of the document to remove.com.yahoo.document.DocumentRemove
long
int
getType()
boolean
void
setCondition
(com.yahoo.document.TestAndSetCondition condition) void
setDocumentId
(com.yahoo.document.DocumentId documentId) Sets the identifier of the document to remove.Methods inherited from class com.yahoo.documentapi.messagebus.protocol.DocumentMessage
getPriority, getProtocol, setPriority, swapState
Methods inherited from class com.yahoo.messagebus.Message
getBucketSequence, getRetry, getRetryEnabled, getRoute, getTimeReceived, getTimeRemaining, getTimeRemainingNow, hasBucketSequence, isExpired, setRetry, setRetryEnabled, setRoute, setTimeReceived, setTimeReceivedNow, setTimeRemaining
Methods inherited from class com.yahoo.messagebus.Routable
discard, getCallStack, getContext, getTrace, popHandler, pushHandler, setContext
-
Constructor Details
-
RemoveDocumentMessage
public RemoveDocumentMessage(com.yahoo.document.DocumentId documentId) Constructs a new document remove message.- Parameters:
documentId
- The identifier of the document to remove.
-
RemoveDocumentMessage
public RemoveDocumentMessage(com.yahoo.document.DocumentRemove remove) Constructs a new document remove message.- Parameters:
remove
- The DocumentRemove operation to perform
-
-
Method Details
-
getDocumentId
public com.yahoo.document.DocumentId getDocumentId()Returns the identifier of the document to remove.- Returns:
- The document id.
-
setDocumentId
public void setDocumentId(com.yahoo.document.DocumentId documentId) Sets the identifier of the document to remove.- Parameters:
documentId
- The document id to set.
-
createReply
Description copied from class:DocumentMessage
Creates and returns a reply to this message.- Specified by:
createReply
in classDocumentMessage
- Returns:
- The created reply.
-
getApproxSize
public int getApproxSize()- Overrides:
getApproxSize
in classDocumentMessage
-
hasSequenceId
public boolean hasSequenceId()- Overrides:
hasSequenceId
in classcom.yahoo.messagebus.Message
-
getSequenceId
public long getSequenceId()- Overrides:
getSequenceId
in classcom.yahoo.messagebus.Message
-
getType
public int getType()- Specified by:
getType
in classcom.yahoo.messagebus.Routable
-
setCondition
public void setCondition(com.yahoo.document.TestAndSetCondition condition) - Specified by:
setCondition
in classTestAndSetMessage
-
getCondition
public com.yahoo.document.TestAndSetCondition getCondition()- Specified by:
getCondition
in classTestAndSetMessage
-
getDocumentRemove
public com.yahoo.document.DocumentRemove getDocumentRemove()
-