Package com.yahoo.documentapi.messagebus.protocol

Class RemoveDocumentMessage

  • public class RemoveDocumentMessage
extends TestAndSetMessage
    Author:
    Simon Thoresen Hult

    • Constructor Summary

      Constructors 
      Constructor Description
      RemoveDocumentMessage​(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

      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.TestAndSetCondition getCondition()  
      com.yahoo.document.DocumentId getDocumentId()
      Returns the identifier of the document to remove.
      com.yahoo.document.DocumentRemove getDocumentRemove()  
      long getSequenceId()  
      int getType()  
      boolean hasSequenceId()  
      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.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

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • 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 Detail

      • 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.

      • hasSequenceId

        public boolean hasSequenceId()
        Overrides:
        hasSequenceId in class com.yahoo.messagebus.Message

      • getSequenceId

        public long getSequenceId()
        Overrides:
        getSequenceId in class com.yahoo.messagebus.Message

      • getType

        public int getType()
        Specified by:
        getType in class com.yahoo.messagebus.Routable

      • setCondition

        public void setCondition​(com.yahoo.document.TestAndSetCondition condition)
        Specified by:
        setCondition in class TestAndSetMessage

      • getDocumentRemove

        public com.yahoo.document.DocumentRemove getDocumentRemove()