DocumentMessage (documentapi 7.559.12 API)

java.lang.Object
- com.yahoo.messagebus.Routable
- - com.yahoo.messagebus.Message
  - - com.yahoo.documentapi.messagebus.protocol.DocumentMessage

Direct Known Subclasses:

CreateVisitorMessage, DestroyVisitorMessage, GetBucketListMessage, GetBucketStateMessage, GetDocumentMessage, RemoveLocationMessage, StatBucketMessage, TestAndSetMessage, VisitorMessage
```
public abstract class DocumentMessage
extends com.yahoo.messagebus.Message
```
Author:

Simon Thoresen Hult

Constructor Summary

Constructors
Constructor Description

DocumentMessage()
Constructs a new message with no content.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract DocumentReply`	`createReply()`	Creates and returns a reply to this message.
`int`	`getApproxSize()`
`LoadType`	`getLoadType()`
`DocumentProtocol.Priority`	`getPriority()`	Returns the priority tag for this message.
`com.yahoo.text.Utf8String`	`getProtocol()`
`void`	`setLoadType(LoadType loadType)`
`void`	`setPriority(DocumentProtocol.Priority priority)`	Sets the priority tag for this message.
`void`	`swapState(com.yahoo.messagebus.Routable rhs)`

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, getType, popHandler, pushHandler, setContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DocumentMessage
```
public DocumentMessage()
```
    Constructs a new message with no content.
- Method Detail
  - createReply
```
public abstract DocumentReply createReply()
```
    Creates and returns a reply to this message.
    
    Returns:
    
    The created reply.
  - swapState
```
public void swapState(com.yahoo.messagebus.Routable rhs)
```
    Overrides:
    
    swapState in class com.yahoo.messagebus.Message
  - getPriority
```
public DocumentProtocol.Priority getPriority()
```
    Returns the priority tag for this message. This is an optional tag added for VDS that is not interpreted by the document protocol.
    
    Returns:
    
    The priority.
  - setPriority
```
public void setPriority(DocumentProtocol.Priority priority)
```
    Sets the priority tag for this message.
    
    Parameters:
    
    priority - The priority to set.
  - getLoadType
```
public LoadType getLoadType()
```
  - setLoadType
```
public void setLoadType(LoadType loadType)
```
  - getApproxSize
```
public int getApproxSize()
```
    Overrides:
    
    getApproxSize in class com.yahoo.messagebus.Message
  - getProtocol
```
public com.yahoo.text.Utf8String getProtocol()
```
    Specified by:
    
    getProtocol in class com.yahoo.messagebus.Routable