Package com.yahoo.documentapi
Class DocumentResponse
- java.lang.Object
-
- com.yahoo.documentapi.Response
-
- com.yahoo.documentapi.DocumentResponse
-
public class DocumentResponse extends Response
The asynchronous response to a document put or get operation. This is a value object.- Author:
- Einar M R Rosenvinge
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.yahoo.documentapi.Response
Response.Outcome
-
-
Constructor Summary
Constructors Constructor Description DocumentResponse(long requestId)
Creates a successful responseDocumentResponse(long requestId, com.yahoo.document.Document document)
Creates a successful response containing a documentDocumentResponse(long requestId, com.yahoo.document.Document document, com.yahoo.messagebus.Trace trace)
Creates a successful response containing a documentDocumentResponse(long requestId, com.yahoo.document.Document document, java.lang.String textMessage, boolean success)
Deprecated.DocumentResponse(long requestId, com.yahoo.document.Document document, java.lang.String textMessage, Response.Outcome outcome)
Creates a response containing a textual message and/or a documentDocumentResponse(long requestId, com.yahoo.document.Document document, java.lang.String textMessage, Response.Outcome outcome, com.yahoo.messagebus.Trace trace)
Creates a response containing a textual message and/or a documentDocumentResponse(long requestId, java.lang.String textMessage, boolean success)
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object o)
com.yahoo.document.Document
getDocument()
Returns the document of this response, or null if there is noneint
hashCode()
boolean
isSuccess()
Returns whether this response encodes a success or a failurejava.lang.String
toString()
-
Methods inherited from class com.yahoo.documentapi.Response
getRequestId, getTextMessage, getTrace, outcome
-
-
-
-
Constructor Detail
-
DocumentResponse
public DocumentResponse(long requestId)
Creates a successful response
-
DocumentResponse
public DocumentResponse(long requestId, com.yahoo.document.Document document)
Creates a successful response containing a document- Parameters:
document
- the Document to encapsulate in the Response
-
DocumentResponse
public DocumentResponse(long requestId, com.yahoo.document.Document document, com.yahoo.messagebus.Trace trace)
Creates a successful response containing a document- Parameters:
document
- the Document to encapsulate in the Response
-
DocumentResponse
@Deprecated(since="7") public DocumentResponse(long requestId, java.lang.String textMessage, boolean success)
Deprecated.Creates a response containing a textual message- Parameters:
textMessage
- the message to encapsulate in the Responsesuccess
- true if the response represents a successful call
-
DocumentResponse
@Deprecated(since="7") public DocumentResponse(long requestId, com.yahoo.document.Document document, java.lang.String textMessage, boolean success)
Deprecated.Creates a response containing a textual message and/or a document- Parameters:
document
- the Document to encapsulate in the ResponsetextMessage
- the message to encapsulate in the Responsesuccess
- true if the response represents a successful call
-
DocumentResponse
public DocumentResponse(long requestId, com.yahoo.document.Document document, java.lang.String textMessage, Response.Outcome outcome)
Creates a response containing a textual message and/or a document- Parameters:
document
- the Document to encapsulate in the ResponsetextMessage
- the message to encapsulate in the Responseoutcome
- the outcome of this operation
-
DocumentResponse
public DocumentResponse(long requestId, com.yahoo.document.Document document, java.lang.String textMessage, Response.Outcome outcome, com.yahoo.messagebus.Trace trace)
Creates a response containing a textual message and/or a document- Parameters:
document
- the Document to encapsulate in the ResponsetextMessage
- the message to encapsulate in the Responseoutcome
- the outcome of this operation
-
-
Method Detail
-
getDocument
public com.yahoo.document.Document getDocument()
Returns the document of this response, or null if there is none- Returns:
- the Document, or null
-
isSuccess
public boolean isSuccess()
Description copied from class:Response
Returns whether this response encodes a success or a failure
-
-