Add javadoc for DocWriteResponse.Builders #23267
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
javanna
reviewed
Feb 20, 2017
| @@ -348,9 +348,11 @@ protected static void parseInnerToXContent(XContentParser parser, DocWriteRespon | |||
| } | |||
|
|
|||
| /** | |||
| * {@link DocWriteResponseBuilder} is used to build {@link DocWriteResponse} objects during XContent parsing. | |||
| * Base class of all {@link DocWriteResponse} builders. These {@link DocWriteResponse.Builder} are used during | |||
| * xcontent parsing to temporally store the parsed values, then the {@link Builder#build()} method is called to | |||
javanna
reviewed
Feb 20, 2017
| public static class DeleteResponseBuilder extends DocWriteResponse.DocWriteResponseBuilder { | ||
| /** | ||
| * Builder class for {@link DeleteResponse}. This builder is usually used during xcontent parsing to | ||
| * temporally store the parsed values, then the {@link DocWriteResponse.Builder#build()} method is called to |
javanna
reviewed
Feb 20, 2017
| public static class IndexResponseBuilder extends DocWriteResponse.DocWriteResponseBuilder { | ||
| /** | ||
| * Builder class for {@link IndexResponse}. This builder is usually used during xcontent parsing to | ||
| * temporally store the parsed values, then the {@link Builder#build()} method is called to |
javanna
reviewed
Feb 20, 2017
| public static class UpdateResponseBuilder extends DocWriteResponse.DocWriteResponseBuilder { | ||
| /** | ||
| * Builder class for {@link UpdateResponse}. This builder is usually used during xcontent parsing to | ||
| * temporally store the parsed values, then the {@link DocWriteResponse.Builder#build()} method is called to |
javanna
approved these changes
Feb 20, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add some comments for DocWriteResponse.Builders and rename the inner classes too.