Skip to content

Commit

Permalink
HSEARCH-2519 Add missing parameters in the javadoc of elasticsearch s…
Browse files Browse the repository at this point in the history
…chema helpers
  • Loading branch information
yrodiere authored and Sanne committed Jan 22, 2017
1 parent ded9943 commit fd9edd1
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 0 deletions.
Expand Up @@ -21,6 +21,7 @@ public interface ElasticsearchSchemaCreator extends Service {
* Create an index.
*
* @param indexMetadata The expected index metadata.
* @param executionOptions The execution options, giving more context information.
* @throws SearchException If an error occurs.
*/
void createIndex(IndexMetadata indexMetadata, ExecutionOptions executionOptions);
Expand All @@ -29,6 +30,7 @@ public interface ElasticsearchSchemaCreator extends Service {
* Create an index, but only if the index doesn't already exist.
*
* @param indexMetadata The expected index metadata.
* @param executionOptions The execution options, giving more context information.
* @return {@code true} if the index had to be created, {@code false} otherwise.
* @throws SearchException If an error occurs.
*/
Expand All @@ -38,6 +40,7 @@ public interface ElasticsearchSchemaCreator extends Service {
* Checks that an index already exists.
*
* @param indexname The expected index name.
* @param executionOptions The execution options, giving more context information.
* @throws SearchException If the index doesn't exist, or if an error occurs.
*/
void checkIndexExists(String indexname, ExecutionOptions executionOptions);
Expand All @@ -48,6 +51,7 @@ public interface ElasticsearchSchemaCreator extends Service {
* <p>Mappings are supposed to be absent from the index.
*
* @param indexMetadata The expected index metadata.
* @param executionOptions The execution options, giving more context information.
* @throws SearchException If an error occurs.
*/
void createMappings(IndexMetadata indexMetadata, ExecutionOptions executionOptions);
Expand Down
Expand Up @@ -20,6 +20,7 @@ public interface ElasticsearchSchemaDropper extends Service {
* Drops an index, throwing an exception if dropping fails.
*
* @param indexName The name of the index to drop.
* @param executionOptions The execution options, giving more context information.
* @throws SearchException If an error occurs.
*/
void drop(String indexName, ExecutionOptions executionOptions);
Expand All @@ -30,6 +31,7 @@ public interface ElasticsearchSchemaDropper extends Service {
* <p>This method will skip operations silently if the index does not exist.
*
* @param indexName The name of the index to drop.
* @param executionOptions The execution options, giving more context information.
* @throws SearchException If an error occurs.
*/
void dropIfExisting(String indexName, ExecutionOptions executionOptions);
Expand Down
Expand Up @@ -25,6 +25,7 @@ public interface ElasticsearchSchemaMigrator extends Service {
* <p>The index is expected to already exist.
*
* @param indexMetadata The expected index metadata.
* @param executionOptions The execution options, giving more context information.
* @throws SearchException If an error occurs.
*/
void merge(IndexMetadata indexMetadata, ExecutionOptions executionOptions);
Expand Down
Expand Up @@ -23,6 +23,7 @@ public interface ElasticsearchSchemaValidator extends Service {
* The metadata mainly contain the type mappings.
*
* @param expectedIndexMetadata The expected metadata, generated by Hibernate Search.
* @param executionOptions The execution options, giving more context information.
* @throws ElasticsearchSchemaValidationException If a validation error occurs.
*/
void validate(IndexMetadata expectedIndexMetadata, ExecutionOptions executionOptions);
Expand Down

0 comments on commit fd9edd1

Please sign in to comment.