honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

adjust SearchExtBuilder javadocs

This commit is contained in:
javanna 2016-09-09 21:17:16 +02:00 committed by Luca Cavanna
parent 90ab460fcc
commit 17d48c1ff6
2 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
core/src/main/java/org/elasticsearch/search/SearchExtBuilder.java
View File

@ -20,25 +20,28 @@
package org.elasticsearch.search; package org.elasticsearch.search;
import org.elasticsearch.common.io.stream.NamedWriteable; import org.elasticsearch.common.io.stream.NamedWriteable;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput; import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.common.io.stream.Writeable;
import org.elasticsearch.common.xcontent.ToXContent; import org.elasticsearch.common.xcontent.ToXContent;
import org.elasticsearch.plugins.SearchPlugin; import org.elasticsearch.plugins.SearchPlugin;
import org.elasticsearch.plugins.SearchPlugin.SearchExtSpec;
/** /**
* Intermediate serializable representation of a search ext section. To be subclassed by plugins that support * Intermediate serializable representation of a search ext section. To be subclassed by plugins that support
* a custom section as part of a search request, which will be provided within the ext element. * a custom section as part of a search request, which will be provided within the ext element.
* Any state needs to be serialized as part of the {@link org.elasticsearch.common.io.stream.Writeable#writeTo(StreamOutput)} method and * Any state needs to be serialized as part of the {@link Writeable#writeTo(StreamOutput)} method and
* read from the incoming stream, usually done adding a constructor that takes {@link org.elasticsearch.common.io.stream.StreamInput} as * read from the incoming stream, usually done adding a constructor that takes {@link StreamInput} as
* an argument. * an argument.
* *
* Registration happens through {@link SearchPlugin#getSearchExts()}, which also needs a {@link SearchExtParser} that's able to parse * Registration happens through {@link SearchPlugin#getSearchExts()}, which also needs a {@link SearchExtParser} that's able to parse
* the incoming request from the REST layer into the proper {@link SearchExtBuilder} subclass. * the incoming request from the REST layer into the proper {@link SearchExtBuilder} subclass.
* *
* {@link #getWriteableName()} must return the same name as the one used for the registration * {@link #getWriteableName()} must return the same name as the one used for the registration
* of the {@link org.elasticsearch.plugins.SearchPlugin.SearchExtSpec}. * of the {@link SearchExtSpec}.
* *
* @see SearchExtParser * @see SearchExtParser
* @see org.elasticsearch.plugins.SearchPlugin.SearchExtSpec * @see SearchExtSpec
*/ */
public abstract class SearchExtBuilder implements NamedWriteable, ToXContent { public abstract class SearchExtBuilder implements NamedWriteable, ToXContent {