Package com.yahoo.documentapi.messagebus.protocol

Class UpdateDocumentMessage

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.UpdateDocumentMessage
public class UpdateDocumentMessage extends TestAndSetMessage
Author:
Simon Thoresen Hult

  • Constructor Details

    • UpdateDocumentMessage

      public UpdateDocumentMessage(LazyDecoder decoder, com.yahoo.document.serialization.DocumentDeserializer buffer)
      Constructs a new message from a byte buffer.
      Parameters:
      decoder - The decoder to use for deserialization.
      buffer - A byte buffer that contains a serialized message.

    • UpdateDocumentMessage

      public UpdateDocumentMessage(com.yahoo.document.DocumentUpdate upd)
      Constructs a new document update message.
      Parameters:
      upd - The document update to perform.

  • Method Details

    • createEmpty

      public static UpdateDocumentMessage createEmpty()
      Creates an empty UpdateDocumentMessage

    • getDocumentUpdate

      public com.yahoo.document.DocumentUpdate getDocumentUpdate()
      Returns the document update to perform.
      Returns:
      The update.

    • setDocumentUpdate

      public void setDocumentUpdate(com.yahoo.document.DocumentUpdate upd)
      Sets the document update to perform.
      Parameters:
      upd - The document update to set.

    • getOldTimestamp

      public long getOldTimestamp()
      Returns the timestamp required for this update to be applied.
      Returns:
      The document timestamp.

    • setOldTimestamp

      public void setOldTimestamp(long time)
      Sets the timestamp required for this update to be applied.
      Parameters:
      time - The timestamp to set.

    • getNewTimestamp

      public long getNewTimestamp()
      Returns the timestamp to assign to the updated document.
      Returns:
      The document timestamp.

    • setNewTimestamp

      public void setNewTimestamp(long time)
      Sets the timestamp to assign to the updated document.
      Parameters:
      time - The timestamp to set.

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

    • 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

    • getCondition

      public com.yahoo.document.TestAndSetCondition getCondition()
      Specified by:
      getCondition in class TestAndSetMessage

    • setCondition

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