diff options
author | Robert Muir <rmuir@apache.org> | 2015-09-21 23:35:32 -0400 |
---|---|---|
committer | Robert Muir <rmuir@apache.org> | 2015-09-21 23:35:32 -0400 |
commit | 2f67cacaa3002d1f81eb341bab00252d275e9b0a (patch) | |
tree | 75cf226259d0dcabec9bd59042ff243393c6838e /core/src | |
parent | eedb39a5a950f2685fd63524ce58c4bb321ecb36 (diff) |
Fix all javadocs issues, re-enable compiler warnings (but disable on java9 where maven is broken)
Diffstat (limited to 'core/src')
468 files changed, 1167 insertions, 1473 deletions
diff --git a/core/src/main/java/org/apache/lucene/queryparser/classic/MapperQueryParser.java b/core/src/main/java/org/apache/lucene/queryparser/classic/MapperQueryParser.java index 1585acde3e..fe0f640542 100644 --- a/core/src/main/java/org/apache/lucene/queryparser/classic/MapperQueryParser.java +++ b/core/src/main/java/org/apache/lucene/queryparser/classic/MapperQueryParser.java @@ -55,8 +55,8 @@ import static org.elasticsearch.common.lucene.search.Queries.fixNegativeQueryIfN /** * A query parser that uses the {@link MapperService} in order to build smarter * queries based on the mapping information. - * <p/> - * <p>Also breaks fields with [type].[name] into a boolean query that must include the type + * <p> + * Also breaks fields with [type].[name] into a boolean query that must include the type * as well as the query on the name. */ public class MapperQueryParser extends QueryParser { diff --git a/core/src/main/java/org/apache/lucene/search/XFilteredDocIdSetIterator.java b/core/src/main/java/org/apache/lucene/search/XFilteredDocIdSetIterator.java index 0b3600e571..92f2f443f0 100644 --- a/core/src/main/java/org/apache/lucene/search/XFilteredDocIdSetIterator.java +++ b/core/src/main/java/org/apache/lucene/search/XFilteredDocIdSetIterator.java @@ -54,7 +54,7 @@ public abstract class XFilteredDocIdSetIterator extends DocIdSetIterator { * Validation method to determine whether a docid should be in the result set. * @param doc docid to be tested * @return true if input docid should be in the result set, false otherwise. - * @see #FilteredDocIdSetIterator(DocIdSetIterator) + * @see #XFilteredDocIdSetIterator(DocIdSetIterator) * @throws CollectionTerminatedException if the underlying iterator is exhausted. */ protected abstract boolean match(int doc); diff --git a/core/src/main/java/org/apache/lucene/search/suggest/analyzing/XAnalyzingSuggester.java b/core/src/main/java/org/apache/lucene/search/suggest/analyzing/XAnalyzingSuggester.java index bac323d63c..5db4f932c6 100644 --- a/core/src/main/java/org/apache/lucene/search/suggest/analyzing/XAnalyzingSuggester.java +++ b/core/src/main/java/org/apache/lucene/search/suggest/analyzing/XAnalyzingSuggester.java @@ -100,7 +100,7 @@ import java.util.*; public class XAnalyzingSuggester extends Lookup { /** - * FST<Weight,Surface>: + * FST<Weight,Surface>: * input is the analyzed form, with a null byte between terms * weights are encoded as costs: (Integer.MAX_VALUE-weight) * surface is the original, unanalyzed form. @@ -129,14 +129,14 @@ public class XAnalyzingSuggester extends Lookup { */ private final boolean preserveSep; - /** Include this flag in the options parameter to {@link + /** Include this flag in the options parameter to {@code * #XAnalyzingSuggester(Analyzer,Analyzer,int,int,int,boolean,FST,boolean,int,int,int,int,int)} to always * return the exact match first, regardless of score. This * has no performance impact but could result in * low-quality suggestions. */ public static final int EXACT_FIRST = 1; - /** Include this flag in the options parameter to {@link + /** Include this flag in the options parameter to {@code * #XAnalyzingSuggester(Analyzer,Analyzer,int,int,int,boolean,FST,boolean,int,int,int,int,int)} to preserve * token separators when matching. */ public static final int PRESERVE_SEP = 2; @@ -183,7 +183,7 @@ public class XAnalyzingSuggester extends Lookup { private long count = 0; /** - * Calls {@link #XAnalyzingSuggester(Analyzer,Analyzer,int,int,int,boolean,FST,boolean,int,int,int,int,int) + * Calls {@code #XAnalyzingSuggester(Analyzer,Analyzer,int,int,int,boolean,FST,boolean,int,int,int,int,int) * AnalyzingSuggester(analyzer, analyzer, EXACT_FIRST | * PRESERVE_SEP, 256, -1)} */ @@ -192,7 +192,7 @@ public class XAnalyzingSuggester extends Lookup { } /** - * Calls {@link #XAnalyzingSuggester(Analyzer,Analyzer,int,int,int,boolean,FST,boolean,int,int,int,int,int) + * Calls {@code #XAnalyzingSuggester(Analyzer,Analyzer,int,int,int,boolean,FST,boolean,int,int,int,int,int) * AnalyzingSuggester(indexAnalyzer, queryAnalyzer, EXACT_FIRST | * PRESERVE_SEP, 256, -1)} */ @@ -986,12 +986,12 @@ public long ramBytesUsed() { throw new UnsupportedOperationException(); } - /** cost -> weight */ + /** cost -> weight */ public static int decodeWeight(long encoded) { return (int)(Integer.MAX_VALUE - encoded); } - /** weight -> cost */ + /** weight -> cost */ public static int encodeWeight(long value) { if (value < 0 || value > Integer.MAX_VALUE) { throw new UnsupportedOperationException("cannot encode value: " + value); diff --git a/core/src/main/java/org/apache/lucene/search/suggest/analyzing/XFuzzySuggester.java b/core/src/main/java/org/apache/lucene/search/suggest/analyzing/XFuzzySuggester.java index 20f95c646f..a4338f8a65 100644 --- a/core/src/main/java/org/apache/lucene/search/suggest/analyzing/XFuzzySuggester.java +++ b/core/src/main/java/org/apache/lucene/search/suggest/analyzing/XFuzzySuggester.java @@ -115,7 +115,7 @@ public final class XFuzzySuggester extends XAnalyzingSuggester { } /** - * Creates a {@link FuzzySuggester} instance with an index & a query analyzer initialized with default values. + * Creates a {@link FuzzySuggester} instance with an index & a query analyzer initialized with default values. * * @param indexAnalyzer * Analyzer that will be used for analyzing suggestions while building the index. @@ -143,7 +143,7 @@ public final class XFuzzySuggester extends XAnalyzingSuggester { * @param maxGraphExpansions Maximum number of graph paths * to expand from the analyzed form. Set this to -1 for * no limit. - * @param maxEdits must be >= 0 and <= {@link org.apache.lucene.util.automaton.LevenshteinAutomata#MAXIMUM_SUPPORTED_DISTANCE} . + * @param maxEdits must be >= 0 and <= {@link org.apache.lucene.util.automaton.LevenshteinAutomata#MAXIMUM_SUPPORTED_DISTANCE} . * @param transpositions <code>true</code> if transpositions should be treated as a primitive * edit operation. If this is false, comparisons will implement the classic * Levenshtein algorithm. diff --git a/core/src/main/java/org/elasticsearch/ElasticsearchException.java b/core/src/main/java/org/elasticsearch/ElasticsearchException.java index 29e45654dd..c95b907098 100644 --- a/core/src/main/java/org/elasticsearch/ElasticsearchException.java +++ b/core/src/main/java/org/elasticsearch/ElasticsearchException.java @@ -55,7 +55,7 @@ public class ElasticsearchException extends RuntimeException implements ToXConte /** * Construct a <code>ElasticsearchException</code> with the specified detail message. * - * The message can be parameterized using {@code {}} as placeholders for the given + * The message can be parameterized using <code>{}</code> as placeholders for the given * arguments * * @param msg the detail message @@ -69,7 +69,7 @@ public class ElasticsearchException extends RuntimeException implements ToXConte * Construct a <code>ElasticsearchException</code> with the specified detail message * and nested exception. * - * The message can be parameterized using {@code {}} as placeholders for the given + * The message can be parameterized using <code>{}</code> as placeholders for the given * arguments * * @param msg the detail message diff --git a/core/src/main/java/org/elasticsearch/action/ActionFuture.java b/core/src/main/java/org/elasticsearch/action/ActionFuture.java index f2b1d87ee5..26a9260b71 100644 --- a/core/src/main/java/org/elasticsearch/action/ActionFuture.java +++ b/core/src/main/java/org/elasticsearch/action/ActionFuture.java @@ -37,8 +37,8 @@ public interface ActionFuture<T> extends Future<T> { * Similar to {@link #get()}, just catching the {@link InterruptedException} and throwing * an {@link IllegalStateException} instead. Also catches * {@link java.util.concurrent.ExecutionException} and throws the actual cause instead. - * <p/> - * <p>Note, the actual cause is unwrapped to the actual failure (for example, unwrapped + * <p> + * Note, the actual cause is unwrapped to the actual failure (for example, unwrapped * from {@link org.elasticsearch.transport.RemoteTransportException}. The root failure is * still accessible using {@link #getRootFailure()}. */ @@ -48,8 +48,8 @@ public interface ActionFuture<T> extends Future<T> { * Similar to {@link #get(long, java.util.concurrent.TimeUnit)}, just catching the {@link InterruptedException} and throwing * an {@link IllegalStateException} instead. Also catches * {@link java.util.concurrent.ExecutionException} and throws the actual cause instead. - * <p/> - * <p>Note, the actual cause is unwrapped to the actual failure (for example, unwrapped + * <p> + * Note, the actual cause is unwrapped to the actual failure (for example, unwrapped * from {@link org.elasticsearch.transport.RemoteTransportException}. The root failure is * still accessible using {@link #getRootFailure()}. */ @@ -59,8 +59,8 @@ public interface ActionFuture<T> extends Future<T> { * Similar to {@link #get(long, java.util.concurrent.TimeUnit)}, just catching the {@link InterruptedException} and throwing * an {@link IllegalStateException} instead. Also catches * {@link java.util.concurrent.ExecutionException} and throws the actual cause instead. - * <p/> - * <p>Note, the actual cause is unwrapped to the actual failure (for example, unwrapped + * <p> + * Note, the actual cause is unwrapped to the actual failure (for example, unwrapped * from {@link org.elasticsearch.transport.RemoteTransportException}. The root failure is * still accessible using {@link #getRootFailure()}. * @@ -72,8 +72,8 @@ public interface ActionFuture<T> extends Future<T> { * Similar to {@link #get(long, java.util.concurrent.TimeUnit)}, just catching the {@link InterruptedException} and throwing * an {@link IllegalStateException} instead. Also catches * {@link java.util.concurrent.ExecutionException} and throws the actual cause instead. - * <p/> - * <p>Note, the actual cause is unwrapped to the actual failure (for example, unwrapped + * <p> + * Note, the actual cause is unwrapped to the actual failure (for example, unwrapped * from {@link org.elasticsearch.transport.RemoteTransportException}. The root failure is * still accessible using {@link #getRootFailure()}. */ @@ -83,8 +83,8 @@ public interface ActionFuture<T> extends Future<T> { * Similar to {@link #get(long, java.util.concurrent.TimeUnit)}, just catching the {@link InterruptedException} and throwing * an {@link IllegalStateException} instead. Also catches * {@link java.util.concurrent.ExecutionException} and throws the actual cause instead. - * <p/> - * <p>Note, the actual cause is unwrapped to the actual failure (for example, unwrapped + * <p> + * Note, the actual cause is unwrapped to the actual failure (for example, unwrapped * from {@link org.elasticsearch.transport.RemoteTransportException}. The root failure is * still accessible using {@link #getRootFailure()}. */ diff --git a/core/src/main/java/org/elasticsearch/action/DocumentRequest.java b/core/src/main/java/org/elasticsearch/action/DocumentRequest.java index b804d7f385..fcfea39ab5 100644 --- a/core/src/main/java/org/elasticsearch/action/DocumentRequest.java +++ b/core/src/main/java/org/elasticsearch/action/DocumentRequest.java @@ -53,7 +53,6 @@ public interface DocumentRequest<T> extends IndicesRequest { /** * Set the routing for this request - * @param routing * @return the Request */ T routing(String routing); diff --git a/core/src/main/java/org/elasticsearch/action/admin/cluster/health/ClusterHealthRequest.java b/core/src/main/java/org/elasticsearch/action/admin/cluster/health/ClusterHealthRequest.java index 32114f6ff9..ba1e73311e 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/cluster/health/ClusterHealthRequest.java +++ b/core/src/main/java/org/elasticsearch/action/admin/cluster/health/ClusterHealthRequest.java @@ -126,7 +126,7 @@ public class ClusterHealthRequest extends MasterNodeReadRequest<ClusterHealthReq } /** - * Waits for N number of nodes. Use "12" for exact mapping, ">12" and "<12" for range. + * Waits for N number of nodes. Use "12" for exact mapping, ">12" and "<12" for range. */ public ClusterHealthRequest waitForNodes(String waitForNodes) { this.waitForNodes = waitForNodes; diff --git a/core/src/main/java/org/elasticsearch/action/admin/cluster/health/ClusterHealthRequestBuilder.java b/core/src/main/java/org/elasticsearch/action/admin/cluster/health/ClusterHealthRequestBuilder.java index 71153ae4cb..f12ab12300 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/cluster/health/ClusterHealthRequestBuilder.java +++ b/core/src/main/java/org/elasticsearch/action/admin/cluster/health/ClusterHealthRequestBuilder.java @@ -74,7 +74,7 @@ public class ClusterHealthRequestBuilder extends MasterNodeReadOperationRequestB } /** - * Waits for N number of nodes. Use "12" for exact mapping, ">12" and "<12" for range. + * Waits for N number of nodes. Use "12" for exact mapping, ">12" and "<12" for range. */ public ClusterHealthRequestBuilder setWaitForNodes(String waitForNodes) { request.waitForNodes(waitForNodes); diff --git a/core/src/main/java/org/elasticsearch/action/admin/cluster/repositories/delete/DeleteRepositoryRequest.java b/core/src/main/java/org/elasticsearch/action/admin/cluster/repositories/delete/DeleteRepositoryRequest.java index bb3b17bb07..84ca8dcc66 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/cluster/repositories/delete/DeleteRepositoryRequest.java +++ b/core/src/main/java/org/elasticsearch/action/admin/cluster/repositories/delete/DeleteRepositoryRequest.java @@ -30,7 +30,7 @@ import static org.elasticsearch.action.ValidateActions.addValidationError; /** * Unregister repository request. - * <p/> + * <p> * The unregister repository command just unregisters the repository. No data is getting deleted from the repository. */ public class DeleteRepositoryRequest extends AcknowledgedRequest<DeleteRepositoryRequest> { diff --git a/core/src/main/java/org/elasticsearch/action/admin/cluster/repositories/get/GetRepositoriesRequest.java b/core/src/main/java/org/elasticsearch/action/admin/cluster/repositories/get/GetRepositoriesRequest.java index b43dbf3d69..a0e6de916f 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/cluster/repositories/get/GetRepositoriesRequest.java +++ b/core/src/main/java/org/elasticsearch/action/admin/cluster/repositories/get/GetRepositoriesRequest.java @@ -41,7 +41,7 @@ public class GetRepositoriesRequest extends MasterNodeReadRequest<GetRepositorie /** * Constructs a new get repositories request with a list of repositories. - * <p/> + * <p> * If the list of repositories is empty or it contains a single element "_all", all registered repositories * are returned. * @@ -71,7 +71,7 @@ public class GetRepositoriesRequest extends MasterNodeReadRequest<GetRepositorie /** * Sets the list or repositories. - * <p/> + * <p> * If the list of repositories is empty or it contains a single element "_all", all registered repositories * are returned. * diff --git a/core/src/main/java/org/elasticsearch/action/admin/cluster/repositories/put/PutRepositoryRequest.java b/core/src/main/java/org/elasticsearch/action/admin/cluster/repositories/put/PutRepositoryRequest.java index 3d0977fb9d..efd364a07f 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/cluster/repositories/put/PutRepositoryRequest.java +++ b/core/src/main/java/org/elasticsearch/action/admin/cluster/repositories/put/PutRepositoryRequest.java @@ -41,7 +41,7 @@ import static org.elasticsearch.common.settings.Settings.writeSettingsToStream; /** * Register repository request. - * <p/> + * <p> * Registers a repository with given name, type and settings. If the repository with the same name already * exists in the cluster, the new repository will replace the existing repository. */ @@ -98,7 +98,6 @@ public class PutRepositoryRequest extends AcknowledgedRequest<PutRepositoryReque /** * The type of the repository - * <p/> * <ul> * <li>"fs" - shared filesystem repository</li> * </ul> diff --git a/core/src/main/java/org/elasticsearch/action/admin/cluster/repositories/verify/VerifyRepositoryRequest.java b/core/src/main/java/org/elasticsearch/action/admin/cluster/repositories/verify/VerifyRepositoryRequest.java index 333057709f..7166eedb72 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/cluster/repositories/verify/VerifyRepositoryRequest.java +++ b/core/src/main/java/org/elasticsearch/action/admin/cluster/repositories/verify/VerifyRepositoryRequest.java @@ -30,7 +30,7 @@ import static org.elasticsearch.action.ValidateActions.addValidationError; /** * Unregister repository request. - * <p/> + * <p> * The unregister repository command just unregisters the repository. No data is getting deleted from the repository. */ public class VerifyRepositoryRequest extends AcknowledgedRequest<VerifyRepositoryRequest> { diff --git a/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/create/CreateSnapshotRequest.java b/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/create/CreateSnapshotRequest.java index 4dbef01a32..41d3f9c359 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/create/CreateSnapshotRequest.java +++ b/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/create/CreateSnapshotRequest.java @@ -49,7 +49,7 @@ import static org.elasticsearch.common.xcontent.support.XContentMapValues.nodeBo /** * Create snapshot request - * <p/> + * <p> * The only mandatory parameter is repository name. The repository name has to satisfy the following requirements * <ul> * <li>be a non-empty string</li> @@ -162,12 +162,11 @@ public class CreateSnapshotRequest extends MasterNodeRequest<CreateSnapshotReque /** * Sets a list of indices that should be included into the snapshot - * <p/> + * <p> * The list of indices supports multi-index syntax. For example: "+test*" ,"-test42" will index all indices with * prefix "test" except index "test42". Aliases are supported. An empty list or {"_all"} will snapshot all open * indices in the cluster. * - * @param indices * @return this request */ @Override @@ -178,12 +177,11 @@ public class CreateSnapshotRequest extends MasterNodeRequest<CreateSnapshotReque /** * Sets a list of indices that should be included into the snapshot - * <p/> + * <p> * The list of indices supports multi-index syntax. For example: "+test*" ,"-test42" will index all indices with * prefix "test" except index "test42". Aliases are supported. An empty list or {"_all"} will snapshot all open * indices in the cluster. * - * @param indices * @return this request */ public CreateSnapshotRequest indices(List<String> indices) { @@ -268,7 +266,7 @@ public class CreateSnapshotRequest extends MasterNodeRequest<CreateSnapshotReque /** * Sets repository-specific snapshot settings. - * <p/> + * <p> * See repository documentation for more information. * * @param settings repository-specific snapshot settings @@ -281,7 +279,7 @@ public class CreateSnapshotRequest extends MasterNodeRequest<CreateSnapshotReque /** * Sets repository-specific snapshot settings. - * <p/> + * <p> * See repository documentation for more information. * * @param settings repository-specific snapshot settings @@ -294,7 +292,7 @@ public class CreateSnapshotRequest extends MasterNodeRequest<CreateSnapshotReque /** * Sets repository-specific snapshot settings in JSON, YAML or properties format - * <p/> + * <p> * See repository documentation for more information. * * @param source repository-specific snapshot settings @@ -307,7 +305,7 @@ public class CreateSnapshotRequest extends MasterNodeRequest<CreateSnapshotReque /** * Sets repository-specific snapshot settings. - * <p/> + * <p> * See repository documentation for more information. * * @param source repository-specific snapshot settings diff --git a/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/create/CreateSnapshotRequestBuilder.java b/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/create/CreateSnapshotRequestBuilder.java index 507c77ab26..ebdd206b5c 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/create/CreateSnapshotRequestBuilder.java +++ b/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/create/CreateSnapshotRequestBuilder.java @@ -69,12 +69,11 @@ public class CreateSnapshotRequestBuilder extends MasterNodeOperationRequestBuil /** * Sets a list of indices that should be included into the snapshot - * <p/> + * <p> * The list of indices supports multi-index syntax. For example: "+test*" ,"-test42" will index all indices with * prefix "test" except index "test42". Aliases are supported. An empty list or {"_all"} will snapshot all open * indices in the cluster. * - * @param indices * @return this builder */ public CreateSnapshotRequestBuilder setIndices(String... indices) { @@ -117,7 +116,7 @@ public class CreateSnapshotRequestBuilder extends MasterNodeOperationRequestBuil /** * Sets repository-specific snapshot settings. - * <p/> + * <p> * See repository documentation for more information. * * @param settings repository-specific snapshot settings @@ -130,7 +129,7 @@ public class CreateSnapshotRequestBuilder extends MasterNodeOperationRequestBuil /** * Sets repository-specific snapshot settings. - * <p/> + * <p> * See repository documentation for more information. * * @param settings repository-specific snapshot settings @@ -143,7 +142,7 @@ public class CreateSnapshotRequestBuilder extends MasterNodeOperationRequestBuil /** * Sets repository-specific snapshot settings in YAML, JSON or properties format - * <p/> + * <p> * See repository documentation for more information. * * @param source repository-specific snapshot settings @@ -156,7 +155,7 @@ public class CreateSnapshotRequestBuilder extends MasterNodeOperationRequestBuil /** * Sets repository-specific snapshot settings. - * <p/> + * <p> * See repository documentation for more information. * * @param settings repository-specific snapshot settings diff --git a/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/create/CreateSnapshotResponse.java b/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/create/CreateSnapshotResponse.java index c718abc55d..c1c5e9f465 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/create/CreateSnapshotResponse.java +++ b/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/create/CreateSnapshotResponse.java @@ -69,14 +69,11 @@ public class CreateSnapshotResponse extends ActionResponse implements ToXContent /** * Returns HTTP status - * <p/> * <ul> - * <li>{@link RestStatus#ACCEPTED}</li> if snapshot is still in progress - * <li>{@link RestStatus#OK}</li> if snapshot was successful or partially successful - * <li>{@link RestStatus#INTERNAL_SERVER_ERROR}</li> if snapshot failed completely + * <li>{@link RestStatus#ACCEPTED} if snapshot is still in progress</li> + * <li>{@link RestStatus#OK} if snapshot was successful or partially successful</li> + * <li>{@link RestStatus#INTERNAL_SERVER_ERROR} if snapshot failed completely</li> * </ul> - * - * @return */ public RestStatus status() { if (snapshotInfo == null) { diff --git a/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/delete/DeleteSnapshotRequest.java b/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/delete/DeleteSnapshotRequest.java index d997786d5f..246d3662f8 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/delete/DeleteSnapshotRequest.java +++ b/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/delete/DeleteSnapshotRequest.java @@ -30,7 +30,7 @@ import static org.elasticsearch.action.ValidateActions.addValidationError; /** * Delete snapshot request - * <p/> + * <p> * Delete snapshot request removes the snapshot record from the repository and cleans up all * files that are associated with this particular snapshot. All files that are shared with * at least one other existing snapshot are left intact. diff --git a/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/get/GetSnapshotsRequest.java b/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/get/GetSnapshotsRequest.java index cccd697a4e..a0d27979a4 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/get/GetSnapshotsRequest.java +++ b/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/get/GetSnapshotsRequest.java @@ -105,7 +105,6 @@ public class GetSnapshotsRequest extends MasterNodeRequest<GetSnapshotsRequest> /** * Sets the list of snapshots to be returned * - * @param snapshots * @return this request */ public GetSnapshotsRequest snapshots(String[] snapshots) { diff --git a/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/restore/RestoreSnapshotRequest.java b/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/restore/RestoreSnapshotRequest.java index 7b349e47de..0f79ceb0f9 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/restore/RestoreSnapshotRequest.java +++ b/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/restore/RestoreSnapshotRequest.java @@ -147,7 +147,7 @@ public class RestoreSnapshotRequest extends MasterNodeRequest<RestoreSnapshotReq /** * Sets the list of indices that should be restored from snapshot - * <p/> + * <p> * The list of indices supports multi-index syntax. For example: "+test*" ,"-test42" will index all indices with * prefix "test" except index "test42". Aliases are not supported. An empty list or {"_all"} will restore all open * indices in the snapshot. @@ -162,7 +162,7 @@ public class RestoreSnapshotRequest extends MasterNodeRequest<RestoreSnapshotReq /** * Sets the list of indices that should be restored from snapshot - * <p/> + * <p> * The list of indices supports multi-index syntax. For example: "+test*" ,"-test42" will index all indices with * prefix "test" except index "test42". Aliases are not supported. An empty list or {"_all"} will restore all open * indices in the snapshot. @@ -177,8 +177,6 @@ public class RestoreSnapshotRequest extends MasterNodeRequest<RestoreSnapshotReq /** * Returns list of indices that should be restored from snapshot - * - * @return */ public String[] indices() { return indices; @@ -208,7 +206,7 @@ public class RestoreSnapshotRequest extends MasterNodeRequest<RestoreSnapshotReq /** * Sets rename pattern that should be applied to restored indices. - * <p/> + * <p> * Indices that match the rename pattern will be renamed according to {@link #renameReplacement(String)}. The * rename pattern is applied according to the {@link java.util.regex.Matcher#appendReplacement(StringBuffer, String)} * The request will fail if two or more indices will be renamed into the same name. @@ -232,11 +230,10 @@ public class RestoreSnapshotRequest extends MasterNodeRequest<RestoreSnapshotReq /** * Sets rename replacement - * <p/> + * <p> * See {@link #renamePattern(String)} for more information. * * @param renameReplacement rename replacement - * @return */ public RestoreSnapshotRequest renameReplacement(String renameReplacement) { this.renameReplacement = renameReplacement; @@ -294,7 +291,7 @@ public class RestoreSnapshotRequest extends MasterNodeRequest<RestoreSnapshotReq /** * Sets repository-specific restore settings. - * <p/> + * <p> * See repository documentation for more information. * * @param settings repository-specific snapshot settings @@ -307,7 +304,7 @@ public class RestoreSnapshotRequest extends MasterNodeRequest<RestoreSnapshotReq /** * Sets repository-specific restore settings. - * <p/> + * <p> * See repository documentation for more information. * * @param settings repository-specific snapshot settings @@ -320,7 +317,7 @@ public class RestoreSnapshotRequest extends MasterNodeRequest<RestoreSnapshotReq /** * Sets repository-specific restore settings in JSON, YAML or properties format - * <p/> + * <p> * See repository documentation for more information. * * @param source repository-specific snapshot settings @@ -333,7 +330,7 @@ public class RestoreSnapshotRequest extends MasterNodeRequest<RestoreSnapshotReq /** * Sets repository-specific restore settings - * <p/> + * <p> * See repository documentation for more information. * * @param source repository-specific snapshot settings @@ -384,7 +381,7 @@ public class RestoreSnapshotRequest extends MasterNodeRequest<RestoreSnapshotReq /** * If set to true the restore procedure will restore global cluster state. - * <p/> + * <p> * The global cluster state includes persistent settings and index template definitions. * * @param includeGlobalState true if global state should be restored from the snapshot @@ -548,7 +545,7 @@ public class RestoreSnapshotRequest extends MasterNodeRequest<RestoreSnapshotReq /** * Parses restore definition - * <p/> + * <p> * JSON, YAML and properties formats are supported * * @param source restore definition @@ -567,7 +564,7 @@ public class RestoreSnapshotRequest extends MasterNodeRequest<RestoreSnapshotReq /** * Parses restore definition - * <p/> + * <p> * JSON, YAML and properties formats are supported * * @param source restore definition @@ -579,7 +576,7 @@ public class RestoreSnapshotRequest extends MasterNodeRequest<RestoreSnapshotReq /** * Parses restore definition - * <p/> + * <p> * JSON, YAML and properties formats are supported * * @param source restore definition @@ -600,7 +597,7 @@ public class RestoreSnapshotRequest extends MasterNodeRequest<RestoreSnapshotReq /** * Parses restore definition - * <p/> + * <p> * JSON, YAML and properties formats are supported * * @param source restore definition diff --git a/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/restore/RestoreSnapshotRequestBuilder.java b/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/restore/RestoreSnapshotRequestBuilder.java index 1fda33e75b..661a1a1d01 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/restore/RestoreSnapshotRequestBuilder.java +++ b/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/restore/RestoreSnapshotRequestBuilder.java @@ -71,7 +71,7 @@ public class RestoreSnapshotRequestBuilder extends MasterNodeOperationRequestBui /** * Sets the list of indices that should be restored from snapshot - * <p/> + * <p> * The list of indices supports multi-index syntax. For example: "+test*" ,"-test42" will index all indices with * prefix "test" except index "test42". Aliases are not supported. An empty list or {"_all"} will restore all open * indices in the snapshot. @@ -99,7 +99,7 @@ public class RestoreSnapshotRequestBuilder extends MasterNodeOperationRequestBui /** * Sets rename pattern that should be applied to restored indices. - * <p/> + * <p> * Indices that match the rename pattern will be renamed according to {@link #setRenameReplacement(String)}. The * rename pattern is applied according to the {@link java.util.regex.Matcher#appendReplacement(StringBuffer, String)} * The request will fail if two or more indices will be renamed into the same name. @@ -114,7 +114,7 @@ public class RestoreSnapshotRequestBuilder extends MasterNodeOperationRequestBui /** * Sets rename replacement - * <p/> + * <p> * See {@link #setRenamePattern(String)} for more information. * * @param renameReplacement rename replacement @@ -128,7 +128,7 @@ public class RestoreSnapshotRequestBuilder extends MasterNodeOperationRequestBui /** * Sets repository-specific restore settings. - * <p/> + * <p> * See repository documentation for more information. * * @param settings repository-specific snapshot settings @@ -141,7 +141,7 @@ public class RestoreSnapshotRequestBuilder extends MasterNodeOperationRequestBui /** * Sets repository-specific restore settings. - * <p/> + * <p> * See repository documentation for more information. * * @param settings repository-specific snapshot settings @@ -154,7 +154,7 @@ public class RestoreSnapshotRequestBuilder extends MasterNodeOperationRequestBui /** * Sets repository-specific restore settings in JSON, YAML or properties format - * <p/> + * <p> * See repository documentation for more information. * * @param source repository-specific snapshot settings @@ -167,7 +167,7 @@ public class RestoreSnapshotRequestBuilder extends MasterNodeOperationRequestBui /** * Sets repository-specific restore settings - * <p/> + * <p> * See repository documentation for more information. * * @param source repository-specific snapshot settings @@ -191,7 +191,7 @@ public class RestoreSnapshotRequestBuilder extends MasterNodeOperationRequestBui /** * If set to true the restore procedure will restore global cluster state. - * <p/> + * <p> * The global cluster state includes persistent settings and index template definitions. * * @param restoreGlobalState true if global state should be restored from the snapshot diff --git a/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/status/SnapshotStatus.java b/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/status/SnapshotStatus.java index 7e1a47c450..91b890b02f 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/status/SnapshotStatus.java +++ b/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/status/SnapshotStatus.java @@ -149,7 +149,6 @@ public class SnapshotStatus implements ToXContent, Streamable { * * @param in stream input * @return deserialized snapshot status - * @throws IOException */ public static SnapshotStatus readSnapshotStatus(StreamInput in) throws IOException { SnapshotStatus snapshotInfo = new SnapshotStatus(); diff --git a/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/status/SnapshotsStatusRequest.java b/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/status/SnapshotsStatusRequest.java index b7b2b631b3..015134aba7 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/status/SnapshotsStatusRequest.java +++ b/core/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/status/SnapshotsStatusRequest.java @@ -105,7 +105,6 @@ public class SnapshotsStatusRequest extends MasterNodeRequest<SnapshotsStatusReq /** * Sets the list of snapshots to be returned * - * @param snapshots * @return this request */ public SnapshotsStatusRequest snapshots(String[] snapshots) { diff --git a/core/src/main/java/org/elasticsearch/action/admin/cluster/stats/ClusterStatsIndices.java b/core/src/main/java/org/elasticsearch/action/admin/cluster/stats/ClusterStatsIndices.java index c219d85f9d..be7a3f0d4d 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/cluster/stats/ClusterStatsIndices.java +++ b/core/src/main/java/org/elasticsearch/action/admin/cluster/stats/ClusterStatsIndices.java @@ -297,7 +297,7 @@ public class ClusterStatsIndices implements ToXContent, Streamable { } /** - * maximum replication factor across the indices. See {@link #getReplication + * maximum replication factor across the indices. See {@link #getReplication} */ public double getMaxIndexReplication() { return this.maxIndexReplication; diff --git a/core/src/main/java/org/elasticsearch/action/admin/indices/create/CreateIndexRequest.java b/core/src/main/java/org/elasticsearch/action/admin/indices/create/CreateIndexRequest.java index d5d291dcbc..97323b8c9b 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/indices/create/CreateIndexRequest.java +++ b/core/src/main/java/org/elasticsearch/action/admin/indices/create/CreateIndexRequest.java @@ -55,8 +55,8 @@ import static org.elasticsearch.common.settings.Settings.writeSettingsToStream; /** * A request to create an index. Best created with {@link org.elasticsearch.client.Requests#createIndexRequest(String)}. - * <p/> - * <p>The index created can optionally be created with {@link #settings(org.elasticsearch.common.settings.Settings)}. + * <p> + * The index created can optionally be created with {@link #settings(org.elasticsearch.common.settings.Settings)}. * * @see org.elasticsearch.client.IndicesAdminClient#create(CreateIndexRequest) * @see org.elasticsearch.client.Requests#createIndexRequest(String) diff --git a/core/src/main/java/org/elasticsearch/action/admin/indices/delete/DeleteIndexRequestBuilder.java b/core/src/main/java/org/elasticsearch/action/admin/indices/delete/DeleteIndexRequestBuilder.java index e8916e1875..9e5dc88b98 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/indices/delete/DeleteIndexRequestBuilder.java +++ b/core/src/main/java/org/elasticsearch/action/admin/indices/delete/DeleteIndexRequestBuilder.java @@ -53,7 +53,7 @@ public class DeleteIndexRequestBuilder extends MasterNodeOperationRequestBuilder /** * Specifies what type of requested indices to ignore and wildcard indices expressions. - * <p/> + * <p> * For example indices that don't exist. */ public DeleteIndexRequestBuilder setIndicesOptions(IndicesOptions options) { diff --git a/core/src/main/java/org/elasticsearch/action/admin/indices/exists/indices/IndicesExistsRequestBuilder.java b/core/src/main/java/org/elasticsearch/action/admin/indices/exists/indices/IndicesExistsRequestBuilder.java index 7fe5b1e1e1..5f01c26b32 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/indices/exists/indices/IndicesExistsRequestBuilder.java +++ b/core/src/main/java/org/elasticsearch/action/admin/indices/exists/indices/IndicesExistsRequestBuilder.java @@ -39,7 +39,7 @@ public class IndicesExistsRequestBuilder extends MasterNodeReadOperationRequestB /** * Specifies what type of requested indices to ignore and wildcard indices expressions. - * <p/> + * <p> * For example indices that don't exist. */ public IndicesExistsRequestBuilder setIndicesOptions(IndicesOptions options) { diff --git a/core/src/main/java/org/elasticsearch/action/admin/indices/flush/FlushRequest.java b/core/src/main/java/org/elasticsearch/action/admin/indices/flush/FlushRequest.java index ad8a719e32..0152254d22 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/indices/flush/FlushRequest.java +++ b/core/src/main/java/org/elasticsearch/action/admin/indices/flush/FlushRequest.java @@ -30,8 +30,8 @@ import java.io.IOException; * A flush request to flush one or more indices. The flush process of an index basically frees memory from the index * by flushing data to the index storage and clearing the internal transaction log. By default, Elasticsearch uses * memory heuristics in order to automatically trigger flush operations as required in order to clear memory. - * <p/> - * <p>Best created with {@link org.elasticsearch.client.Requests#flushRequest(String...)}. + * <p> + * Best created with {@link org.elasticsearch.client.Requests#flushRequest(String...)}. * * @see org.elasticsearch.client.Requests#flushRequest(String...) * @see org.elasticsearch.client.IndicesAdminClient#flush(FlushRequest) diff --git a/core/src/main/java/org/elasticsearch/action/admin/indices/mapping/get/GetFieldMappingsRequest.java b/core/src/main/java/org/elasticsearch/action/admin/indices/mapping/get/GetFieldMappingsRequest.java index 3ebf327352..967ea31c84 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/indices/mapping/get/GetFieldMappingsRequest.java +++ b/core/src/main/java/org/elasticsearch/action/admin/indices/mapping/get/GetFieldMappingsRequest.java @@ -49,7 +49,7 @@ public class GetFieldMappingsRequest extends ActionRequest<GetFieldMappingsReque /** * Indicate whether the receiving node should operate based on local index information or forward requests, - * where needed, to other nodes. If running locally, request will not raise errors if running locally & missing indices. + * where needed, to other nodes. If running locally, request will not raise errors if running locally & missing indices. */ public GetFieldMappingsRequest local(boolean local) { this.local = local; diff --git a/core/src/main/java/org/elasticsearch/action/admin/indices/mapping/put/PutMappingRequest.java b/core/src/main/java/org/elasticsearch/action/admin/indices/mapping/put/PutMappingRequest.java index a7089390ff..7cfcbd733a 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/indices/mapping/put/PutMappingRequest.java +++ b/core/src/main/java/org/elasticsearch/action/admin/indices/mapping/put/PutMappingRequest.java @@ -40,8 +40,8 @@ import static org.elasticsearch.action.ValidateActions.addValidationError; /** * Puts mapping definition registered under a specific type into one or more indices. Best created with * {@link org.elasticsearch.client.Requests#putMappingRequest(String...)}. - * <p/> - * <p>If the mappings already exists, the new mappings will be merged with the new one. If there are elements + * <p> + * If the mappings already exists, the new mappings will be merged with the new one. If there are elements * that can't be merged are detected, the request will be rejected. * * @see org.elasticsearch.client.Requests#putMappingRequest(String...) diff --git a/core/src/main/java/org/elasticsearch/action/admin/indices/mapping/put/PutMappingRequestBuilder.java b/core/src/main/java/org/elasticsearch/action/admin/indices/mapping/put/PutMappingRequestBuilder.java index 6b5d5d0d87..28f289b86c 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/indices/mapping/put/PutMappingRequestBuilder.java +++ b/core/src/main/java/org/elasticsearch/action/admin/indices/mapping/put/PutMappingRequestBuilder.java @@ -42,7 +42,7 @@ public class PutMappingRequestBuilder extends AcknowledgedRequestBuilder<PutMapp /** * Specifies what type of requested indices to ignore and wildcard indices expressions. - * <p/> + * <p> * For example indices that don't exist. */ public PutMappingRequestBuilder setIndicesOptions(IndicesOptions options) { diff --git a/core/src/main/java/org/elasticsearch/action/admin/indices/optimize/OptimizeRequest.java b/core/src/main/java/org/elasticsearch/action/admin/indices/optimize/OptimizeRequest.java index 08f322a115..cf3006baa3 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/indices/optimize/OptimizeRequest.java +++ b/core/src/main/java/org/elasticsearch/action/admin/indices/optimize/OptimizeRequest.java @@ -28,8 +28,8 @@ import java.io.IOException; /** * A request to optimize one or more indices. In order to optimize on all the indices, pass an empty array or * <tt>null</tt> for the indices. - * <p/> - * <p>{@link #maxNumSegments(int)} allows to control the number of segments to optimize down to. By default, will + * <p> + * {@link #maxNumSegments(int)} allows to control the number of segments to optimize down to. By default, will * cause the optimize process to optimize down to half the configured number of segments. * * @see org.elasticsearch.client.Requests#optimizeRequest(String...) @@ -62,7 +62,7 @@ public class OptimizeRequest extends BroadcastRequest<OptimizeRequest> { } /** - * Will optimize the index down to <= maxNumSegments. By default, will cause the optimize + * Will optimize the index down to <= maxNumSegments. By default, will cause the optimize * process to optimize down to half the configured number of segments. */ public int maxNumSegments() { @@ -70,7 +70,7 @@ public class OptimizeRequest extends BroadcastRequest<OptimizeRequest> { } /** - * Will optimize the index down to <= maxNumSegments. By default, will cause the optimize + * Will optimize the index down to <= maxNumSegments. By default, will cause the optimize * process to optimize down to half the configured number of segments. */ public OptimizeRequest maxNumSegments(int maxNumSegments) { diff --git a/core/src/main/java/org/elasticsearch/action/admin/indices/optimize/OptimizeRequestBuilder.java b/core/src/main/java/org/elasticsearch/action/admin/indices/optimize/OptimizeRequestBuilder.java index 04935989f0..d318492e90 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/indices/optimize/OptimizeRequestBuilder.java +++ b/core/src/main/java/org/elasticsearch/action/admin/indices/optimize/OptimizeRequestBuilder.java @@ -25,7 +25,6 @@ import org.elasticsearch.client.ElasticsearchClient; /** * A request to optimize one or more indices. In order to optimize on all the indices, pass an empty array or * <tt>null</tt> for the indices. - * <p/> * <p>{@link #setMaxNumSegments(int)} allows to control the number of segments to optimize down to. By default, will * cause the optimize process to optimize down to half the configured number of segments. */ @@ -36,7 +35,7 @@ public class OptimizeRequestBuilder extends BroadcastOperationRequestBuilder<Opt } /** - * Will optimize the index down to <= maxNumSegments. By default, will cause the optimize + * Will optimize the index down to <= maxNumSegments. By default, will cause the optimize * process to optimize down to half the configured number of segments. */ public OptimizeRequestBuilder setMaxNumSegments(int maxNumSegments) { diff --git a/core/src/main/java/org/elasticsearch/action/admin/indices/settings/get/GetSettingsRequestBuilder.java b/core/src/main/java/org/elasticsearch/action/admin/indices/settings/get/GetSettingsRequestBuilder.java index 4047d0a7bc..5a2ca7aef1 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/indices/settings/get/GetSettingsRequestBuilder.java +++ b/core/src/main/java/org/elasticsearch/action/admin/indices/settings/get/GetSettingsRequestBuilder.java @@ -44,7 +44,7 @@ public class GetSettingsRequestBuilder extends MasterNodeReadOperationRequestBui /** * Specifies what type of requested indices to ignore and wildcard indices expressions. - * <p/> + * <p> * For example indices that don't exist. */ public GetSettingsRequestBuilder setIndicesOptions(IndicesOptions options) { diff --git a/core/src/main/java/org/elasticsearch/action/admin/indices/settings/put/UpdateSettingsRequestBuilder.java b/core/src/main/java/org/elasticsearch/action/admin/indices/settings/put/UpdateSettingsRequestBuilder.java index f5a318977b..770c54b1a3 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/indices/settings/put/UpdateSettingsRequestBuilder.java +++ b/core/src/main/java/org/elasticsearch/action/admin/indices/settings/put/UpdateSettingsRequestBuilder.java @@ -45,7 +45,7 @@ public class UpdateSettingsRequestBuilder extends AcknowledgedRequestBuilder<Upd /** * Specifies what type of requested indices to ignore and wildcard indices expressions. - * <p/> + * <p> * For example indices that don't exist. */ public UpdateSettingsRequestBuilder setIndicesOptions(IndicesOptions options) { diff --git a/core/src/main/java/org/elasticsearch/action/admin/indices/stats/IndicesStatsRequest.java b/core/src/main/java/org/elasticsearch/action/admin/indices/stats/IndicesStatsRequest.java index fc893db0e8..792dde1f45 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/indices/stats/IndicesStatsRequest.java +++ b/core/src/main/java/org/elasticsearch/action/admin/indices/stats/IndicesStatsRequest.java @@ -28,10 +28,10 @@ import java.io.IOException; /** * A request to get indices level stats. Allow to enable different stats to be returned. - * <p/> - * <p>By default, all statistics are enabled. - * <p/> - * <p>All the stats to be returned can be cleared using {@link #clear()}, at which point, specific + * <p> + * By default, all statistics are enabled. + * <p> + * All the stats to be returned can be cleared using {@link #clear()}, at which point, specific * stats can be enabled. */ public class IndicesStatsRequest extends BroadcastRequest<IndicesStatsRequest> { diff --git a/core/src/main/java/org/elasticsearch/action/admin/indices/stats/IndicesStatsRequestBuilder.java b/core/src/main/java/org/elasticsearch/action/admin/indices/stats/IndicesStatsRequestBuilder.java index 8e78c548e3..21540d3152 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/indices/stats/IndicesStatsRequestBuilder.java +++ b/core/src/main/java/org/elasticsearch/action/admin/indices/stats/IndicesStatsRequestBuilder.java @@ -24,11 +24,11 @@ import org.elasticsearch.client.ElasticsearchClient; /** * A request to get indices level stats. Allow to enable different stats to be returned. - * <p/> - * <p>By default, the {@link #setDocs(boolean)}, {@link #setStore(boolean)}, {@link #setIndexing(boolean)} + * <p> + * By default, the {@link #setDocs(boolean)}, {@link #setStore(boolean)}, {@link #setIndexing(boolean)} * are enabled. Other stats can be enabled as well. - * <p/> - * <p>All the stats to be returned can be cleared using {@link #clear()}, at which point, specific + * <p> + * All the stats to be returned can be cleared using {@link #clear()}, at which point, specific * stats can be enabled. */ public class IndicesStatsRequestBuilder extends BroadcastOperationRequestBuilder<IndicesStatsRequest, IndicesStatsResponse, IndicesStatsRequestBuilder> { diff --git a/core/src/main/java/org/elasticsearch/action/admin/indices/upgrade/post/UpgradeRequest.java b/core/src/main/java/org/elasticsearch/action/admin/indices/upgrade/post/UpgradeRequest.java index af328ce21a..5472660a7b 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/indices/upgrade/post/UpgradeRequest.java +++ b/core/src/main/java/org/elasticsearch/action/admin/indices/upgrade/post/UpgradeRequest.java @@ -28,7 +28,6 @@ import java.io.IOException; /** * A request to upgrade one or more indices. In order to optimize on all the indices, pass an empty array or * <tt>null</tt> for the indices. - * <p/> * @see org.elasticsearch.client.Requests#upgradeRequest(String...) * @see org.elasticsearch.client.IndicesAdminClient#upgrade(UpgradeRequest) * @see UpgradeResponse diff --git a/core/src/main/java/org/elasticsearch/action/admin/indices/validate/query/ValidateQueryRequest.java b/core/src/main/java/org/elasticsearch/action/admin/indices/validate/query/ValidateQueryRequest.java index 20fb5414f4..7c7869b9ce 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/indices/validate/query/ValidateQueryRequest.java +++ b/core/src/main/java/org/elasticsearch/action/admin/indices/validate/query/ValidateQueryRequest.java @@ -40,8 +40,8 @@ import java.util.Map; /** * A request to validate a specific query. - * <p/> - * <p>The request requires the query source to be set either using {@link #source(QuerySourceBuilder)}, + * <p> + * The request requires the query source to be set either using {@link #source(QuerySourceBuilder)}, * or {@link #source(byte[])}. */ public class ValidateQueryRequest extends BroadcastRequest<ValidateQueryRequest> { diff --git a/core/src/main/java/org/elasticsearch/action/admin/indices/warmer/delete/DeleteWarmerRequest.java b/core/src/main/java/org/elasticsearch/action/admin/indices/warmer/delete/DeleteWarmerRequest.java index 61b033f5f2..39312e5a3d 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/indices/warmer/delete/DeleteWarmerRequest.java +++ b/core/src/main/java/org/elasticsearch/action/admin/indices/warmer/delete/DeleteWarmerRequest.java @@ -48,7 +48,7 @@ public class DeleteWarmerRequest extends AcknowledgedRequest<DeleteWarmerRequest /** * Constructs a new delete warmer request for the specified name. * - * @param names: the name (or wildcard expression) of the warmer to match, null to delete all. + * @param names the name (or wildcard expression) of the warmer to match, null to delete all. */ public DeleteWarmerRequest(String... names) { names(names); diff --git a/core/src/main/java/org/elasticsearch/action/admin/indices/warmer/delete/DeleteWarmerRequestBuilder.java b/core/src/main/java/org/elasticsearch/action/admin/indices/warmer/delete/DeleteWarmerRequestBuilder.java index 152c5ac303..fdba95b590 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/indices/warmer/delete/DeleteWarmerRequestBuilder.java +++ b/core/src/main/java/org/elasticsearch/action/admin/indices/warmer/delete/DeleteWarmerRequestBuilder.java @@ -50,7 +50,7 @@ public class DeleteWarmerRequestBuilder extends AcknowledgedRequestBuilder<Delet /** * Specifies what type of requested indices to ignore and wildcard indices expressions. - * <p/> + * <p> * For example indices that don't exist. */ public DeleteWarmerRequestBuilder setIndicesOptions(IndicesOptions options) { diff --git a/core/src/main/java/org/elasticsearch/action/admin/indices/warmer/package-info.java b/core/src/main/java/org/elasticsearch/action/admin/indices/warmer/package-info.java index e1a2af4658..053cc75caa 100644 --- a/core/src/main/java/org/elasticsearch/action/admin/indices/warmer/package-info.java +++ b/core/src/main/java/org/elasticsearch/action/admin/indices/warmer/package-info.java @@ -25,6 +25,6 @@ * search. This includes things such as the query cache, filesystem cache, and loading field data for fields. * </p> * - * @see the reference guide for more detailed information about the Indices / Search Warmer + * See the reference guide for more detailed information about the Indices / Search Warmer */ package org.elasticsearch.action.admin.indices.warmer; diff --git a/core/src/main/java/org/elasticsearch/action/bulk/BulkProcessor.java b/core/src/main/java/org/elasticsearch/action/bulk/BulkProcessor.java index ab4366dd92..42a9344eab 100644 --- a/core/src/main/java/org/elasticsearch/action/bulk/BulkProcessor.java +++ b/core/src/main/java/org/elasticsearch/action/bulk/BulkProcessor.java @@ -40,7 +40,7 @@ import java.util.concurrent.atomic.AtomicLong; * A bulk processor is a thread safe bulk processing class, allowing to easily set when to "flush" a new bulk request * (either based on number of actions, based on the size, or time), and to easily control the number of concurrent bulk * requests allowed to be executed in parallel. - * <p/> + * <p> * In order to create a new bulk processor, use the {@link Builder}. */ public class BulkProcessor implements Closeable { @@ -127,7 +127,7 @@ public class BulkProcessor implements Closeable { /** * Sets a flush interval flushing *any* bulk actions pending if the interval passes. Defaults to not set. - * <p/> + * <p> * Note, both {@link #setBulkActions(int)} and {@link #setBulkSize(org.elasticsearch.common.unit.ByteSizeValue)} * can be set to <tt>-1</tt> with the flush interval set allowing for complete async processing of bulk actions. */ diff --git a/core/src/main/java/org/elasticsearch/action/bulk/BulkRequest.java b/core/src/main/java/org/elasticsearch/action/bulk/BulkRequest.java index 9a8419f80a..fa6b643eb6 100644 --- a/core/src/main/java/org/elasticsearch/action/bulk/BulkRequest.java +++ b/core/src/main/java/org/elasticsearch/action/bulk/BulkRequest.java @@ -195,7 +195,7 @@ public class BulkRequest extends ActionRequest<BulkRequest> implements Composite /** * The list of optional payloads associated with requests in the same order as the requests. Note, elements within * it might be null if no payload has been provided. - * <p/> + * <p> * Note, if no payloads have been provided, this method will return null (as to conserve memory overhead). */ @Nullable diff --git a/core/src/main/java/org/elasticsearch/action/count/CountRequest.java b/core/src/main/java/org/elasticsearch/action/count/CountRequest.java index 1d35af42e5..05e193a426 100644 --- a/core/src/main/java/org/elasticsearch/action/count/CountRequest.java +++ b/core/src/main/java/org/elasticsearch/action/count/CountRequest.java @@ -44,8 +44,8 @@ import static org.elasticsearch.search.internal.SearchContext.DEFAULT_TERMINATE_ /** * A request to count the number of documents matching a specific query. Best created with * {@link org.elasticsearch.client.Requests#countRequest(String...)}. - * <p/> - * <p>The request requires the query source to be set either using {@link #source(QuerySourceBuilder)}, + * <p> + * The request requires the query source to be set either using {@link #source(QuerySourceBuilder)}, * or {@link #source(byte[])}. * * @see CountResponse diff --git a/core/src/main/java/org/elasticsearch/action/count/CountRequestBuilder.java b/core/src/main/java/org/elasticsearch/action/count/CountRequestBuilder.java index 3716bf21a6..54c60e5736 100644 --- a/core/src/main/java/org/elasticsearch/action/count/CountRequestBuilder.java +++ b/core/src/main/java/org/elasticsearch/action/count/CountRequestBuilder.java @@ -71,7 +71,7 @@ public class CountRequestBuilder extends BroadcastOperationRequestBuilder<CountR /** * Sets the preference to execute the search. Defaults to randomize across shards. Can be set to * <tt>_local</tt> to prefer local shards, <tt>_primary</tt> to execute only on primary shards, - * _shards:x,y to operate on shards x & y, or a custom value, which guarantees that the same order + * _shards:x,y to operate on shards x & y, or a custom value, which guarantees that the same order * will be used across different requests. */ public CountRequestBuilder setPreference(String preference) { diff --git a/core/src/main/java/org/elasticsearch/action/delete/DeleteRequest.java b/core/src/main/java/org/elasticsearch/action/delete/DeleteRequest.java index c5d5e78141..037f7439f8 100644 --- a/core/src/main/java/org/elasticsearch/action/delete/DeleteRequest.java +++ b/core/src/main/java/org/elasticsearch/action/delete/DeleteRequest.java @@ -36,8 +36,8 @@ import static org.elasticsearch.action.ValidateActions.addValidationError; /** * A request to delete a document from an index based on its type and id. Best created using * {@link org.elasticsearch.client.Requests#deleteRequest(String)}. - * <p/> - * <p>The operation requires the {@link #index()}, {@link #type(String)} and {@link #id(String)} to + * <p> + * The operation requires the {@link #index()}, {@link #type(String)} and {@link #id(String)} to * be set. * * @see DeleteResponse diff --git a/core/src/main/java/org/elasticsearch/action/exists/ExistsRequestBuilder.java b/core/src/main/java/org/elasticsearch/action/exists/ExistsRequestBuilder.java index 3838e09b56..c7ef5a10ce 100644 --- a/core/src/main/java/org/elasticsearch/action/exists/ExistsRequestBuilder.java +++ b/core/src/main/java/org/elasticsearch/action/exists/ExistsRequestBuilder.java @@ -51,7 +51,7 @@ public class ExistsRequestBuilder extends BroadcastOperationRequestBuilder<Exist /** * Sets the preference to execute the search. Defaults to randomize across shards. Can be set to * <tt>_local</tt> to prefer local shards, <tt>_primary</tt> to execute only on primary shards, - * _shards:x,y to operate on shards x & y, or a custom value, which guarantees that the same order + * _shards:x,y to operate on shards x & y, or a custom value, which guarantees that the same order * will be used across different requests. */ public ExistsRequestBuilder setPreference(String preference) { diff --git a/core/src/main/java/org/elasticsearch/action/get/GetRequest.java b/core/src/main/java/org/elasticsearch/action/get/GetRequest.java index 8403282620..935170e4b4 100644 --- a/core/src/main/java/org/elasticsearch/action/get/GetRequest.java +++ b/core/src/main/java/org/elasticsearch/action/get/GetRequest.java @@ -36,8 +36,8 @@ import java.io.IOException; /** * A request to get a document (its source) from an index based on its type (optional) and id. Best created using * {@link org.elasticsearch.client.Requests#getRequest(String)}. - * <p/> - * <p>The operation requires the {@link #index()}, {@link #type(String)} and {@link #id(String)} + * <p> + * The operation requires the {@link #index()}, {@link #type(String)} and {@link #id(String)} * to be set. * * @see org.elasticsearch.action.get.GetResponse diff --git a/core/src/main/java/org/elasticsearch/action/index/IndexRequest.java b/core/src/main/java/org/elasticsearch/action/index/IndexRequest.java index 7edf865539..b0579660f7 100644 --- a/core/src/main/java/org/elasticsearch/action/index/IndexRequest.java +++ b/core/src/main/java/org/elasticsearch/action/index/IndexRequest.java @@ -49,15 +49,15 @@ import static org.elasticsearch.action.ValidateActions.addValidationError; /** * Index request to index a typed JSON document into a specific index and make it searchable. Best * created using {@link org.elasticsearch.client.Requests#indexRequest(String)}. - * <p/> - * <p>The index requires the {@link #index()}, {@link #type(String)}, {@link #id(String)} and + * <p> + * The index requires the {@link #index()}, {@link #type(String)}, {@link #id(String)} and * {@link #source(byte[])} to be set. - * <p/> - * <p>The source (content to index) can be set in its bytes form using ({@link #source(byte[])}), + * <p> + * The source (content to index) can be set in its bytes form using ({@link #source(byte[])}), * its string form ({@link #source(String)}) or using a {@link org.elasticsearch.common.xcontent.XContentBuilder} * ({@link #source(org.elasticsearch.common.xcontent.XContentBuilder)}). - * <p/> - * <p>If the {@link #id(String)} is not set, it will be automatically generated. + * <p> + * If the {@link #id(String)} is not set, it will be automatically generated. * * @see IndexResponse * @see org.elasticsearch.client.Requests#indexRequest(String) @@ -316,7 +316,7 @@ public class IndexRequest extends ReplicationRequest<IndexRequest> implements Do } /** - * Sets the relative ttl value. It musts be > 0 as it makes little sense otherwise. Setting it + * Sets the relative ttl value. It musts be > 0 as it makes little sense otherwise. Setting it * to <tt>null</tt> will reset to have no ttl. */ public IndexRequest ttl(Long ttl) throws ElasticsearchGenerationException { @@ -372,8 +372,8 @@ public class IndexRequest extends ReplicationRequest<IndexRequest> implements Do /** * Sets the document source to index. - * <p/> - * <p>Note, its preferable to either set it using {@link #source(org.elasticsearch.common.xcontent.XContentBuilder)} + * <p> + * Note, its preferable to either set it using {@link #source(org.elasticsearch.common.xcontent.XContentBuilder)} * or using the {@link #source(byte[])}. */ public IndexRequest source(String source) { diff --git a/core/src/main/java/org/elasticsearch/action/index/IndexRequestBuilder.java b/core/src/main/java/org/elasticsearch/action/index/IndexRequestBuilder.java index 5b6674e38a..2df8fec6d2 100644 --- a/core/src/main/java/org/elasticsearch/action/index/IndexRequestBuilder.java +++ b/core/src/main/java/org/elasticsearch/action/index/IndexRequestBuilder.java @@ -107,8 +107,8 @@ public class IndexRequestBuilder extends ReplicationRequestBuilder<IndexRequest, /** * Sets the document source to index. - * <p/> - * <p>Note, its preferable to either set it using {@link #setSource(org.elasticsearch.common.xcontent.XContentBuilder)} + * <p> + * Note, its preferable to either set it using {@link #setSource(org.elasticsearch.common.xcontent.XContentBuilder)} * or using the {@link #setSource(byte[])}. */ public IndexRequestBuilder setSource(String source) { diff --git a/core/src/main/java/org/elasticsearch/action/index/TransportIndexAction.java b/core/src/main/java/org/elasticsearch/action/index/TransportIndexAction.java index ad875c4b11..60dfa9ee73 100644 --- a/core/src/main/java/org/elasticsearch/action/index/TransportIndexAction.java +++ b/core/src/main/java/org/elasticsearch/action/index/TransportIndexAction.java @@ -55,8 +55,8 @@ import org.elasticsearch.transport.TransportService; /** * Performs the index operation. - * <p/> - * <p>Allows for the following settings: + * <p> + * Allows for the following settings: * <ul> * <li><b>autoCreateIndex</b>: When set to <tt>true</tt>, will automatically create an index if one does not exists. * Defaults to <tt>true</tt>. diff --git a/core/src/main/java/org/elasticsearch/action/indexedscripts/delete/DeleteIndexedScriptRequest.java b/core/src/main/java/org/elasticsearch/action/indexedscripts/delete/DeleteIndexedScriptRequest.java index b757e647f3..4e8019a3ae 100644 --- a/core/src/main/java/org/elasticsearch/action/indexedscripts/delete/DeleteIndexedScriptRequest.java +++ b/core/src/main/java/org/elasticsearch/action/indexedscripts/delete/DeleteIndexedScriptRequest.java @@ -35,8 +35,8 @@ import static org.elasticsearch.action.ValidateActions.addValidationError; /** * A request to delete a script from the script index based on its scriptLang and id. Best created using - * <p/> - * <p>The operation requires the , {@link #scriptLang(String)} and {@link #id(String)} to + * <p> + * The operation requires the , {@link #scriptLang(String)} and {@link #id(String)} to * be set. * * @see DeleteIndexedScriptResponse diff --git a/core/src/main/java/org/elasticsearch/action/indexedscripts/put/PutIndexedScriptRequest.java b/core/src/main/java/org/elasticsearch/action/indexedscripts/put/PutIndexedScriptRequest.java index d3654d5eff..76b2dcc052 100644 --- a/core/src/main/java/org/elasticsearch/action/indexedscripts/put/PutIndexedScriptRequest.java +++ b/core/src/main/java/org/elasticsearch/action/indexedscripts/put/PutIndexedScriptRequest.java @@ -46,15 +46,15 @@ import static org.elasticsearch.action.ValidateActions.addValidationError; /** * Index request to index a script to the script index and make it available at search time. - * <p/> - * <p>The request requires the {@link #scriptLang(String)}, {@link #id(String)} and + * <p> + * The request requires the {@link #scriptLang(String)}, {@link #id(String)} and * {@link #source(byte[])} to be set. - * <p/> - * <p>The source (content to index) can be set in its bytes form using ({@link #source()} (byte[])}), + * <p> + * The source (content to index) can be set in its bytes form using ({@link #source()} (byte[])}), * its string form ({@link #source(String)}) or using a {@link org.elasticsearch.common.xcontent.XContentBuilder} * ({@link #source(org.elasticsearch.common.xcontent.XContentBuilder)}). - * <p/> - * <p>If the {@link #id(String)} is not set, it will be automatically generated. + * <p> + * If the {@link #id(String)} is not set, it will be automatically generated. * * @see PutIndexedScriptResponse */ @@ -200,8 +200,8 @@ public class PutIndexedScriptRequest extends ActionRequest<PutIndexedScriptReque /** * Sets the document source to index. - * <p/> - * <p>Note, its preferable to either set it using {@link #source(org.elasticsearch.common.xcontent.XContentBuilder)} + * <p> + * Note, its preferable to either set it using {@link #source(org.elasticsearch.common.xcontent.XContentBuilder)} * or using the {@link #source(byte[])}. */ public PutIndexedScriptRequest source(String source) { diff --git a/core/src/main/java/org/elasticsearch/action/indexedscripts/put/PutIndexedScriptRequestBuilder.java b/core/src/main/java/org/elasticsearch/action/indexedscripts/put/PutIndexedScriptRequestBuilder.java index 50c4c96922..eb07941fc1 100644 --- a/core/src/main/java/org/elasticsearch/action/indexedscripts/put/PutIndexedScriptRequestBuilder.java +++ b/core/src/main/java/org/elasticsearch/action/indexedscripts/put/PutIndexedScriptRequestBuilder.java @@ -85,8 +85,8 @@ public class PutIndexedScriptRequestBuilder extends ActionRequestBuilder<PutInde /** * Sets the document source to index. - * <p/> - * <p>Note, its preferable to either set it using {@link #setSource(org.elasticsearch.common.xcontent.XContentBuilder)} + * <p> + * Note, its preferable to either set it using {@link #setSource(org.elasticsearch.common.xcontent.XContentBuilder)} * or using the {@link #setSource(byte[])}. */ public PutIndexedScriptRequestBuilder setSource(String source) { diff --git a/core/src/main/java/org/elasticsearch/action/percolate/MultiPercolateRequestBuilder.java b/core/src/main/java/org/elasticsearch/action/percolate/MultiPercolateRequestBuilder.java index 54d88cbbb8..df36f9ff7f 100644 --- a/core/src/main/java/org/elasticsearch/action/percolate/MultiPercolateRequestBuilder.java +++ b/core/src/main/java/org/elasticsearch/action/percolate/MultiPercolateRequestBuilder.java @@ -49,7 +49,7 @@ public class MultiPercolateRequestBuilder extends ActionRequestBuilder<MultiPerc /** * Specifies how to globally ignore indices that are not available and how to deal with wildcard indices expressions. - * <p/> + * <p> * Invoke this method before invoking {@link #add(PercolateRequestBuilder)}. */ public MultiPercolateRequestBuilder setIndicesOptions(IndicesOptions indicesOptions) { diff --git a/core/src/main/java/org/elasticsearch/action/search/MultiSearchRequestBuilder.java b/core/src/main/java/org/elasticsearch/action/search/MultiSearchRequestBuilder.java index 58697fddd2..a0d1e4fb5c 100644 --- a/core/src/main/java/org/elasticsearch/action/search/MultiSearchRequestBuilder.java +++ b/core/src/main/java/org/elasticsearch/action/search/MultiSearchRequestBuilder.java @@ -35,7 +35,7 @@ public class MultiSearchRequestBuilder extends ActionRequestBuilder<MultiSearchR /** * Add a search request to execute. Note, the order is important, the search response will be returned in the * same order as the search requests. - * <p/> + * <p> * If ignoreIndices has been set on the search request, then the indicesOptions of the multi search request * will not be used (if set). */ @@ -64,7 +64,7 @@ public class MultiSearchRequestBuilder extends ActionRequestBuilder<MultiSearchR /** * Specifies what type of requested indices to ignore and how to deal with wildcard indices expressions. * For example indices that don't exist. - * <p/> + * <p> * Invoke this method before invoking {@link #add(SearchRequestBuilder)}. */ public MultiSearchRequestBuilder setIndicesOptions(IndicesOptions indicesOptions) { diff --git a/core/src/main/java/org/elasticsearch/action/search/SearchRequest.java b/core/src/main/java/org/elasticsearch/action/search/SearchRequest.java index abc1ba58d6..9348185e51 100644 --- a/core/src/main/java/org/elasticsearch/action/search/SearchRequest.java +++ b/core/src/main/java/org/elasticsearch/action/search/SearchRequest.java @@ -50,11 +50,11 @@ import static org.elasticsearch.search.Scroll.readScroll; /** * A request to execute search against one or more indices (or all). Best created using * {@link org.elasticsearch.client.Requests#searchRequest(String...)}. - * <p/> - * <p>Note, the search {@link #source(org.elasticsearch.search.builder.SearchSourceBuilder)} + * <p> + * Note, the search {@link #source(org.elasticsearch.search.builder.SearchSourceBuilder)} * is required. The search source is the different search options, including aggregations and such. - * <p/> - * <p>There is an option to specify an addition search source using the {@link #extraSource(org.elasticsearch.search.builder.SearchSourceBuilder)}. + * <p> + * There is an option to specify an addition search source using the {@link #extraSource(org.elasticsearch.search.builder.SearchSourceBuilder)}. * * @see org.elasticsearch.client.Requests#searchRequest(String...) * @see org.elasticsearch.client.Client#search(SearchRequest) @@ -319,7 +319,7 @@ public class SearchRequest extends ActionRequest<SearchRequest> implements Indic /** * The name of the stored template * - * @deprecated use {@link #template(Template))} instead. + * @deprecated use {@link #template(Template)} instead. */ @Deprecated public void templateName(String templateName) { @@ -329,7 +329,7 @@ public class SearchRequest extends ActionRequest<SearchRequest> implements Indic /** * The type of the stored template * - * @deprecated use {@link #template(Template))} instead. + * @deprecated use {@link #template(Template)} instead. */ @Deprecated public void templateType(ScriptService.ScriptType templateType) { @@ -339,7 +339,7 @@ public class SearchRequest extends ActionRequest<SearchRequest> implements Indic /** * Template parameters used for rendering * - * @deprecated use {@link #template(Template))} instead. + * @deprecated use {@link #template(Template)} instead. */ @Deprecated public void templateParams(Map<String, Object> params) { diff --git a/core/src/main/java/org/elasticsearch/action/search/SearchRequestBuilder.java b/core/src/main/java/org/elasticsearch/action/search/SearchRequestBuilder.java index 7caf82871b..d6007151e1 100644 --- a/core/src/main/java/org/elasticsearch/action/search/SearchRequestBuilder.java +++ b/core/src/main/java/org/elasticsearch/action/search/SearchRequestBuilder.java @@ -167,7 +167,7 @@ public class SearchRequestBuilder extends ActionRequestBuilder<SearchRequest, Se /** * Specifies what type of requested indices to ignore and wildcard indices expressions. - * <p/> + * <p> * For example indices that don't exist. */ public SearchRequestBuilder setIndicesOptions(IndicesOptions indicesOptions) { diff --git a/core/src/main/java/org/elasticsearch/action/suggest/SuggestRequest.java b/core/src/main/java/org/elasticsearch/action/suggest/SuggestRequest.java index 764975eb7b..0d1c4932d4 100644 --- a/core/src/main/java/org/elasticsearch/action/suggest/SuggestRequest.java +++ b/core/src/main/java/org/elasticsearch/action/suggest/SuggestRequest.java @@ -37,8 +37,8 @@ import java.util.Arrays; /** * A request to get suggestions for corrections of phrases. Best created with * {@link org.elasticsearch.client.Requests#suggestRequest(String...)}. - * <p/> - * <p>The request requires the suggest query source to be set either using + * <p> + * The request requires the suggest query source to be set either using * {@link #suggest(org.elasticsearch.common.bytes.BytesReference)} / {@link #suggest(org.elasticsearch.common.bytes.BytesReference)} * or by using {@link #suggest(org.elasticsearch.search.suggest.SuggestBuilder)} * (Best created using the {link @org.elasticsearch.search.suggest.SuggestBuilders)}). diff --git a/core/src/main/java/org/elasticsearch/action/suggest/SuggestRequestBuilder.java b/core/src/main/java/org/elasticsearch/action/suggest/SuggestRequestBuilder.java index 954b86c6ff..06a2b00c64 100644 --- a/core/src/main/java/org/elasticsearch/action/suggest/SuggestRequestBuilder.java +++ b/core/src/main/java/org/elasticsearch/action/suggest/SuggestRequestBuilder.java @@ -66,7 +66,7 @@ public class SuggestRequestBuilder extends BroadcastOperationRequestBuilder<Sugg /** * Sets the preference to execute the search. Defaults to randomize across shards. Can be set to * <tt>_local</tt> to prefer local shards, <tt>_primary</tt> to execute only on primary shards, - * _shards:x,y to operate on shards x & y, or a custom value, which guarantees that the same order + * _shards:x,y to operate on shards x & y, or a custom value, which guarantees that the same order * will be used across different requests. */ public SuggestRequestBuilder setPreference(String preference) { diff --git a/core/src/main/java/org/elasticsearch/action/support/broadcast/node/TransportBroadcastByNodeAction.java b/core/src/main/java/org/elasticsearch/action/support/broadcast/node/TransportBroadcastByNodeAction.java index 77f9665085..7154c74ce4 100644 --- a/core/src/main/java/org/elasticsearch/action/support/broadcast/node/TransportBroadcastByNodeAction.java +++ b/core/src/main/java/org/elasticsearch/action/support/broadcast/node/TransportBroadcastByNodeAction.java @@ -127,7 +127,6 @@ public abstract class TransportBroadcastByNodeAction<Request extends BroadcastRe * * @param in input stream * @return a deserialized shard-level result - * @throws IOException */ protected abstract ShardOperationResult readShardResult(StreamInput in) throws IOException; @@ -150,7 +149,6 @@ public abstract class TransportBroadcastByNodeAction<Request extends BroadcastRe * * @param in input stream * @return a de-serialized request - * @throws IOException */ protected abstract Request readRequestFrom(StreamInput in) throws IOException; diff --git a/core/src/main/java/org/elasticsearch/action/support/replication/TransportReplicationAction.java b/core/src/main/java/org/elasticsearch/action/support/replication/TransportReplicationAction.java index 18890dc2af..6e2ea505fe 100644 --- a/core/src/main/java/org/elasticsearch/action/support/replication/TransportReplicationAction.java +++ b/core/src/main/java/org/elasticsearch/action/support/replication/TransportReplicationAction.java @@ -341,7 +341,7 @@ public abstract class TransportReplicationAction<Request extends ReplicationRequ /** * Responsible for performing all operations up to the point we start starting sending requests to replica shards. * Including forwarding the request to another node if the primary is not assigned locally. - * <p/> + * <p> * Note that as soon as we start sending request to replicas, state responsibility is transferred to {@link ReplicationPhase} */ final class PrimaryPhase extends AbstractRunnable { diff --git a/core/src/main/java/org/elasticsearch/action/termvectors/TermVectorsFields.java b/core/src/main/java/org/elasticsearch/action/termvectors/TermVectorsFields.java index 127756e6b2..7be1061d2f 100644 --- a/core/src/main/java/org/elasticsearch/action/termvectors/TermVectorsFields.java +++ b/core/src/main/java/org/elasticsearch/action/termvectors/TermVectorsFields.java @@ -42,10 +42,10 @@ import static org.apache.lucene.util.ArrayUtil.grow; * offsets and payloads even if positions are not present. You must call * nextPosition() anyway to move the counter although this method only returns * <tt>-1,</tt>, if no positions were returned by the {@link TermVectorsRequest}. - * <p/> + * <p> * The data is stored in two byte arrays ({@code headerRef} and * {@code termVectors}, both {@link BytesRef}) that have the following format: - * <p/> + * <p> * {@code headerRef}: Stores offsets per field in the {@code termVectors} array * and some header information as {@link BytesRef}. Format is * <ul> @@ -54,6 +54,7 @@ import static org.apache.lucene.util.ArrayUtil.grow; * <li>boolean: hasTermStatistics (are the term statistics stored?)</li> * <li>boolean: hasFieldStatitsics (are the field statistics stored?)</li> * <li>vint: number of fields</li> + * <li> * <ul> * <li>String: field name 1</li> * <li>vint: offset in {@code termVectors} for field 1</li> @@ -61,10 +62,11 @@ import static org.apache.lucene.util.ArrayUtil.grow; * <li>String: field name last field</li> * <li>vint: offset in {@code termVectors} for last field</li> * </ul> + * </li> * </ul> - * <p/> + * <p> * termVectors: Stores the actual term vectors as a {@link BytesRef}. - * <p/> + * <p> * Term vectors for each fields are stored in blocks, one for each field. The * offsets in {@code headerRef} are used to find where the block for a field * starts. Each block begins with a @@ -82,14 +84,13 @@ import static org.apache.lucene.util.ArrayUtil.grow; * <li>vint: number of documents in the shard that has an entry for this field * (docCount)</li> * </ul> - * <p/> + * <p> * After that, for each term it stores * <ul> - * <ul> * <li>vint: term lengths</li> * <li>BytesRef: term name</li> * </ul> - * <p/> + * <p> * If term statistics are requested ({@code hasTermStatistics} is true, see * {@code headerRef}): * <ul> @@ -99,6 +100,7 @@ import static org.apache.lucene.util.ArrayUtil.grow; * After that * <ul> * <li>vint: frequency (always returned)</li> + * <li> * <ul> * <li>vint: position_1 (if positions == true)</li> * <li>vint: startOffset_1 (if offset == true)</li> @@ -107,8 +109,8 @@ import static org.apache.lucene.util.ArrayUtil.grow; * <li>...</li> * <li>vint: endOffset_freqency (if offset == true)</li> * <li>BytesRef: payload_freqency (if payloads == true)</li> - * <ul> - * </ul> </ul> + * </ul></li> + * </ul> */ public final class TermVectorsFields extends Fields { @@ -494,4 +496,4 @@ public final class TermVectorsFields extends Fields { long readPotentiallyNegativeVLong(StreamInput stream) throws IOException { return stream.readVLong() - 1; } -}
\ No newline at end of file +} diff --git a/core/src/main/java/org/elasticsearch/action/termvectors/TermVectorsRequest.java b/core/src/main/java/org/elasticsearch/action/termvectors/TermVectorsRequest.java index fdc9a4174e..ef998922d5 100644 --- a/core/src/main/java/org/elasticsearch/action/termvectors/TermVectorsRequest.java +++ b/core/src/main/java/org/elasticsearch/action/termvectors/TermVectorsRequest.java @@ -52,7 +52,7 @@ import static org.elasticsearch.common.xcontent.XContentFactory.jsonBuilder; /** * Request returning the term vector (doc frequency, positions, offsets) for a * document. - * <p/> + * <p> * Note, the {@link #index()}, {@link #type(String)} and {@link #id(String)} are * required. */ diff --git a/core/src/main/java/org/elasticsearch/action/termvectors/TermVectorsRequestBuilder.java b/core/src/main/java/org/elasticsearch/action/termvectors/TermVectorsRequestBuilder.java index 85027040e8..9bf9957e1e 100644 --- a/core/src/main/java/org/elasticsearch/action/termvectors/TermVectorsRequestBuilder.java +++ b/core/src/main/java/org/elasticsearch/action/termvectors/TermVectorsRequestBuilder.java @@ -30,7 +30,7 @@ import java.util.Map; /** * The builder class for a term vector request. * Returns the term vector (doc frequency, positions, offsets) for a document. - * <p/> + * <p> * Note, the {@code index}, {@code type} and {@code id} are * required. */ diff --git a/core/src/main/java/org/elasticsearch/action/update/UpdateRequestBuilder.java b/core/src/main/java/org/elasticsearch/action/update/UpdateRequestBuilder.java index 918d2d7b93..5b0a5bb9c5 100644 --- a/core/src/main/java/org/elasticsearch/action/update/UpdateRequestBuilder.java +++ b/core/src/main/java/org/elasticsearch/action/update/UpdateRequestBuilder.java @@ -76,7 +76,7 @@ public class UpdateRequestBuilder extends InstanceShardOperationRequestBuilder<U /** * The script to execute. Note, make sure not to send different script each times and instead * use script params if possible with the same (automatically compiled) script. - * <p/> + * <p> * The script works with the variable <code>ctx</code>, which is bound to the entry, * e.g. <code>ctx._source.mycounter += 1</code>. * diff --git a/core/src/main/java/org/elasticsearch/bootstrap/JNAKernel32Library.java b/core/src/main/java/org/elasticsearch/bootstrap/JNAKernel32Library.java index 2a129f0726..8924812e6d 100644 --- a/core/src/main/java/org/elasticsearch/bootstrap/JNAKernel32Library.java +++ b/core/src/main/java/org/elasticsearch/bootstrap/JNAKernel32Library.java @@ -68,7 +68,6 @@ final class JNAKernel32Library { /** * Adds a Console Ctrl Handler. * - * @param handler * @return true if the handler is correctly set * @throws java.lang.UnsatisfiedLinkError if the Kernel32 library is not loaded or if the native function is not found * @throws java.lang.NoClassDefFoundError if the library for native calls is missing @@ -92,8 +91,6 @@ final class JNAKernel32Library { /** * Native call to the Kernel32 API to set a new Console Ctrl Handler. * - * @param handler - * @param add * @return true if the handler is correctly set * @throws java.lang.UnsatisfiedLinkError if the Kernel32 library is not loaded or if the native function is not found * @throws java.lang.NoClassDefFoundError if the library for native calls is missing @@ -102,7 +99,7 @@ final class JNAKernel32Library { /** * Handles consoles event with WIN API - * <p/> + * <p> * See http://msdn.microsoft.com/en-us/library/windows/desktop/ms683242%28v=vs.85%29.aspx */ class NativeHandlerCallback implements StdCallLibrary.StdCallCallback { diff --git a/core/src/main/java/org/elasticsearch/bootstrap/Security.java b/core/src/main/java/org/elasticsearch/bootstrap/Security.java index 263af4383d..c2dffc5300 100644 --- a/core/src/main/java/org/elasticsearch/bootstrap/Security.java +++ b/core/src/main/java/org/elasticsearch/bootstrap/Security.java @@ -40,7 +40,7 @@ import java.util.regex.Pattern; /** * Initializes SecurityManager with necessary permissions. - * <p> + * <br> * <h1>Initialization</h1> * The JVM is not initially started with security manager enabled, * instead we turn it on early in the startup process. This is a tradeoff @@ -51,7 +51,7 @@ import java.util.regex.Pattern; * <li>Allows for some contained usage of native code that would not * otherwise be permitted.</li> * </ul> - * <p> + * <br> * <h1>Permissions</h1> * Permissions use a policy file packaged as a resource, this file is * also used in tests. File permissions are generated dynamically and @@ -71,13 +71,13 @@ import java.util.regex.Pattern; * behalf (no package protections are yet in place, this would need some * cleanups to the scripting apis). But still it can provide some defense for users * that enable dynamic scripting without being fully aware of the consequences. - * <p> + * <br> * <h1>Disabling Security</h1> * SecurityManager can be disabled completely with this setting: * <pre> * es.security.manager.enabled = false * </pre> - * <p> + * <br> * <h1>Debugging Security</h1> * A good place to start when there is a problem is to turn on security debugging: * <pre> diff --git a/core/src/main/java/org/elasticsearch/client/Client.java b/core/src/main/java/org/elasticsearch/client/Client.java index 3f60f267cf..eafac2b650 100644 --- a/core/src/main/java/org/elasticsearch/client/Client.java +++ b/core/src/main/java/org/elasticsearch/client/Client.java @@ -71,12 +71,12 @@ import org.elasticsearch.common.settings.Settings; /** * A client provides a one stop interface for performing actions/operations against the cluster. - * <p/> - * <p>All operations performed are asynchronous by nature. Each action/operation has two flavors, the first + * <p> + * All operations performed are asynchronous by nature. Each action/operation has two flavors, the first * simply returns an {@link org.elasticsearch.action.ActionFuture}, while the second accepts an * {@link org.elasticsearch.action.ActionListener}. - * <p/> - * <p>A client can either be retrieved from a {@link org.elasticsearch.node.Node} started, or connected remotely + * <p> + * A client can either be retrieved from a {@link org.elasticsearch.node.Node} started, or connected remotely * to one or more nodes using {@link org.elasticsearch.client.transport.TransportClient}. * * @see org.elasticsearch.node.Node#client() @@ -94,8 +94,8 @@ public interface Client extends ElasticsearchClient, Releasable { /** * Index a JSON source associated with a given index and type. - * <p/> - * <p>The id is optional, if it is not provided, one will be generated automatically. + * <p> + * The id is optional, if it is not provided, one will be generated automatically. * * @param request The index request * @return The result future @@ -105,8 +105,8 @@ public interface Client extends ElasticsearchClient, Releasable { /** * Index a document associated with a given index and type. - * <p/> - * <p>The id is optional, if it is not provided, one will be generated automatically. + * <p> + * The id is optional, if it is not provided, one will be generated automatically. * * @param request The index request * @param listener A listener to be notified with a result @@ -116,8 +116,8 @@ public interface Client extends ElasticsearchClient, Releasable { /** * Index a document associated with a given index and type. - * <p/> - * <p>The id is optional, if it is not provided, one will be generated automatically. + * <p> + * The id is optional, if it is not provided, one will be generated automatically. */ IndexRequestBuilder prepareIndex(); @@ -149,8 +149,8 @@ public interface Client extends ElasticsearchClient, Releasable { /** * Index a document associated with a given index and type. - * <p/> - * <p>The id is optional, if it is not provided, one will be generated automatically. + * <p> + * The id is optional, if it is not provided, one will be generated automatically. * * @param index The index to index the document to * @param type The type to index the document to @@ -159,8 +159,8 @@ public interface Client extends ElasticsearchClient, Releasable { /** * Index a document associated with a given index and type. - * <p/> - * <p>The id is optional, if it is not provided, one will be generated automatically. + * <p> + * The id is optional, if it is not provided, one will be generated automatically. * * @param index The index to index the document to * @param type The type to index the document to @@ -482,7 +482,6 @@ public interface Client extends ElasticsearchClient, Releasable { * An action that returns the term vectors for a specific document. * * @param request The term vector request - * @return The response future */ void termVectors(TermVectorsRequest request, ActionListener<TermVectorsResponse> listener); @@ -513,7 +512,6 @@ public interface Client extends ElasticsearchClient, Releasable { * An action that returns the term vectors for a specific document. * * @param request The term vector request - * @return The response future */ @Deprecated void termVector(TermVectorsRequest request, ActionListener<TermVectorsResponse> listener); diff --git a/core/src/main/java/org/elasticsearch/client/transport/TransportClient.java b/core/src/main/java/org/elasticsearch/client/transport/TransportClient.java index c56124fac3..17551012ed 100644 --- a/core/src/main/java/org/elasticsearch/client/transport/TransportClient.java +++ b/core/src/main/java/org/elasticsearch/client/transport/TransportClient.java @@ -65,8 +65,8 @@ import static org.elasticsearch.common.settings.Settings.settingsBuilder; /** * The transport client allows to create a client that is not part of the cluster, but simply connects to one * or more nodes directly by adding their respective addresses using {@link #addTransportAddress(org.elasticsearch.common.transport.TransportAddress)}. - * <p/> - * <p>The transport client important modules used is the {@link org.elasticsearch.transport.TransportModule} which is + * <p> + * The transport client important modules used is the {@link org.elasticsearch.transport.TransportModule} which is * started in client mode (only connects, no bind). */ public class TransportClient extends AbstractClient { @@ -196,8 +196,8 @@ public class TransportClient extends AbstractClient { /** * Returns the current connected transport nodes that this client will use. - * <p/> - * <p>The nodes include all the nodes that are currently alive based on the transport + * <p> + * The nodes include all the nodes that are currently alive based on the transport * addresses provided. */ public List<DiscoveryNode> connectedNodes() { @@ -221,11 +221,11 @@ public class TransportClient extends AbstractClient { /** * Adds a transport address that will be used to connect to. - * <p/> - * <p>The Node this transport address represents will be used if its possible to connect to it. + * <p> + * The Node this transport address represents will be used if its possible to connect to it. * If it is unavailable, it will be automatically connected to once it is up. - * <p/> - * <p>In order to get the list of all the current connected nodes, please see {@link #connectedNodes()}. + * <p> + * In order to get the list of all the current connected nodes, please see {@link #connectedNodes()}. */ public TransportClient addTransportAddress(TransportAddress transportAddress) { nodesService.addTransportAddresses(transportAddress); @@ -234,11 +234,11 @@ public class TransportClient extends AbstractClient { /** * Adds a list of transport addresses that will be used to connect to. - * <p/> - * <p>The Node this transport address represents will be used if its possible to connect to it. + * <p> + * The Node this transport address represents will be used if its possible to connect to it. * If it is unavailable, it will be automatically connected to once it is up. - * <p/> - * <p>In order to get the list of all the current connected nodes, please see {@link #connectedNodes()}. + * <p> + * In order to get the list of all the current connected nodes, please see {@link #connectedNodes()}. */ public TransportClient addTransportAddresses(TransportAddress... transportAddress) { nodesService.addTransportAddresses(transportAddress); diff --git a/core/src/main/java/org/elasticsearch/cluster/ClusterState.java b/core/src/main/java/org/elasticsearch/cluster/ClusterState.java index 21962fb421..3a71530d6a 100644 --- a/core/src/main/java/org/elasticsearch/cluster/ClusterState.java +++ b/core/src/main/java/org/elasticsearch/cluster/ClusterState.java @@ -295,7 +295,7 @@ public class ClusterState implements ToXContent, Diffable<ClusterState> { /** * a cluster state supersedes another state iff they are from the same master and the version this state is higher thant the other state. - * <p/> + * <p> * In essence that means that all the changes from the other cluster state are also reflected by the current one */ public boolean supersedes(ClusterState other) { diff --git a/core/src/main/java/org/elasticsearch/cluster/ClusterStateObserver.java b/core/src/main/java/org/elasticsearch/cluster/ClusterStateObserver.java index ca46416685..a035cf7c36 100644 --- a/core/src/main/java/org/elasticsearch/cluster/ClusterStateObserver.java +++ b/core/src/main/java/org/elasticsearch/cluster/ClusterStateObserver.java @@ -60,7 +60,6 @@ public class ClusterStateObserver { } /** - * @param clusterService * @param timeout a global timeout for this observer. After it has expired the observer * will fail any existing or new #waitForNextChange calls. Set to null * to wait indefinitely @@ -157,8 +156,6 @@ public class ClusterStateObserver { /** * reset this observer to the give cluster state. Any pending waits will be canceled. - * - * @param toState */ public void reset(ClusterState toState) { if (observingContext.getAndSet(null) != null) { diff --git a/core/src/main/java/org/elasticsearch/cluster/Diff.java b/core/src/main/java/org/elasticsearch/cluster/Diff.java index 2e571f43bc..1a9fff246a 100644 --- a/core/src/main/java/org/elasticsearch/cluster/Diff.java +++ b/core/src/main/java/org/elasticsearch/cluster/Diff.java @@ -35,8 +35,6 @@ public interface Diff<T> { /** * Writes the differences into the output stream - * @param out - * @throws IOException */ void writeTo(StreamOutput out) throws IOException; } diff --git a/core/src/main/java/org/elasticsearch/cluster/IncompatibleClusterStateVersionException.java b/core/src/main/java/org/elasticsearch/cluster/IncompatibleClusterStateVersionException.java index 9bead8554b..f191c202c4 100644 --- a/core/src/main/java/org/elasticsearch/cluster/IncompatibleClusterStateVersionException.java +++ b/core/src/main/java/org/elasticsearch/cluster/IncompatibleClusterStateVersionException.java @@ -20,12 +20,13 @@ package org.elasticsearch.cluster; import org.elasticsearch.ElasticsearchException; +import org.elasticsearch.cluster.Diff; import org.elasticsearch.common.io.stream.StreamInput; import java.io.IOException; /** - * Thrown by {@link Diffable#readDiffAndApply(org.elasticsearch.common.io.stream.StreamInput)} method + * Thrown by {@link Diff#apply} method */ public class IncompatibleClusterStateVersionException extends ElasticsearchException { public IncompatibleClusterStateVersionException(String msg) { diff --git a/core/src/main/java/org/elasticsearch/cluster/InternalClusterInfoService.java b/core/src/main/java/org/elasticsearch/cluster/InternalClusterInfoService.java index 9d64369720..019e24556c 100644 --- a/core/src/main/java/org/elasticsearch/cluster/InternalClusterInfoService.java +++ b/core/src/main/java/org/elasticsearch/cluster/InternalClusterInfoService.java @@ -301,7 +301,6 @@ public class InternalClusterInfoService extends AbstractComponent implements Clu /** * Refreshes the ClusterInfo in a blocking fashion - * @return */ public final ClusterInfo refresh() { if (logger.isTraceEnabled()) { diff --git a/core/src/main/java/org/elasticsearch/cluster/RestoreInProgress.java b/core/src/main/java/org/elasticsearch/cluster/RestoreInProgress.java index eabe615d58..5776fe698d 100644 --- a/core/src/main/java/org/elasticsearch/cluster/RestoreInProgress.java +++ b/core/src/main/java/org/elasticsearch/cluster/RestoreInProgress.java @@ -270,7 +270,6 @@ public class RestoreInProgress extends AbstractDiffable<Custom> implements Custo * * @param in stream input * @return restore status - * @throws IOException */ public static ShardRestoreStatus readShardRestoreStatus(StreamInput in) throws IOException { ShardRestoreStatus shardSnapshotStatus = new ShardRestoreStatus(); @@ -282,7 +281,6 @@ public class RestoreInProgress extends AbstractDiffable<Custom> implements Custo * Reads restore status from stream input * * @param in stream input - * @throws IOException */ public void readFrom(StreamInput in) throws IOException { nodeId = in.readOptionalString(); @@ -294,7 +292,6 @@ public class RestoreInProgress extends AbstractDiffable<Custom> implements Custo * Writes restore status to stream output * * @param out stream input - * @throws IOException */ public void writeTo(StreamOutput out) throws IOException { out.writeOptionalString(nodeId); @@ -471,7 +468,6 @@ public class RestoreInProgress extends AbstractDiffable<Custom> implements Custo * @param entry restore operation metadata * @param builder XContent builder * @param params serialization parameters - * @throws IOException */ public void toXContent(Entry entry, XContentBuilder builder, ToXContent.Params params) throws IOException { builder.startObject(); diff --git a/core/src/main/java/org/elasticsearch/cluster/action/index/MappingUpdatedAction.java b/core/src/main/java/org/elasticsearch/cluster/action/index/MappingUpdatedAction.java index 2010f67d70..b13c7991b5 100644 --- a/core/src/main/java/org/elasticsearch/cluster/action/index/MappingUpdatedAction.java +++ b/core/src/main/java/org/elasticsearch/cluster/action/index/MappingUpdatedAction.java @@ -105,7 +105,7 @@ public class MappingUpdatedAction extends AbstractComponent { } /** - * Same as {@link #updateMappingOnMasterSynchronously(String, String, String, Mapping, TimeValue)} + * Same as {@link #updateMappingOnMasterSynchronously(String, String, Mapping, TimeValue)} * using the default timeout. */ public void updateMappingOnMasterSynchronously(String index, String type, Mapping mappingUpdate) throws Throwable { diff --git a/core/src/main/java/org/elasticsearch/cluster/metadata/IndexMetaData.java b/core/src/main/java/org/elasticsearch/cluster/metadata/IndexMetaData.java index 2e2458cab6..6ea1d0e6e6 100644 --- a/core/src/main/java/org/elasticsearch/cluster/metadata/IndexMetaData.java +++ b/core/src/main/java/org/elasticsearch/cluster/metadata/IndexMetaData.java @@ -430,7 +430,7 @@ public class IndexMetaData implements Diffable<IndexMetaData>, FromXContentBuild /** * Sometimes, the default mapping exists and an actual mapping is not created yet (introduced), * in this case, we want to return the default mapping in case it has some default mapping definitions. - * <p/> + * <p> * Note, once the mapping type is introduced, the default mapping is applied on the actual typed MappingMetaData, * setting its routing, timestamp, and so on if needed. */ diff --git a/core/src/main/java/org/elasticsearch/cluster/metadata/IndexNameExpressionResolver.java b/core/src/main/java/org/elasticsearch/cluster/metadata/IndexNameExpressionResolver.java index 5c7bb8e2b8..05c580ffc1 100644 --- a/core/src/main/java/org/elasticsearch/cluster/metadata/IndexNameExpressionResolver.java +++ b/core/src/main/java/org/elasticsearch/cluster/metadata/IndexNameExpressionResolver.java @@ -222,9 +222,8 @@ public class IndexNameExpressionResolver extends AbstractComponent { /** * Iterates through the list of indices and selects the effective list of filtering aliases for the * given index. - * <p/> * <p>Only aliases with filters are returned. If the indices list contains a non-filtering reference to - * the index itself - null is returned. Returns <tt>null</tt> if no filtering is required.</p> + * the index itself - null is returned. Returns <tt>null</tt> if no filtering is required. */ public String[] filteringAliases(ClusterState state, String index, String... expressions) { // expand the aliases wildcard diff --git a/core/src/main/java/org/elasticsearch/cluster/metadata/MetaDataIndexUpgradeService.java b/core/src/main/java/org/elasticsearch/cluster/metadata/MetaDataIndexUpgradeService.java index bc033fcd6d..365783b8bd 100644 --- a/core/src/main/java/org/elasticsearch/cluster/metadata/MetaDataIndexUpgradeService.java +++ b/core/src/main/java/org/elasticsearch/cluster/metadata/MetaDataIndexUpgradeService.java @@ -43,7 +43,7 @@ import java.util.Set; /** * This service is responsible for upgrading legacy index metadata to the current version - * <p/> + * <p> * Every time an existing index is introduced into cluster this service should be used * to upgrade the existing index metadata to the latest version of the cluster. It typically * occurs during cluster upgrade, when dangling indices are imported into the cluster or indices @@ -97,7 +97,7 @@ public class MetaDataIndexUpgradeService extends AbstractComponent { /** * Checks that the index can be upgraded to the current version of the master node. * - * <p/> + * <p> * If the index does not need upgrade it returns the index metadata unchanged, otherwise it returns a modified index metadata. If index * cannot be updated the method throws an exception. */ diff --git a/core/src/main/java/org/elasticsearch/cluster/metadata/RepositoriesMetaData.java b/core/src/main/java/org/elasticsearch/cluster/metadata/RepositoriesMetaData.java index 23a4c32017..b5646e17f9 100644 --- a/core/src/main/java/org/elasticsearch/cluster/metadata/RepositoriesMetaData.java +++ b/core/src/main/java/org/elasticsearch/cluster/metadata/RepositoriesMetaData.java @@ -195,7 +195,6 @@ public class RepositoriesMetaData extends AbstractDiffable<Custom> implements Me * @param repository repository metadata * @param builder XContent builder * @param params serialization parameters - * @throws IOException */ public static void toXContent(RepositoryMetaData repository, XContentBuilder builder, ToXContent.Params params) throws IOException { builder.startObject(repository.name(), XContentBuilder.FieldCaseConversion.NONE); diff --git a/core/src/main/java/org/elasticsearch/cluster/metadata/RepositoryMetaData.java b/core/src/main/java/org/elasticsearch/cluster/metadata/RepositoryMetaData.java index 182c06b7e3..3c13a10c1c 100644 --- a/core/src/main/java/org/elasticsearch/cluster/metadata/RepositoryMetaData.java +++ b/core/src/main/java/org/elasticsearch/cluster/metadata/RepositoryMetaData.java @@ -78,7 +78,6 @@ public class RepositoryMetaData { * * @param in stream input * @return repository metadata - * @throws IOException */ public static RepositoryMetaData readFrom(StreamInput in) throws IOException { String name = in.readString(); @@ -91,7 +90,6 @@ public class RepositoryMetaData { * Writes repository metadata to stream output * * @param out stream output - * @throws IOException */ public void writeTo(StreamOutput out) throws IOException { out.writeString(name); @@ -119,4 +117,4 @@ public class RepositoryMetaData { result = 31 * result + settings.hashCode(); return result; } -}
\ No newline at end of file +} diff --git a/core/src/main/java/org/elasticsearch/cluster/metadata/SnapshotId.java b/core/src/main/java/org/elasticsearch/cluster/metadata/SnapshotId.java index 132145b099..88c60f1f07 100644 --- a/core/src/main/java/org/elasticsearch/cluster/metadata/SnapshotId.java +++ b/core/src/main/java/org/elasticsearch/cluster/metadata/SnapshotId.java @@ -99,7 +99,6 @@ public class SnapshotId implements Streamable { * * @param in stream input * @return snapshot id - * @throws IOException */ public static SnapshotId readSnapshotId(StreamInput in) throws IOException { SnapshotId snapshot = new SnapshotId(); diff --git a/core/src/main/java/org/elasticsearch/cluster/routing/AllocationId.java b/core/src/main/java/org/elasticsearch/cluster/routing/AllocationId.java index 695b8e6225..efc987a59a 100644 --- a/core/src/main/java/org/elasticsearch/cluster/routing/AllocationId.java +++ b/core/src/main/java/org/elasticsearch/cluster/routing/AllocationId.java @@ -30,7 +30,7 @@ import java.io.IOException; /** * Uniquely identifies an allocation. An allocation is a shard moving from unassigned to initializing, * or relocation. - * <p/> + * <p> * Relocation is a special case, where the origin shard is relocating with a relocationId and same id, and * the target shard (only materialized in RoutingNodes) is initializing with the id set to the origin shard * relocationId. Once relocation is done, the new allocation id is set to the relocationId. This is similar @@ -83,7 +83,7 @@ public class AllocationId implements ToXContent { /** * Creates a new allocation id representing a cancelled relocation. - * <p/> + * <p> * Note that this is expected to be called on the allocation id * of the *source* shard */ @@ -94,7 +94,7 @@ public class AllocationId implements ToXContent { /** * Creates a new allocation id finalizing a relocation. - * <p/> + * <p> * Note that this is expected to be called on the allocation id * of the *target* shard and thus it only needs to clear the relocating id. */ diff --git a/core/src/main/java/org/elasticsearch/cluster/routing/HashFunction.java b/core/src/main/java/org/elasticsearch/cluster/routing/HashFunction.java index 83ddb7cc89..99977eeccb 100644 --- a/core/src/main/java/org/elasticsearch/cluster/routing/HashFunction.java +++ b/core/src/main/java/org/elasticsearch/cluster/routing/HashFunction.java @@ -34,7 +34,7 @@ public interface HashFunction { /** * Calculate a hash value for routing and its type * @param type types name - * @param routing String to calculate the hash value from + * @param id String to calculate the hash value from * @return hash value of the given type and routing string */ @Deprecated diff --git a/core/src/main/java/org/elasticsearch/cluster/routing/IndexRoutingTable.java b/core/src/main/java/org/elasticsearch/cluster/routing/IndexRoutingTable.java index 062c7b4035..42b12930f7 100644 --- a/core/src/main/java/org/elasticsearch/cluster/routing/IndexRoutingTable.java +++ b/core/src/main/java/org/elasticsearch/cluster/routing/IndexRoutingTable.java @@ -286,8 +286,8 @@ public class IndexRoutingTable extends AbstractDiffable<IndexRoutingTable> imple /** * A groups shards iterator where each groups is a single {@link ShardRouting} and a group * is created for each shard routing. - * <p/> - * <p>This basically means that components that use the {@link GroupShardsIterator} will iterate + * <p> + * This basically means that components that use the {@link GroupShardsIterator} will iterate * over *all* the shards (all the replicas) within the index.</p> */ public GroupShardsIterator groupByAllIt() { diff --git a/core/src/main/java/org/elasticsearch/cluster/routing/IndexShardRoutingTable.java b/core/src/main/java/org/elasticsearch/cluster/routing/IndexShardRoutingTable.java index 55301b4efb..e740a4fc67 100644 --- a/core/src/main/java/org/elasticsearch/cluster/routing/IndexShardRoutingTable.java +++ b/core/src/main/java/org/elasticsearch/cluster/routing/IndexShardRoutingTable.java @@ -379,9 +379,6 @@ public class IndexShardRoutingTable implements Iterable<ShardRouting> { /** * Returns shards based on nodeAttributes given such as node name , node attribute, node IP * Supports node specifications in cluster API - * - * @param nodeAttribute - * @param discoveryNodes */ public ShardIterator onlyNodeSelectorActiveInitializingShardsIt(String nodeAttribute, DiscoveryNodes discoveryNodes) { ArrayList<ShardRouting> ordered = new ArrayList<>(activeShards.size() + allInitializingShards.size()); diff --git a/core/src/main/java/org/elasticsearch/cluster/routing/RoutingNodes.java b/core/src/main/java/org/elasticsearch/cluster/routing/RoutingNodes.java index 9c9cfaa27a..227d59f86c 100644 --- a/core/src/main/java/org/elasticsearch/cluster/routing/RoutingNodes.java +++ b/core/src/main/java/org/elasticsearch/cluster/routing/RoutingNodes.java @@ -424,7 +424,6 @@ public class RoutingNodes implements Iterable<RoutingNode> { /** * Cancels the give shard from the Routing nodes internal statistics and cancels * the relocation if the shard is relocating. - * @param shard */ private void remove(ShardRouting shard) { ensureMutable(); diff --git a/core/src/main/java/org/elasticsearch/cluster/routing/ShardRouting.java b/core/src/main/java/org/elasticsearch/cluster/routing/ShardRouting.java index 60764ab6d3..8ee8205ca6 100644 --- a/core/src/main/java/org/elasticsearch/cluster/routing/ShardRouting.java +++ b/core/src/main/java/org/elasticsearch/cluster/routing/ShardRouting.java @@ -528,7 +528,7 @@ public final class ShardRouting implements Streamable, ToXContent { /** * returns true if this routing has the same allocation ID as another. - * <p/> + * <p> * Note: if both shard routing has a null as their {@link #allocationId()}, this method returns false as the routing describe * no allocation at all.. **/ diff --git a/core/src/main/java/org/elasticsearch/cluster/routing/UnassignedInfo.java b/core/src/main/java/org/elasticsearch/cluster/routing/UnassignedInfo.java index e6dc7184cc..e329541538 100644 --- a/core/src/main/java/org/elasticsearch/cluster/routing/UnassignedInfo.java +++ b/core/src/main/java/org/elasticsearch/cluster/routing/UnassignedInfo.java @@ -47,7 +47,7 @@ public class UnassignedInfo implements ToXContent, Writeable<UnassignedInfo> { /** * Reason why the shard is in unassigned state. - * <p/> + * <p> * Note, ordering of the enum is important, make sure to add new values * at the end and handle version serialization properly. */ diff --git a/core/src/main/java/org/elasticsearch/cluster/routing/allocation/AllocationExplanation.java b/core/src/main/java/org/elasticsearch/cluster/routing/allocation/AllocationExplanation.java index 9949f1bd91..6811013082 100644 --- a/core/src/main/java/org/elasticsearch/cluster/routing/allocation/AllocationExplanation.java +++ b/core/src/main/java/org/elasticsearch/cluster/routing/allocation/AllocationExplanation.java @@ -52,7 +52,7 @@ public class AllocationExplanation implements Streamable { /** * Creates a new {@link NodeExplanation} * - * @param node node referenced by {@link This} {@link NodeExplanation} + * @param node node referenced by this {@link NodeExplanation} * @param description a message associated with the given node */ public NodeExplanation(DiscoveryNode node, String description) { diff --git a/core/src/main/java/org/elasticsearch/cluster/routing/allocation/AllocationService.java b/core/src/main/java/org/elasticsearch/cluster/routing/allocation/AllocationService.java index a907ef58b9..a3050f60e5 100644 --- a/core/src/main/java/org/elasticsearch/cluster/routing/allocation/AllocationService.java +++ b/core/src/main/java/org/elasticsearch/cluster/routing/allocation/AllocationService.java @@ -65,8 +65,8 @@ public class AllocationService extends AbstractComponent { /** * Applies the started shards. Note, shards can be called several times within this method. - * <p/> - * <p>If the same instance of the routing table is returned, then no change has been made.</p> + * <p> + * If the same instance of the routing table is returned, then no change has been made.</p> */ public RoutingAllocation.Result applyStartedShards(ClusterState clusterState, List<? extends ShardRouting> startedShards) { return applyStartedShards(clusterState, startedShards, true); @@ -94,8 +94,8 @@ public class AllocationService extends AbstractComponent { /** * Applies the failed shards. Note, shards can be called several times within this method. - * <p/> - * <p>If the same instance of the routing table is returned, then no change has been made.</p> + * <p> + * If the same instance of the routing table is returned, then no change has been made.</p> */ public RoutingAllocation.Result applyFailedShards(ClusterState clusterState, List<FailedRerouteAllocation.FailedShard> failedShards) { RoutingNodes routingNodes = getMutableRoutingNodes(clusterState); @@ -139,8 +139,8 @@ public class AllocationService extends AbstractComponent { /** * Reroutes the routing table based on the live nodes. - * <p/> - * <p>If the same instance of the routing table is returned, then no change has been made. + * <p> + * If the same instance of the routing table is returned, then no change has been made. */ public RoutingAllocation.Result reroute(ClusterState clusterState) { return reroute(clusterState, false); @@ -148,8 +148,8 @@ public class AllocationService extends AbstractComponent { /** * Reroutes the routing table based on the live nodes. - * <p/> - * <p>If the same instance of the routing table is returned, then no change has been made. + * <p> + * If the same instance of the routing table is returned, then no change has been made. */ public RoutingAllocation.Result reroute(ClusterState clusterState, boolean debug) { RoutingNodes routingNodes = getMutableRoutingNodes(clusterState); diff --git a/core/src/main/java/org/elasticsearch/cluster/routing/allocation/allocator/BalancedShardsAllocator.java b/core/src/main/java/org/elasticsearch/cluster/routing/allocation/allocator/BalancedShardsAllocator.java index 0cb2105597..b0ac16211a 100644 --- a/core/src/main/java/org/elasticsearch/cluster/routing/allocation/allocator/BalancedShardsAllocator.java +++ b/core/src/main/java/org/elasticsearch/cluster/routing/allocation/allocator/BalancedShardsAllocator.java @@ -49,7 +49,6 @@ import static org.elasticsearch.cluster.routing.ShardRoutingState.RELOCATING; * The {@link BalancedShardsAllocator} re-balances the nodes allocations * within an cluster based on a {@link WeightFunction}. The clusters balance is defined by four parameters which can be set * in the cluster update API that allows changes in real-time: - * <p/> * <ul><li><code>cluster.routing.allocation.balance.shard</code> - The <b>shard balance</b> defines the weight factor * for shards allocated on a {@link RoutingNode}</li> * <li><code>cluster.routing.allocation.balance.index</code> - The <b>index balance</b> defines a factor to the number @@ -57,7 +56,7 @@ import static org.elasticsearch.cluster.routing.ShardRoutingState.RELOCATING; * <li><code>cluster.routing.allocation.balance.threshold</code> - A <b>threshold</b> to set the minimal optimization * value of operations that should be performed</li> * </ul> - * <p/> + * <p> * These parameters are combined in a {@link WeightFunction} that allows calculation of node weights which * are used to re-balance shards based on global as well as per-index factors. */ diff --git a/core/src/main/java/org/elasticsearch/cluster/routing/allocation/command/CancelAllocationCommand.java b/core/src/main/java/org/elasticsearch/cluster/routing/allocation/command/CancelAllocationCommand.java index f4204fde26..d9ad8c4f87 100644 --- a/core/src/main/java/org/elasticsearch/cluster/routing/allocation/command/CancelAllocationCommand.java +++ b/core/src/main/java/org/elasticsearch/cluster/routing/allocation/command/CancelAllocationCommand.java @@ -126,7 +126,6 @@ public class CancelAllocationCommand implements AllocationCommand { * * @param shardId id of the shard which allocation should be canceled * @param node id of the node that manages the shard which allocation should be canceled - * @param allowPrimary */ public CancelAllocationCommand(ShardId shardId, String node, boolean allowPrimary) { this.shardId = shardId; diff --git a/core/src/main/java/org/elasticsearch/cluster/routing/allocation/command/MoveAllocationCommand.java b/core/src/main/java/org/elasticsearch/cluster/routing/allocation/command/MoveAllocationCommand.java index 614397aead..f54fce4ca6 100644 --- a/core/src/main/java/org/elasticsearch/cluster/routing/allocation/command/MoveAllocationCommand.java +++ b/core/src/main/java/org/elasticsearch/cluster/routing/allocation/command/MoveAllocationCommand.java @@ -37,7 +37,7 @@ import org.elasticsearch.index.shard.ShardId; import java.io.IOException; /** - * A command that moves a shard from a specific node to another node.<br /> + * A command that moves a shard from a specific node to another node.<br> * <b>Note:</b> The shard needs to be in the state * {@link ShardRoutingState#STARTED} in order to be moved. */ diff --git a/core/src/main/java/org/elasticsearch/cluster/routing/allocation/decider/AwarenessAllocationDecider.java b/core/src/main/java/org/elasticsearch/cluster/routing/allocation/decider/AwarenessAllocationDecider.java index 376b0d1028..54b6d403d2 100644 --- a/core/src/main/java/org/elasticsearch/cluster/routing/allocation/decider/AwarenessAllocationDecider.java +++ b/core/src/main/java/org/elasticsearch/cluster/routing/allocation/decider/AwarenessAllocationDecider.java @@ -39,40 +39,35 @@ import java.util.Map; * attributes like node or physical rack locations. Awareness attributes accept * arbitrary configuration keys like a rack data-center identifier. For example * the setting: - * <p/> * <pre> * cluster.routing.allocation.awareness.attributes: rack_id * </pre> - * <p/> + * <p> * will cause allocations to be distributed over different racks such that * ideally at least one replicas of the all shard is available on the same rack. * To enable allocation awareness in this example nodes should contain a value * for the <tt>rack_id</tt> key like: - * <p/> * <pre> * node.rack_id:1 * </pre> - * <p/> + * <p> * Awareness can also be used to prevent over-allocation in the case of node or * even "zone" failure. For example in cloud-computing infrastructures like * Amazone AWS a cluster might span over multiple "zones". Awareness can be used * to distribute replicas to individual zones by setting: - * <p/> * <pre> * cluster.routing.allocation.awareness.attributes: zone * </pre> - * <p/> + * <p> * and forcing allocation to be aware of the following zone the data resides in: - * <p/> * <pre> * cluster.routing.allocation.awareness.force.zone.values: zone1,zone2 * </pre> - * <p/> + * <p> * In contrast to regular awareness this setting will prevent over-allocation on * <tt>zone1</tt> even if <tt>zone2</tt> fails partially or becomes entirely * unavailable. Nodes that belong to a certain zone / group should be started * with the zone id configured on the node-level settings like: - * <p/> * <pre> * node.zone: zone1 * </pre> diff --git a/core/src/main/java/org/elasticsearch/cluster/routing/allocation/decider/ConcurrentRebalanceAllocationDecider.java b/core/src/main/java/org/elasticsearch/cluster/routing/allocation/decider/ConcurrentRebalanceAllocationDecider.java index d41beed564..f83aa56964 100644 --- a/core/src/main/java/org/elasticsearch/cluster/routing/allocation/decider/ConcurrentRebalanceAllocationDecider.java +++ b/core/src/main/java/org/elasticsearch/cluster/routing/allocation/decider/ConcurrentRebalanceAllocationDecider.java @@ -31,7 +31,7 @@ import org.elasticsearch.node.settings.NodeSettingsService; * re-balance (relocation) operations and restricts node allocations if the * configured threashold is reached. The default number of concurrent rebalance * operations is set to <tt>2</tt> - * <p/> + * <p> * Re-balance operations can be controlled in real-time via the cluster update API using * <tt>cluster.routing.allocation.cluster_concurrent_rebalance</tt>. Iff this * setting is set to <tt>-1</tt> the number of concurrent re-balance operations diff --git a/core/src/main/java/org/elasticsearch/cluster/routing/allocation/decider/EnableAllocationDecider.java b/core/src/main/java/org/elasticsearch/cluster/routing/allocation/decider/EnableAllocationDecider.java index de4bb4cbee..8fc6b4f109 100644 --- a/core/src/main/java/org/elasticsearch/cluster/routing/allocation/decider/EnableAllocationDecider.java +++ b/core/src/main/java/org/elasticsearch/cluster/routing/allocation/decider/EnableAllocationDecider.java @@ -41,7 +41,6 @@ import java.util.Locale; * <li> <code>PRIMARIES</code> - only primary shards are allowed to be allocated * <li> <code>ALL</code> - all shards are allowed to be allocated * </ul> - * </p> * * <p> * Rebalancing settings can have the following values (non-casesensitive): @@ -51,7 +50,6 @@ import java.util.Locale; * <li> <code>PRIMARIES</code> - only primary shards are allowed to be balanced * <li> <code>ALL</code> - all shards are allowed to be balanced * </ul> - * </p> * * @see Rebalance * @see Allocation diff --git a/core/src/main/java/org/elasticsearch/cluster/routing/allocation/decider/FilterAllocationDecider.java b/core/src/main/java/org/elasticsearch/cluster/routing/allocation/decider/FilterAllocationDecider.java index 138a08bdd2..e0e2caaf04 100644 --- a/core/src/main/java/org/elasticsearch/cluster/routing/allocation/decider/FilterAllocationDecider.java +++ b/core/src/main/java/org/elasticsearch/cluster/routing/allocation/decider/FilterAllocationDecider.java @@ -51,10 +51,8 @@ import static org.elasticsearch.cluster.node.DiscoveryNodeFilters.OpType.OR; * <ol> * <li><tt>required</tt> - filters required allocations. * If any <tt>required</tt> filters are set the allocation is denied if the index is <b>not</b> in the set of <tt>required</tt> to allocate on the filtered node</li> - * <p/> * <li><tt>include</tt> - filters "allowed" allocations. * If any <tt>include</tt> filters are set the allocation is denied if the index is <b>not</b> in the set of <tt>include</tt> filters for the filtered node</li> - * <p/> * <li><tt>exclude</tt> - filters "prohibited" allocations. * If any <tt>exclude</tt> filters are set the allocation is denied if the index is in the set of <tt>exclude</tt> filters for the filtered node</li> * </ol> diff --git a/core/src/main/java/org/elasticsearch/cluster/routing/allocation/decider/ThrottlingAllocationDecider.java b/core/src/main/java/org/elasticsearch/cluster/routing/allocation/decider/ThrottlingAllocationDecider.java index 59d6cd101c..ed6814d83a 100644 --- a/core/src/main/java/org/elasticsearch/cluster/routing/allocation/decider/ThrottlingAllocationDecider.java +++ b/core/src/main/java/org/elasticsearch/cluster/routing/allocation/decider/ThrottlingAllocationDecider.java @@ -31,17 +31,15 @@ import org.elasticsearch.node.settings.NodeSettingsService; * {@link ThrottlingAllocationDecider} controls the recovery process per node in * the cluster. It exposes two settings via the cluster update API that allow * changes in real-time: - * <p/> * <ul> * <li><tt>cluster.routing.allocation.node_initial_primaries_recoveries</tt> - * restricts the number of initial primary shard recovery operations on a single * node. The default is <tt>4</tt></li> - * <p/> * <li><tt>cluster.routing.allocation.node_concurrent_recoveries</tt> - * restricts the number of total concurrent shards initializing on a single node. The * default is <tt>2</tt></li> * </ul> - * <p/> + * <p> * If one of the above thresholds is exceeded per node this allocation decider * will return {@link Decision#THROTTLE} as a hit to upstream logic to throttle * the allocation process to prevent overloading nodes due to too many concurrent recovery diff --git a/core/src/main/java/org/elasticsearch/common/Base64.java b/core/src/main/java/org/elasticsearch/common/Base64.java index f14885892e..390b3708ff 100644 --- a/core/src/main/java/org/elasticsearch/common/Base64.java +++ b/core/src/main/java/org/elasticsearch/common/Base64.java @@ -24,37 +24,33 @@ import java.util.Locale; /** * <p>Encodes and decodes to and from Base64 notation.</p> * <p>Homepage: <a href="http://iharder.net/base64">http://iharder.net/base64</a>.</p> - * <p/> - * <p>Example:</p> - * <p/> + * <p> + * Example: + * <p> * <code>String encoded = Base64.encode( myByteArray );</code> - * <br /> + * <br> * <code>byte[] myByteArray = Base64.decode( encoded );</code> - * <p/> - * <p>The <tt>options</tt> parameter, which appears in a few places, is used to pass + * <p> + * The <tt>options</tt> parameter, which appears in a few places, is used to pass * several pieces of information to the encoder. In the "higher level" methods such as * encodeBytes( bytes, options ) the options parameter can be used to indicate such * things as first gzipping the bytes before encoding them, not inserting linefeeds, - * and encoding using the URL-safe and Ordered dialects.</p> - * <p/> - * <p>Note, according to <a href="http://www.faqs.org/rfcs/rfc3548.html">RFC3548</a>, + * and encoding using the URL-safe and Ordered dialects. + * <p> + * Note, according to <a href="http://www.faqs.org/rfcs/rfc3548.html">RFC3548</a>, * Section 2.1, implementations should not add line feeds unless explicitly told * to do so. I've got Base64 set to this behavior now, although earlier versions - * broke lines by default.</p> - * <p/> - * <p>The constants defined in Base64 can be OR-ed together to combine options, so you - * might make a call like this:</p> - * <p/> + * broke lines by default. + * <p> + * The constants defined in Base64 can be OR-ed together to combine options, so you + * might make a call like this: + * <p> * <code>String encoded = Base64.encodeBytes( mybytes, Base64.GZIP | Base64.DO_BREAK_LINES );</code> - * <p>to compress the data before encoding it and then making the output have newline characters.</p> - * <p>Also...</p> + * <p>to compress the data before encoding it and then making the output have newline characters. + * <p>Also... * <code>String encoded = Base64.encodeBytes( crazyString.getBytes() );</code> - * <p/> - * <p/> - * <p/> * <p> * Change Log: - * </p> * <ul> * <li>v2.3.7 - Fixed subtle bug when base 64 input stream contained the * value 01111111, which is an invalid base 64 character but should not @@ -65,14 +61,14 @@ import java.util.Locale; * <li>v2.3.6 - Fixed bug when breaking lines and the final byte of the encoded * string ended in the last column; the buffer was not properly shrunk and * contained an extra (null) byte that made it into the string.</li> - * <li>v2.3.5 - Fixed bug in {@link #encodeFromFile} where estimated buffer size + * <li>v2.3.5 - Fixed bug in {@code #encodeFromFile} where estimated buffer size * was wrong for files of size 31, 34, and 37 bytes.</li> * <li>v2.3.4 - Fixed bug when working with gzipped streams whereby flushing * the Base64.OutputStream closed the Base64 encoding (by padding with equals * signs) too soon. Also added an option to suppress the automatic decoding * of gzipped streams. Also added experimental support for specifying a * class loader when using the - * {@link #decodeToObject(java.lang.String, int, java.lang.ClassLoader)} + * {@code #decodeToObject(java.lang.String, int, java.lang.ClassLoader)} * method.</li> * <li>v2.3.3 - Changed default char encoding to US-ASCII which reduces the internal Java * footprint with its CharEncoders and so forth. Fixed some javadocs that were @@ -127,7 +123,6 @@ import java.util.Locale; * Special thanks to Jim Kellerman at <a href="http://www.powerset.com/">http://www.powerset.com/</a> * for contributing the new Base64 dialects. * </li> - * <p/> * <li>v2.1 - Cleaned up javadoc comments and unused variables and methods. Added * some convenience methods for reading and writing to and from files.</li> * <li>v2.0.2 - Now specifies UTF-8 encoding in places where the code fails on systems @@ -155,14 +150,12 @@ import java.util.Locale; * <li>v1.3.4 - Fixed when "improperly padded stream" error was thrown at the wrong time.</li> * <li>v1.3.3 - Fixed I/O streams which were totally messed up.</li> * </ul> - * <p/> * <p> * I am placing this code in the Public Domain. Do with it as you will. * This software comes with no guarantees or warranties but with * plenty of well-wishing instead! * Please visit <a href="http://iharder.net/base64">http://iharder.net/base64</a> * periodically to check for updates or to contribute improvements. - * </p> * * @author Robert Harder * @author rob@iharder.net @@ -669,8 +662,6 @@ public class Base64 { * Example: <code>encodeBytes( myData, Base64.GZIP )</code> or * <p> * Example: <code>encodeBytes( myData, Base64.GZIP | Base64.DO_BREAK_LINES )</code> - * <p/> - * <p/> * <p>As of v 2.3, if there is an error with the GZIP stream, * the method will throw an java.io.IOException. <b>This is new to v2.3!</b> * In earlier versions, it just returned a null value, but @@ -692,8 +683,8 @@ public class Base64 { /** * Encodes a byte array into Base64 notation. * Does not GZip-compress data. - * <p/> - * <p>As of v 2.3, if there is an error, + * <p> + * As of v 2.3, if there is an error, * the method will throw an java.io.IOException. <b>This is new to v2.3!</b> * In earlier versions, it just returned a null value, but * in retrospect that's a pretty poor way to handle it.</p> @@ -733,12 +724,11 @@ public class Base64 { * Example: <code>encodeBytes( myData, Base64.GZIP )</code> or * <p> * Example: <code>encodeBytes( myData, Base64.GZIP | Base64.DO_BREAK_LINES )</code> - * <p/> - * <p/> - * <p>As of v 2.3, if there is an error with the GZIP stream, + * <p> + * As of v 2.3, if there is an error with the GZIP stream, * the method will throw an java.io.IOException. <b>This is new to v2.3!</b> * In earlier versions, it just returned a null value, but - * in retrospect that's a pretty poor way to handle it.</p> + * in retrospect that's a pretty poor way to handle it. * * @param source The data to convert * @param off Offset in array where conversion should begin @@ -1263,13 +1253,13 @@ public class Base64 { /** * Constructs a {@link Base64.InputStream} in * either ENCODE or DECODE mode. - * <p/> + * <p> * Valid options:<pre> * ENCODE or DECODE: Encode or Decode as data is read. * DO_BREAK_LINES: break lines at 76 characters - * (only meaningful when encoding)</i> + * (only meaningful when encoding) * </pre> - * <p/> + * <p> * Example: <code>new Base64.InputStream( in, Base64.DECODE )</code> * * @param in the <tt>java.io.InputStream</tt> from which to read data. @@ -1470,13 +1460,13 @@ public class Base64 { /** * Constructs a {@link Base64.OutputStream} in * either ENCODE or DECODE mode. - * <p/> + * <p> * Valid options:<pre> * ENCODE or DECODE: Encode or Decode as data is read. * DO_BREAK_LINES: don't break lines at 76 characters - * (only meaningful when encoding)</i> + * (only meaningful when encoding) * </pre> - * <p/> + * <p> * Example: <code>new Base64.OutputStream( out, Base64.ENCODE )</code> * * @param out the <tt>java.io.OutputStream</tt> to which data will be written. diff --git a/core/src/main/java/org/elasticsearch/common/Booleans.java b/core/src/main/java/org/elasticsearch/common/Booleans.java index 94adaeef65..6b1b9b016a 100644 --- a/core/src/main/java/org/elasticsearch/common/Booleans.java +++ b/core/src/main/java/org/elasticsearch/common/Booleans.java @@ -80,7 +80,6 @@ public class Booleans { /*** * - * @param value * @return true/false * throws exception if string cannot be parsed to boolean */ diff --git a/core/src/main/java/org/elasticsearch/common/StopWatch.java b/core/src/main/java/org/elasticsearch/common/StopWatch.java index cc18e9332b..f842dde68c 100644 --- a/core/src/main/java/org/elasticsearch/common/StopWatch.java +++ b/core/src/main/java/org/elasticsearch/common/StopWatch.java @@ -30,14 +30,14 @@ import java.util.concurrent.TimeUnit; /** * Simple stop watch, allowing for timing of a number of tasks, * exposing total running time and running time for each named task. - * <p/> - * <p>Conceals use of <code>System.nanoTime()</code>, improving the + * <p> + * Conceals use of <code>System.nanoTime()</code>, improving the * readability of application code and reducing the likelihood of calculation errors. - * <p/> - * <p>Note that this object is not designed to be thread-safe and does not + * <p> + * Note that this object is not designed to be thread-safe and does not * use synchronization. - * <p/> - * <p>This class is normally used to verify performance during proof-of-concepts + * <p> + * This class is normally used to verify performance during proof-of-concepts * and in development, rather than as part of production applications. * * diff --git a/core/src/main/java/org/elasticsearch/common/Strings.java b/core/src/main/java/org/elasticsearch/common/Strings.java index 40d9602e2c..08777696bc 100644 --- a/core/src/main/java/org/elasticsearch/common/Strings.java +++ b/core/src/main/java/org/elasticsearch/common/Strings.java @@ -64,10 +64,10 @@ public class Strings { /** * Splits a backslash escaped string on the separator. - * <p/> + * <p> * Current backslash escaping supported: * <br> \n \t \r \b \f are escaped the same as a Java String - * <br> Other characters following a backslash are produced verbatim (\c => c) + * <br> Other characters following a backslash are produced verbatim (\c => c) * * @param s the string to split * @param separator the separator to split on @@ -131,7 +131,7 @@ public class Strings { /** * Check that the given CharSequence is neither <code>null</code> nor of length 0. * Note: Will return <code>true</code> for a CharSequence that purely consists of whitespace. - * <p><pre> + * <pre> * StringUtils.hasLength(null) = false * StringUtils.hasLength("") = false * StringUtils.hasLength(" ") = true @@ -174,7 +174,7 @@ public class Strings { /** * Check that the given CharSequence is either <code>null</code> or of length 0. * Note: Will return <code>false</code> for a CharSequence that purely consists of whitespace. - * <p><pre> + * <pre> * StringUtils.isEmpty(null) = true * StringUtils.isEmpty("") = true * StringUtils.isEmpty(" ") = false @@ -193,7 +193,7 @@ public class Strings { * Check whether the given CharSequence has actual text. * More specifically, returns <code>true</code> if the string not <code>null</code>, * its length is greater than 0, and it contains at least one non-whitespace character. - * <p><pre> + * <pre> * StringUtils.hasText(null) = false * StringUtils.hasText("") = false * StringUtils.hasText(" ") = false @@ -400,7 +400,7 @@ public class Strings { * * @param str the input String (e.g. "myString") * @return the quoted String (e.g. "'myString'"), - * or <code>null<code> if the input was <code>null</code> + * or <code>null</code> if the input was <code>null</code> */ public static String quote(String str) { return (str != null ? "'" + str + "'" : null); diff --git a/core/src/main/java/org/elasticsearch/common/blobstore/support/AbstractLegacyBlobContainer.java b/core/src/main/java/org/elasticsearch/common/blobstore/support/AbstractLegacyBlobContainer.java index 9df7f26ad0..b95a7f28c5 100644 --- a/core/src/main/java/org/elasticsearch/common/blobstore/support/AbstractLegacyBlobContainer.java +++ b/core/src/main/java/org/elasticsearch/common/blobstore/support/AbstractLegacyBlobContainer.java @@ -41,7 +41,7 @@ public abstract class AbstractLegacyBlobContainer extends AbstractBlobContainer /** * Creates a new {@link InputStream} for the given blob name - * <p/> + * <p> * This method is deprecated and is used only for compatibility with older blob containers * The new blob containers should use readBlob/writeBlob methods instead */ @@ -50,7 +50,7 @@ public abstract class AbstractLegacyBlobContainer extends AbstractBlobContainer /** * Creates a new OutputStream for the given blob name - * <p/> + * <p> * This method is deprecated and is used only for compatibility with older blob containers * The new blob containers should override readBlob/writeBlob methods instead */ diff --git a/core/src/main/java/org/elasticsearch/common/blobstore/url/URLBlobStore.java b/core/src/main/java/org/elasticsearch/common/blobstore/url/URLBlobStore.java index f330ce8244..813a12571e 100644 --- a/core/src/main/java/org/elasticsearch/common/blobstore/url/URLBlobStore.java +++ b/core/src/main/java/org/elasticsearch/common/blobstore/url/URLBlobStore.java @@ -42,7 +42,7 @@ public class URLBlobStore extends AbstractComponent implements BlobStore { /** * Constructs new read-only URL-based blob store - * <p/> + * <p> * The following settings are supported * <dl> * <dt>buffer_size</dt> @@ -98,8 +98,6 @@ public class URLBlobStore extends AbstractComponent implements BlobStore { /** * This operation is not supported by URL Blob Store - * - * @param path */ @Override public void delete(BlobPath path) { @@ -119,7 +117,6 @@ public class URLBlobStore extends AbstractComponent implements BlobStore { * * @param path relative path * @return Base URL + path - * @throws MalformedURLException */ private URL buildPath(BlobPath path) throws MalformedURLException { String[] paths = path.toArray(); diff --git a/core/src/main/java/org/elasticsearch/common/breaker/ChildMemoryCircuitBreaker.java b/core/src/main/java/org/elasticsearch/common/breaker/ChildMemoryCircuitBreaker.java index d87c31629d..9284b7b50a 100644 --- a/core/src/main/java/org/elasticsearch/common/breaker/ChildMemoryCircuitBreaker.java +++ b/core/src/main/java/org/elasticsearch/common/breaker/ChildMemoryCircuitBreaker.java @@ -102,10 +102,9 @@ public class ChildMemoryCircuitBreaker implements CircuitBreaker { * Add a number of bytes, tripping the circuit breaker if the aggregated * estimates are above the limit. Automatically trips the breaker if the * memory limit is set to 0. Will never trip the breaker if the limit is - * set < 0, but can still be used to aggregate estimations. + * set < 0, but can still be used to aggregate estimations. * @param bytes number of bytes to add to the breaker * @return number of "used" bytes so far - * @throws CircuitBreakingException */ @Override public double addEstimateBytesAndMaybeBreak(long bytes, String label) throws CircuitBreakingException { diff --git a/core/src/main/java/org/elasticsearch/common/breaker/CircuitBreaker.java b/core/src/main/java/org/elasticsearch/common/breaker/CircuitBreaker.java index afd8efdb8b..7811ff35d5 100644 --- a/core/src/main/java/org/elasticsearch/common/breaker/CircuitBreaker.java +++ b/core/src/main/java/org/elasticsearch/common/breaker/CircuitBreaker.java @@ -66,7 +66,6 @@ public interface CircuitBreaker { * @param bytes number of bytes to add * @param label string label describing the bytes being added * @return the number of "used" bytes for the circuit breaker - * @throws CircuitBreakingException */ public double addEstimateBytesAndMaybeBreak(long bytes, String label) throws CircuitBreakingException; diff --git a/core/src/main/java/org/elasticsearch/common/breaker/MemoryCircuitBreaker.java b/core/src/main/java/org/elasticsearch/common/breaker/MemoryCircuitBreaker.java index d08d618e47..b069456b5d 100644 --- a/core/src/main/java/org/elasticsearch/common/breaker/MemoryCircuitBreaker.java +++ b/core/src/main/java/org/elasticsearch/common/breaker/MemoryCircuitBreaker.java @@ -75,7 +75,6 @@ public class MemoryCircuitBreaker implements CircuitBreaker { /** * Method used to trip the breaker - * @throws CircuitBreakingException */ @Override public void circuitBreak(String fieldName, long bytesNeeded) throws CircuitBreakingException { @@ -90,10 +89,9 @@ public class MemoryCircuitBreaker implements CircuitBreaker { * Add a number of bytes, tripping the circuit breaker if the aggregated * estimates are above the limit. Automatically trips the breaker if the * memory limit is set to 0. Will never trip the breaker if the limit is - * set < 0, but can still be used to aggregate estimations. + * set < 0, but can still be used to aggregate estimations. * @param bytes number of bytes to add to the breaker * @return number of "used" bytes so far - * @throws CircuitBreakingException */ @Override public double addEstimateBytesAndMaybeBreak(long bytes, String label) throws CircuitBreakingException { diff --git a/core/src/main/java/org/elasticsearch/common/collect/ImmutableOpenIntMap.java b/core/src/main/java/org/elasticsearch/common/collect/ImmutableOpenIntMap.java index ccadbcf0a4..b807d48a97 100644 --- a/core/src/main/java/org/elasticsearch/common/collect/ImmutableOpenIntMap.java +++ b/core/src/main/java/org/elasticsearch/common/collect/ImmutableOpenIntMap.java @@ -32,7 +32,7 @@ import java.util.Map; /** * An immutable map implementation based on open hash map. - * <p/> + * <p> * Can be constructed using a {@link #builder()}, or using {@link #builder(org.elasticsearch.common.collect.ImmutableOpenIntMap)} (which is an optimized * option to copy over existing content and modify it). */ @@ -47,7 +47,7 @@ public final class ImmutableOpenIntMap<VType> implements Iterable<IntObjectCurso /** * @return Returns the value associated with the given key or the default value * for the key type, if the key is not associated with any value. - * <p/> + * <p> * <b>Important note:</b> For primitive type values, the value returned for a non-existing * key may not be the default value of the primitive type (it may be any value previously * assigned to that slot). @@ -91,8 +91,8 @@ public final class ImmutableOpenIntMap<VType> implements Iterable<IntObjectCurso * + " value=" + c.value); * } * </pre> - * <p/> - * <p>The <code>index</code> field inside the cursor gives the internal index inside + * <p> + * The <code>index</code> field inside the cursor gives the internal index inside * the container's implementation. The interpretation of this index depends on * to the container. */ diff --git a/core/src/main/java/org/elasticsearch/common/collect/ImmutableOpenMap.java b/core/src/main/java/org/elasticsearch/common/collect/ImmutableOpenMap.java index 814df937e0..47c1bdfb82 100644 --- a/core/src/main/java/org/elasticsearch/common/collect/ImmutableOpenMap.java +++ b/core/src/main/java/org/elasticsearch/common/collect/ImmutableOpenMap.java @@ -31,7 +31,7 @@ import java.util.Map; /** * An immutable map implementation based on open hash map. - * <p/> + * <p> * Can be constructed using a {@link #builder()}, or using {@link #builder(ImmutableOpenMap)} (which is an optimized * option to copy over existing content and modify it). */ @@ -46,7 +46,7 @@ public final class ImmutableOpenMap<KType, VType> implements Iterable<ObjectObje /** * @return Returns the value associated with the given key or the default value * for the key type, if the key is not associated with any value. - * <p/> + * <p> * <b>Important note:</b> For primitive type values, the value returned for a non-existing * key may not be the default value of the primitive type (it may be any value previously * assigned to that slot). @@ -98,8 +98,8 @@ public final class ImmutableOpenMap<KType, VType> implements Iterable<ObjectObje * + " value=" + c.value); * } * </pre> - * <p/> - * <p>The <code>index</code> field inside the cursor gives the internal index inside + * <p> + * The <code>index</code> field inside the cursor gives the internal index inside * the container's implementation. The interpretation of this index depends on * to the container. */ diff --git a/core/src/main/java/org/elasticsearch/common/component/Lifecycle.java b/core/src/main/java/org/elasticsearch/common/component/Lifecycle.java index e6cbf264af..7afccb3c5a 100644 --- a/core/src/main/java/org/elasticsearch/common/component/Lifecycle.java +++ b/core/src/main/java/org/elasticsearch/common/component/Lifecycle.java @@ -23,15 +23,14 @@ package org.elasticsearch.common.component; /** * Lifecycle state. Allows the following transitions: * <ul> - * <li>INITIALIZED -> STARTED, STOPPED, CLOSED</li> - * <li>STARTED -> STOPPED</li> - * <li>STOPPED -> STARTED, CLOSED</li> - * <li>CLOSED -> </li> + * <li>INITIALIZED -> STARTED, STOPPED, CLOSED</li> + * <li>STARTED -> STOPPED</li> + * <li>STOPPED -> STARTED, CLOSED</li> + * <li>CLOSED -> </li> * </ul> - * <p/> - * <p>Also allows to stay in the same state. For example, when calling stop on a component, the + * <p> + * Also allows to stay in the same state. For example, when calling stop on a component, the * following logic can be applied: - * <p/> * <pre> * public void stop() { * if (!lifeccycleState.moveToStopped()) { @@ -40,10 +39,9 @@ package org.elasticsearch.common.component; * // continue with stop logic * } * </pre> - * <p/> - * <p>Note, closed is only allowed to be called when stopped, so make sure to stop the component first. + * <p> + * Note, closed is only allowed to be called when stopped, so make sure to stop the component first. * Here is how the logic can be applied: - * <p/> * <pre> * public void close() { * if (lifecycleState.started()) { diff --git a/core/src/main/java/org/elasticsearch/common/compress/CompressorFactory.java b/core/src/main/java/org/elasticsearch/common/compress/CompressorFactory.java index 72c57a97a0..4af2e962d8 100644 --- a/core/src/main/java/org/elasticsearch/common/compress/CompressorFactory.java +++ b/core/src/main/java/org/elasticsearch/common/compress/CompressorFactory.java @@ -112,7 +112,7 @@ public class CompressorFactory { } /** - * Uncompress the provided data, data can be detected as compressed using {@link #isCompressed(byte[], int, int)}. + * Uncompress the provided data, data can be detected as compressed using {@link #isCompressed(BytesReference)}. */ public static BytesReference uncompressIfNeeded(BytesReference bytes) throws IOException { Compressor compressor = compressor(bytes); diff --git a/core/src/main/java/org/elasticsearch/common/geo/GeoUtils.java b/core/src/main/java/org/elasticsearch/common/geo/GeoUtils.java index 5c14659832..be06d4bd0e 100644 --- a/core/src/main/java/org/elasticsearch/common/geo/GeoUtils.java +++ b/core/src/main/java/org/elasticsearch/common/geo/GeoUtils.java @@ -207,7 +207,7 @@ public class GeoUtils { /** * Normalize latitude to lie within the -90 to 90 (both inclusive) range. - * <p/> + * <p> * Note: You should not normalize longitude and latitude separately, * because when normalizing latitude it may be necessary to * add a shift of 180° in the longitude. @@ -231,7 +231,7 @@ public class GeoUtils { /** * Normalize the geo {@code Point} for its coordinates to lie within their * respective normalized ranges. - * <p/> + * <p> * Note: A shift of 180° is applied in the longitude if necessary, * in order to normalize properly the latitude. * @@ -244,9 +244,9 @@ public class GeoUtils { /** * Normalize the geo {@code Point} for the given coordinates to lie within * their respective normalized ranges. - * <p/> + * <p> * You can control which coordinate gets normalized with the two flags. - * <p/> + * <p> * Note: A shift of 180° is applied in the longitude if necessary, * in order to normalize properly the latitude. * If normalizing latitude but not longitude, it is assumed that @@ -308,9 +308,6 @@ public class GeoUtils { * * @param parser {@link XContentParser} to parse the value from * @return new {@link GeoPoint} parsed from the parse - * - * @throws IOException - * @throws org.elasticsearch.ElasticsearchParseException */ public static GeoPoint parseGeoPoint(XContentParser parser) throws IOException, ElasticsearchParseException { return parseGeoPoint(parser, new GeoPoint()); @@ -329,9 +326,6 @@ public class GeoUtils { * @param parser {@link XContentParser} to parse the value from * @param point A {@link GeoPoint} that will be reset by the values parsed * @return new {@link GeoPoint} parsed from the parse - * - * @throws IOException - * @throws org.elasticsearch.ElasticsearchParseException */ public static GeoPoint parseGeoPoint(XContentParser parser, GeoPoint point) throws IOException, ElasticsearchParseException { double lat = Double.NaN; diff --git a/core/src/main/java/org/elasticsearch/common/geo/XShapeCollection.java b/core/src/main/java/org/elasticsearch/common/geo/XShapeCollection.java index 2cc4a097ed..695db015ed 100644 --- a/core/src/main/java/org/elasticsearch/common/geo/XShapeCollection.java +++ b/core/src/main/java/org/elasticsearch/common/geo/XShapeCollection.java @@ -61,7 +61,7 @@ public class XShapeCollection<S extends Shape> extends ShapeCollection<S> { /** * Spatial4J shapes have no knowledge of directed edges. For this reason, a bounding box - * that wraps the dateline can have a min longitude that is mathematically > than the + * that wraps the dateline can have a min longitude that is mathematically > than the * Rectangles' minX value. This is an issue for geometric collections (e.g., MultiPolygon * and ShapeCollection) Until geometry logic can be cleaned up in Spatial4J, ES provides * the following expansion algorithm for GeometryCollections diff --git a/core/src/main/java/org/elasticsearch/common/geo/builders/CircleBuilder.java b/core/src/main/java/org/elasticsearch/common/geo/builders/CircleBuilder.java index 27d7318c21..f1054e1866 100644 --- a/core/src/main/java/org/elasticsearch/common/geo/builders/CircleBuilder.java +++ b/core/src/main/java/org/elasticsearch/common/geo/builders/CircleBuilder.java @@ -68,7 +68,7 @@ public class CircleBuilder extends ShapeBuilder { /** * Set the radius of the circle - * @param radius radius of the circle (see {@link DistanceUnit.Distance}) + * @param radius radius of the circle (see {@link org.elasticsearch.common.unit.DistanceUnit.Distance}) * @return this */ public CircleBuilder radius(Distance radius) { diff --git a/core/src/main/java/org/elasticsearch/common/geo/builders/PointCollection.java b/core/src/main/java/org/elasticsearch/common/geo/builders/PointCollection.java index 8174efacfc..de1db188b3 100644 --- a/core/src/main/java/org/elasticsearch/common/geo/builders/PointCollection.java +++ b/core/src/main/java/org/elasticsearch/common/geo/builders/PointCollection.java @@ -110,7 +110,6 @@ public abstract class PointCollection<E extends PointCollection<E>> extends Shap * @param builder builder to use * @param closed repeat the first point at the end of the array if it's not already defines as last element of the array * @return the builder - * @throws IOException */ protected XContentBuilder coordinatesToXcontent(XContentBuilder builder, boolean closed) throws IOException { builder.startArray(); diff --git a/core/src/main/java/org/elasticsearch/common/geo/builders/ShapeBuilder.java b/core/src/main/java/org/elasticsearch/common/geo/builders/ShapeBuilder.java index e33d63a40a..0c1a12de39 100644 --- a/core/src/main/java/org/elasticsearch/common/geo/builders/ShapeBuilder.java +++ b/core/src/main/java/org/elasticsearch/common/geo/builders/ShapeBuilder.java @@ -270,7 +270,7 @@ public abstract class ShapeBuilder implements ToXContent { * Create a new {@link ShapeBuilder} from {@link XContent} * @param parser parser to read the GeoShape from * @return {@link ShapeBuilder} read from the parser or null - * if the parsers current token has been <code><null</code> + * if the parsers current token has been <code>null</code> * @throws IOException if the input could not be read */ public static ShapeBuilder parse(XContentParser parser) throws IOException { @@ -284,7 +284,7 @@ public abstract class ShapeBuilder implements ToXContent { * to the shape construction process (e.g., orientation) * todo: refactor to place build specific parameters in the SpatialContext * @return {@link ShapeBuilder} read from the parser or null - * if the parsers current token has been <code><null</code> + * if the parsers current token has been <code>null</code> * @throws IOException if the input could not be read */ public static ShapeBuilder parse(XContentParser parser, GeoShapeFieldMapper geoDocMapper) throws IOException { @@ -385,7 +385,7 @@ public abstract class ShapeBuilder implements ToXContent { /** * Node used to represent a tree of coordinates. - * <p/> + * <p> * Can either be a leaf node consisting of a Coordinate, or a parent with * children */ @@ -606,7 +606,6 @@ public abstract class ShapeBuilder implements ToXContent { /** * Transforms coordinates in the eastern hemisphere (-180:0) to a (180:360) range - * @param points */ protected static void translate(Coordinate[] points) { for (Coordinate c : points) { @@ -714,7 +713,6 @@ public abstract class ShapeBuilder implements ToXContent { * @param parser - parse utility object including source document * @param shapeMapper - field mapper needed for index specific parameters * @return ShapeBuilder - a builder instance used to create the geometry - * @throws IOException */ public static ShapeBuilder parse(XContentParser parser, GeoShapeFieldMapper shapeMapper) throws IOException { if (parser.currentToken() == XContentParser.Token.VALUE_NULL) { diff --git a/core/src/main/java/org/elasticsearch/common/http/client/HttpDownloadHelper.java b/core/src/main/java/org/elasticsearch/common/http/client/HttpDownloadHelper.java index b21935ee71..ed2de6e5e7 100644 --- a/core/src/main/java/org/elasticsearch/common/http/client/HttpDownloadHelper.java +++ b/core/src/main/java/org/elasticsearch/common/http/client/HttpDownloadHelper.java @@ -452,8 +452,8 @@ public class HttpDownloadHelper { /** * Has the download completed successfully? - * <p/> - * <p>Re-throws any exception caught during executaion.</p> + * <p> + * Re-throws any exception caught during executaion.</p> */ boolean wasSuccessful() throws IOException { if (ioexception != null) { diff --git a/core/src/main/java/org/elasticsearch/common/inject/AbstractModule.java b/core/src/main/java/org/elasticsearch/common/inject/AbstractModule.java index 86ef15875b..7c0a5ce268 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/AbstractModule.java +++ b/core/src/main/java/org/elasticsearch/common/inject/AbstractModule.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -32,7 +32,6 @@ import java.util.Objects; * a more readable configuration. Simply extend this class, implement {@link * #configure()}, and call the inherited methods which mirror those found in * {@link Binder}. For example: - * <p/> * <pre> * public class MyModule extends AbstractModule { * protected void configure() { diff --git a/core/src/main/java/org/elasticsearch/common/inject/AbstractProcessor.java b/core/src/main/java/org/elasticsearch/common/inject/AbstractProcessor.java index 1fdc3775b0..154ce88b24 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/AbstractProcessor.java +++ b/core/src/main/java/org/elasticsearch/common/inject/AbstractProcessor.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -24,8 +24,8 @@ import java.util.List; /** * Abstract base class for creating an injector from module elements. - * <p/> - * <p>Extending classes must return {@code true} from any overridden + * <p> + * Extending classes must return {@code true} from any overridden * {@code visit*()} methods, in order for the element processor to remove the * handled element. * diff --git a/core/src/main/java/org/elasticsearch/common/inject/Binder.java b/core/src/main/java/org/elasticsearch/common/inject/Binder.java index 93155131e9..437591b8c5 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/Binder.java +++ b/core/src/main/java/org/elasticsearch/common/inject/Binder.java @@ -31,9 +31,8 @@ import java.lang.annotation.Annotation; * used to create an {@link Injector}. Guice provides this object to your * application's {@link Module} implementors so they may each contribute * their own bindings and other registrations. - * <p/> * <h3>The Guice Binding EDSL</h3> - * <p/> + * <p> * Guice uses an <i>embedded domain-specific language</i>, or EDSL, to help you * create bindings simply and readably. This approach is great for overall * usability, but it does come with a small cost: <b>it is difficult to @@ -42,7 +41,6 @@ import java.lang.annotation.Annotation; * examples below. To save space, these examples omit the opening * {@code binder}, just as you will if your module extends * {@link AbstractModule}. - * <p/> * <pre> * bind(ServiceImpl.class);</pre> * @@ -112,7 +110,7 @@ import java.lang.annotation.Annotation; * contribute their own custom scopes for use here as well. * * <pre> - * bind(new TypeLiteral<PaymentService<CreditCard>>() {}) + * bind(new TypeLiteral<PaymentService<CreditCard>>() {}) * .to(CreditCardPaymentService.class);</pre> * * This admittedly odd construct is the way to bind a parameterized type. It @@ -141,7 +139,7 @@ import java.lang.annotation.Annotation; * * Sets up a constant binding. Constant injections must always be annotated. * When a constant binding's value is a string, it is eligile for conversion to - * all primitive types, to {@link Enum#valueOf(Class, String) all enums}, and to + * all primitive types, to {@link Enum#valueOf all enums}, and to * {@link Class#forName class literals}. Conversions for other types can be * configured using {@link #convertToTypes(Matcher, TypeConverter) * convertToTypes()}. @@ -178,7 +176,7 @@ import java.lang.annotation.Annotation; * the problems at runtime, as soon as you try to create your Injector. * * <p>The other methods of Binder such as {@link #bindScope}, - * {@link #bindInterceptor}, {@link #install}, {@link #requestStaticInjection}, + * {@link #install}, {@link #requestStaticInjection}, * {@link #addError} and {@link #currentStage} are not part of the Binding EDSL; * you can learn how to use these in the usual way, from the method * documentation. diff --git a/core/src/main/java/org/elasticsearch/common/inject/Binding.java b/core/src/main/java/org/elasticsearch/common/inject/Binding.java index b854d1df31..e0d0420fb0 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/Binding.java +++ b/core/src/main/java/org/elasticsearch/common/inject/Binding.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -24,8 +24,8 @@ import org.elasticsearch.common.inject.spi.Element; * A mapping from a key (type and optional annotation) to the strategy for getting instances of the * type. This interface is part of the introspection API and is intended primarily for use by * tools. - * <p/> - * <p>Bindings are created in several ways: + * <p> + * Bindings are created in several ways: * <ul> * <li>Explicitly in a module, via {@code bind()} and {@code bindConstant()} * statements: diff --git a/core/src/main/java/org/elasticsearch/common/inject/BindingAnnotation.java b/core/src/main/java/org/elasticsearch/common/inject/BindingAnnotation.java index 816c306b23..3d18b573ca 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/BindingAnnotation.java +++ b/core/src/main/java/org/elasticsearch/common/inject/BindingAnnotation.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -26,7 +26,6 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME; * Annotates annotations which are used for binding. Only one such annotation * may apply to a single injection point. You must also annotate binder * annotations with {@code @Retention(RUNTIME)}. For example: - * <p/> * <pre> * {@code @}Retention(RUNTIME) * {@code @}Target({ FIELD, PARAMETER, METHOD }) diff --git a/core/src/main/java/org/elasticsearch/common/inject/BindingProcessor.java b/core/src/main/java/org/elasticsearch/common/inject/BindingProcessor.java index 58ea0be016..0ef8c26a69 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/BindingProcessor.java +++ b/core/src/main/java/org/elasticsearch/common/inject/BindingProcessor.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/BoundProviderFactory.java b/core/src/main/java/org/elasticsearch/common/inject/BoundProviderFactory.java index b1a0fcea45..57676f42c1 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/BoundProviderFactory.java +++ b/core/src/main/java/org/elasticsearch/common/inject/BoundProviderFactory.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/ConfigurationException.java b/core/src/main/java/org/elasticsearch/common/inject/ConfigurationException.java index 4afc653062..3aaed0d27a 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/ConfigurationException.java +++ b/core/src/main/java/org/elasticsearch/common/inject/ConfigurationException.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/ConstantFactory.java b/core/src/main/java/org/elasticsearch/common/inject/ConstantFactory.java index e451d04409..d2fb6ae412 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/ConstantFactory.java +++ b/core/src/main/java/org/elasticsearch/common/inject/ConstantFactory.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/ConstructionProxy.java b/core/src/main/java/org/elasticsearch/common/inject/ConstructionProxy.java index d88e84d1ac..391d9c8c56 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/ConstructionProxy.java +++ b/core/src/main/java/org/elasticsearch/common/inject/ConstructionProxy.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/ConstructionProxyFactory.java b/core/src/main/java/org/elasticsearch/common/inject/ConstructionProxyFactory.java index 081e43d6ad..9a0cd367e1 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/ConstructionProxyFactory.java +++ b/core/src/main/java/org/elasticsearch/common/inject/ConstructionProxyFactory.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/ConstructorInjector.java b/core/src/main/java/org/elasticsearch/common/inject/ConstructorInjector.java index f732a0d36b..c8792afef5 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/ConstructorInjector.java +++ b/core/src/main/java/org/elasticsearch/common/inject/ConstructorInjector.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/ConstructorInjectorStore.java b/core/src/main/java/org/elasticsearch/common/inject/ConstructorInjectorStore.java index cca1f7e7b1..ce63da62d8 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/ConstructorInjectorStore.java +++ b/core/src/main/java/org/elasticsearch/common/inject/ConstructorInjectorStore.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2009 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/ContextualCallable.java b/core/src/main/java/org/elasticsearch/common/inject/ContextualCallable.java index 19ddf4f3fb..b6d09e7e28 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/ContextualCallable.java +++ b/core/src/main/java/org/elasticsearch/common/inject/ContextualCallable.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/CreationException.java b/core/src/main/java/org/elasticsearch/common/inject/CreationException.java index 5c44111e60..4900efe6a3 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/CreationException.java +++ b/core/src/main/java/org/elasticsearch/common/inject/CreationException.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/DefaultConstructionProxyFactory.java b/core/src/main/java/org/elasticsearch/common/inject/DefaultConstructionProxyFactory.java index 437ad03545..b57f92e795 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/DefaultConstructionProxyFactory.java +++ b/core/src/main/java/org/elasticsearch/common/inject/DefaultConstructionProxyFactory.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/DeferredLookups.java b/core/src/main/java/org/elasticsearch/common/inject/DeferredLookups.java index c6ca9bab08..40d589f37d 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/DeferredLookups.java +++ b/core/src/main/java/org/elasticsearch/common/inject/DeferredLookups.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2009 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/EncounterImpl.java b/core/src/main/java/org/elasticsearch/common/inject/EncounterImpl.java index fc2bd484b4..8b8b7b7821 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/EncounterImpl.java +++ b/core/src/main/java/org/elasticsearch/common/inject/EncounterImpl.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2009 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/Exposed.java b/core/src/main/java/org/elasticsearch/common/inject/Exposed.java index 992da18d7c..8e0598a8be 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/Exposed.java +++ b/core/src/main/java/org/elasticsearch/common/inject/Exposed.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/ExposedKeyFactory.java b/core/src/main/java/org/elasticsearch/common/inject/ExposedKeyFactory.java index 34f75474b8..0e001080fb 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/ExposedKeyFactory.java +++ b/core/src/main/java/org/elasticsearch/common/inject/ExposedKeyFactory.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/FactoryProxy.java b/core/src/main/java/org/elasticsearch/common/inject/FactoryProxy.java index a7f88f6a6d..b275ea67a8 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/FactoryProxy.java +++ b/core/src/main/java/org/elasticsearch/common/inject/FactoryProxy.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/Guice.java b/core/src/main/java/org/elasticsearch/common/inject/Guice.java index 7b303e5d68..128664c65a 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/Guice.java +++ b/core/src/main/java/org/elasticsearch/common/inject/Guice.java @@ -21,8 +21,8 @@ import java.util.Arrays; /** * The entry point to the Guice framework. Creates {@link Injector}s from * {@link Module}s. - * <p/> - * <p>Guice supports a model of development that draws clear boundaries between + * <p> + * Guice supports a model of development that draws clear boundaries between * APIs, Implementations of these APIs, Modules which configure these * implementations, and finally Applications which consist of a collection of * Modules. It is the Application, which typically defines your {@code main()} diff --git a/core/src/main/java/org/elasticsearch/common/inject/ImplementedBy.java b/core/src/main/java/org/elasticsearch/common/inject/ImplementedBy.java index 52e3509a28..652be0f3ed 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/ImplementedBy.java +++ b/core/src/main/java/org/elasticsearch/common/inject/ImplementedBy.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/InheritingState.java b/core/src/main/java/org/elasticsearch/common/inject/InheritingState.java index d70f47a760..12c317b1b0 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/InheritingState.java +++ b/core/src/main/java/org/elasticsearch/common/inject/InheritingState.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/Initializable.java b/core/src/main/java/org/elasticsearch/common/inject/Initializable.java index 01a48e7e3b..26c3da5d3f 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/Initializable.java +++ b/core/src/main/java/org/elasticsearch/common/inject/Initializable.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/Initializables.java b/core/src/main/java/org/elasticsearch/common/inject/Initializables.java index e1148bbe1f..5704892070 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/Initializables.java +++ b/core/src/main/java/org/elasticsearch/common/inject/Initializables.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/Initializer.java b/core/src/main/java/org/elasticsearch/common/inject/Initializer.java index f1288c57c0..1d68f163bf 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/Initializer.java +++ b/core/src/main/java/org/elasticsearch/common/inject/Initializer.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/Inject.java b/core/src/main/java/org/elasticsearch/common/inject/Inject.java index c118c4db94..ff67b645f2 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/Inject.java +++ b/core/src/main/java/org/elasticsearch/common/inject/Inject.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -27,23 +27,20 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME; * Annotates members of your implementation class (constructors, methods * and fields) into which the {@link Injector} should inject values. * The Injector fulfills injection requests for: - * <p/> * <ul> * <li>Every instance it constructs. The class being constructed must have * exactly one of its constructors marked with {@code @Inject} or must have a * constructor taking no parameters. The Injector then proceeds to perform * method and field injections. - * <p/> * <li>Pre-constructed instances passed to {@link Injector#injectMembers}, * {@link org.elasticsearch.common.inject.binder.LinkedBindingBuilder#toInstance(Object)} and * {@link org.elasticsearch.common.inject.binder.LinkedBindingBuilder#toProvider(Provider)}. * In this case all constructors are, of course, ignored. - * <p/> * <li>Static fields and methods of classes which any {@link Module} has * specifically requested static injection for, using * {@link Binder#requestStaticInjection}. * </ul> - * <p/> + * <p> * In all cases, a member can be injected regardless of its Java access * specifier (private, default, protected, public). * diff --git a/core/src/main/java/org/elasticsearch/common/inject/InjectionRequestProcessor.java b/core/src/main/java/org/elasticsearch/common/inject/InjectionRequestProcessor.java index da87efa1b8..e8b38b5133 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/InjectionRequestProcessor.java +++ b/core/src/main/java/org/elasticsearch/common/inject/InjectionRequestProcessor.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/Injector.java b/core/src/main/java/org/elasticsearch/common/inject/Injector.java index d7ee0e832e..bfc1fb42db 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/Injector.java +++ b/core/src/main/java/org/elasticsearch/common/inject/Injector.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -24,26 +24,25 @@ import java.util.Map; * for each type and uses bindings to inject them. This is the core of Guice, although you rarely * interact with it directly. This "behind-the-scenes" operation is what distinguishes dependency * injection from its cousin, the service locator pattern. - * <p/> - * <p>Contains several default bindings: - * <p/> + * <p> + * Contains several default bindings: * <ul> * <li>This {@link Injector} instance itself * <li>A {@code Provider<T>} for each binding of type {@code T} * <li>The {@link java.util.logging.Logger} for the class being injected * <li>The {@link Stage} in which the Injector was created * </ul> - * <p/> + * <p> * Injectors are created using the facade class {@link Guice}. - * <p/> - * <p>An injector can also {@link #injectMembers(Object) inject the dependencies} of + * <p> + * An injector can also {@link #injectMembers(Object) inject the dependencies} of * already-constructed instances. This can be used to interoperate with objects created by other * frameworks or services. - * <p/> - * <p>Injectors can be {@link #createChildInjector(Iterable) hierarchical}. Child injectors inherit + * <p> + * Injectors can be {@link #createChildInjector(Iterable) hierarchical}. Child injectors inherit * the configuration of their parent injectors, but the converse does not hold. - * <p/> - * <p>The injector's {@link #getBindings() internal bindings} are available for introspection. This + * <p> + * The injector's {@link #getBindings() internal bindings} are available for introspection. This * enables tools and extensions to operate on an injector reflectively. * * @author crazybob@google.com (Bob Lee) @@ -54,8 +53,8 @@ public interface Injector { /** * Injects dependencies into the fields and methods of {@code instance}. Ignores the presence or * absence of an injectable constructor. - * <p/> - * <p>Whenever Guice creates an instance, it performs this injection automatically (after first + * <p> + * Whenever Guice creates an instance, it performs this injection automatically (after first * performing constructor injection), so if you're able to let Guice create all your objects for * you, you'll never need to use this method. * @@ -90,13 +89,13 @@ public interface Injector { /** * Returns all explicit bindings. - * <p/> - * <p>The returned map does not include bindings inherited from a {@link #getParent() parent + * <p> + * The returned map does not include bindings inherited from a {@link #getParent() parent * injector}, should one exist. The returned map is guaranteed to iterate (for example, with * its {@link java.util.Map#entrySet()} iterator) in the order of insertion. In other words, * the order in which bindings appear in user Modules. - * <p/> - * <p>This method is part of the Guice SPI and is intended for use by tools and extensions. + * <p> + * This method is part of the Guice SPI and is intended for use by tools and extensions. */ Map<Key<?>, Binding<?>> getBindings(); @@ -104,8 +103,8 @@ public interface Injector { * Returns the binding for the given injection key. This will be an explicit bindings if the key * was bound explicitly by a module, or an implicit binding otherwise. The implicit binding will * be created if necessary. - * <p/> - * <p>This method is part of the Guice SPI and is intended for use by tools and extensions. + * <p> + * This method is part of the Guice SPI and is intended for use by tools and extensions. * * @throws ConfigurationException if this injector cannot find or create the binding. */ @@ -115,8 +114,8 @@ public interface Injector { * Returns the binding for the given type. This will be an explicit bindings if the injection key * was bound explicitly by a module, or an implicit binding otherwise. The implicit binding will * be created if necessary. - * <p/> - * <p>This method is part of the Guice SPI and is intended for use by tools and extensions. + * <p> + * This method is part of the Guice SPI and is intended for use by tools and extensions. * * @throws ConfigurationException if this injector cannot find or create the binding. * @since 2.0 @@ -125,8 +124,8 @@ public interface Injector { /** * Returns all explicit bindings for {@code type}. - * <p/> - * <p>This method is part of the Guice SPI and is intended for use by tools and extensions. + * <p> + * This method is part of the Guice SPI and is intended for use by tools and extensions. */ <T> List<Binding<T>> findBindingsByType(TypeLiteral<T> type); @@ -179,12 +178,12 @@ public interface Injector { * Returns a new injector that inherits all state from this injector. All bindings, scopes, * interceptors and type converters are inherited -- they are visible to the child injector. * Elements of the child injector are not visible to its parent. - * <p/> - * <p>Just-in-time bindings created for child injectors will be created in an ancestor injector + * <p> + * Just-in-time bindings created for child injectors will be created in an ancestor injector * whenever possible. This allows for scoped instances to be shared between injectors. Use * explicit bindings to prevent bindings from being shared with the parent injector. - * <p/> - * <p>No key may be bound by both an injector and one of its ancestors. This includes just-in-time + * <p> + * No key may be bound by both an injector and one of its ancestors. This includes just-in-time * bindings. The lone exception is the key for {@code Injector.class}, which is bound by each * injector to itself. * @@ -196,12 +195,12 @@ public interface Injector { * Returns a new injector that inherits all state from this injector. All bindings, scopes, * interceptors and type converters are inherited -- they are visible to the child injector. * Elements of the child injector are not visible to its parent. - * <p/> - * <p>Just-in-time bindings created for child injectors will be created in an ancestor injector + * <p> + * Just-in-time bindings created for child injectors will be created in an ancestor injector * whenever possible. This allows for scoped instances to be shared between injectors. Use * explicit bindings to prevent bindings from being shared with the parent injector. - * <p/> - * <p>No key may be bound by both an injector and one of its ancestors. This includes just-in-time + * <p> + * No key may be bound by both an injector and one of its ancestors. This includes just-in-time * bindings. The lone exception is the key for {@code Injector.class}, which is bound by each * injector to itself. * diff --git a/core/src/main/java/org/elasticsearch/common/inject/InjectorBuilder.java b/core/src/main/java/org/elasticsearch/common/inject/InjectorBuilder.java index 5f7175dcfe..4a9ba4ae3f 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/InjectorBuilder.java +++ b/core/src/main/java/org/elasticsearch/common/inject/InjectorBuilder.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -30,8 +30,8 @@ import java.util.Set; * Builds a tree of injectors. This is a primary injector, plus child injectors needed for each * {@link Binder#newPrivateBinder() private environment}. The primary injector is not necessarily a * top-level injector. - * <p/> - * <p>Injector construction happens in two phases. + * <p> + * Injector construction happens in two phases. * <ol> * <li>Static building. In this phase, we interpret commands, create bindings, and inspect * dependencies. During this phase, we hold a lock to ensure consistency with parent injectors. diff --git a/core/src/main/java/org/elasticsearch/common/inject/InjectorImpl.java b/core/src/main/java/org/elasticsearch/common/inject/InjectorImpl.java index 7aef2e7bb3..15fb181b56 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/InjectorImpl.java +++ b/core/src/main/java/org/elasticsearch/common/inject/InjectorImpl.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/InjectorShell.java b/core/src/main/java/org/elasticsearch/common/inject/InjectorShell.java index 8acc7d7c72..aeb3f2e5e6 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/InjectorShell.java +++ b/core/src/main/java/org/elasticsearch/common/inject/InjectorShell.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/Injectors.java b/core/src/main/java/org/elasticsearch/common/inject/Injectors.java index 40a0ae1aba..900d2588b5 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/Injectors.java +++ b/core/src/main/java/org/elasticsearch/common/inject/Injectors.java @@ -50,10 +50,10 @@ public class Injectors { /** * Returns an instance of the given type with the {@link org.elasticsearch.common.inject.name.Named} * annotation value. - * <p/> + * <p> * This method allows you to switch this code * <code>injector.getInstance(Key.get(type, Names.named(name)));</code> - * <p/> + * <p> * to the more concise * <code>Injectors.getInstance(injector, type, name);</code> */ diff --git a/core/src/main/java/org/elasticsearch/common/inject/InternalFactoryToProviderAdapter.java b/core/src/main/java/org/elasticsearch/common/inject/InternalFactoryToProviderAdapter.java index d748cec6ad..8cffd7e63b 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/InternalFactoryToProviderAdapter.java +++ b/core/src/main/java/org/elasticsearch/common/inject/InternalFactoryToProviderAdapter.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/Key.java b/core/src/main/java/org/elasticsearch/common/inject/Key.java index 92925c69b4..3af3b4e1a8 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/Key.java +++ b/core/src/main/java/org/elasticsearch/common/inject/Key.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -27,21 +27,20 @@ import java.util.Objects; /** * Binding key consisting of an injection type and an optional annotation. * Matches the type and annotation at a point of injection. - * <p/> - * <p>For example, {@code Key.get(Service.class, Transactional.class)} will + * <p> + * For example, {@code Key.get(Service.class, Transactional.class)} will * match: - * <p/> * <pre> * {@literal @}Inject * public void setService({@literal @}Transactional Service service) { * ... * } * </pre> - * <p/> - * <p>{@code Key} supports generic types via subclassing just like {@link + * <p> + * {@code Key} supports generic types via subclassing just like {@link * TypeLiteral}. - * <p/> - * <p>Keys do not differentiate between primitive types (int, char, etc.) and + * <p> + * Keys do not differentiate between primitive types (int, char, etc.) and * their correpsonding wrapper types (Integer, Character, etc.). Primitive * types will be replaced with their wrapper types when keys are created. * @@ -56,15 +55,15 @@ public class Key<T> { /** * Constructs a new key. Derives the type from this class's type parameter. - * <p/> - * <p>Clients create an empty anonymous subclass. Doing so embeds the type + * <p> + * Clients create an empty anonymous subclass. Doing so embeds the type * parameter in the anonymous class's type hierarchy so we can reconstitute it * at runtime despite erasure. - * <p/> - * <p>Example usage for a binding of type {@code Foo} annotated with + * <p> + * Example usage for a binding of type {@code Foo} annotated with * {@code @Bar}: - * <p/> - * <p>{@code new Key<Foo>(Bar.class) {}}. + * <p> + * {@code new Key<Foo>(Bar.class) {}}. */ @SuppressWarnings("unchecked") protected Key(Class<? extends Annotation> annotationType) { @@ -75,15 +74,15 @@ public class Key<T> { /** * Constructs a new key. Derives the type from this class's type parameter. - * <p/> - * <p>Clients create an empty anonymous subclass. Doing so embeds the type + * <p> + * Clients create an empty anonymous subclass. Doing so embeds the type * parameter in the anonymous class's type hierarchy so we can reconstitute it * at runtime despite erasure. - * <p/> - * <p>Example usage for a binding of type {@code Foo} annotated with + * <p> + * Example usage for a binding of type {@code Foo} annotated with * {@code @Bar}: - * <p/> - * <p>{@code new Key<Foo>(new Bar()) {}}. + * <p> + * {@code new Key<Foo>(new Bar()) {}}. */ @SuppressWarnings("unchecked") protected Key(Annotation annotation) { @@ -95,14 +94,14 @@ public class Key<T> { /** * Constructs a new key. Derives the type from this class's type parameter. - * <p/> - * <p>Clients create an empty anonymous subclass. Doing so embeds the type + * <p> + * Clients create an empty anonymous subclass. Doing so embeds the type * parameter in the anonymous class's type hierarchy so we can reconstitute it * at runtime despite erasure. - * <p/> - * <p>Example usage for a binding of type {@code Foo}: - * <p/> - * <p>{@code new Key<Foo>() {}}. + * <p> + * Example usage for a binding of type {@code Foo}: + * <p> + * {@code new Key<Foo>() {}}. */ @SuppressWarnings("unchecked") protected Key() { diff --git a/core/src/main/java/org/elasticsearch/common/inject/LookupProcessor.java b/core/src/main/java/org/elasticsearch/common/inject/LookupProcessor.java index 0bcfaa27c5..9e85fb0f36 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/LookupProcessor.java +++ b/core/src/main/java/org/elasticsearch/common/inject/LookupProcessor.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/Lookups.java b/core/src/main/java/org/elasticsearch/common/inject/Lookups.java index b5eb690320..915698374a 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/Lookups.java +++ b/core/src/main/java/org/elasticsearch/common/inject/Lookups.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2009 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/MembersInjector.java b/core/src/main/java/org/elasticsearch/common/inject/MembersInjector.java index 3893bf197c..0a4464a373 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/MembersInjector.java +++ b/core/src/main/java/org/elasticsearch/common/inject/MembersInjector.java @@ -30,8 +30,8 @@ public interface MembersInjector<T> { /** * Injects dependencies into the fields and methods of {@code instance}. Ignores the presence or * absence of an injectable constructor. - * <p/> - * <p>Whenever Guice creates an instance, it performs this injection automatically (after first + * <p> + * Whenever Guice creates an instance, it performs this injection automatically (after first * performing constructor injection), so if you're able to let Guice create all your objects for * you, you'll never need to use this method. * diff --git a/core/src/main/java/org/elasticsearch/common/inject/MembersInjectorImpl.java b/core/src/main/java/org/elasticsearch/common/inject/MembersInjectorImpl.java index 399a231461..420897172f 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/MembersInjectorImpl.java +++ b/core/src/main/java/org/elasticsearch/common/inject/MembersInjectorImpl.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2009 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/MembersInjectorStore.java b/core/src/main/java/org/elasticsearch/common/inject/MembersInjectorStore.java index d8ee0d7796..7b6f256bd4 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/MembersInjectorStore.java +++ b/core/src/main/java/org/elasticsearch/common/inject/MembersInjectorStore.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2009 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/MessageProcessor.java b/core/src/main/java/org/elasticsearch/common/inject/MessageProcessor.java index 2acba6865c..5bb1e5e8ee 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/MessageProcessor.java +++ b/core/src/main/java/org/elasticsearch/common/inject/MessageProcessor.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/Module.java b/core/src/main/java/org/elasticsearch/common/inject/Module.java index 9af716d928..f3a43d80f3 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/Module.java +++ b/core/src/main/java/org/elasticsearch/common/inject/Module.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -21,11 +21,11 @@ package org.elasticsearch.common.inject; * bindings, which will be used to create an {@link Injector}. A Guice-based * application is ultimately composed of little more than a set of * {@code Module}s and some bootstrapping code. - * <p/> - * <p>Your Module classes can use a more streamlined syntax by extending + * <p> + * Your Module classes can use a more streamlined syntax by extending * {@link AbstractModule} rather than implementing this interface directly. - * <p/> - * <p>In addition to the bindings configured via {@link #configure}, bindings + * <p> + * In addition to the bindings configured via {@link #configure}, bindings * will be created for all methods annotated with {@literal @}{@link Provides}. * Use scope and binding annotations on these methods to configure the * bindings. @@ -34,8 +34,8 @@ public interface Module { /** * Contributes bindings and other configurations for this module to {@code binder}. - * <p/> - * <p><strong>Do not invoke this method directly</strong> to install submodules. Instead use + * <p> + * <strong>Do not invoke this method directly</strong> to install submodules. Instead use * {@link Binder#install(Module)}, which ensures that {@link Provides provider methods} are * discovered. */ diff --git a/core/src/main/java/org/elasticsearch/common/inject/OutOfScopeException.java b/core/src/main/java/org/elasticsearch/common/inject/OutOfScopeException.java index 14096a3e4c..353fe7ca05 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/OutOfScopeException.java +++ b/core/src/main/java/org/elasticsearch/common/inject/OutOfScopeException.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2007 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/PrivateBinder.java b/core/src/main/java/org/elasticsearch/common/inject/PrivateBinder.java index f6a429372d..cc5e356aee 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/PrivateBinder.java +++ b/core/src/main/java/org/elasticsearch/common/inject/PrivateBinder.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/PrivateElementProcessor.java b/core/src/main/java/org/elasticsearch/common/inject/PrivateElementProcessor.java index 2b7dc69299..855529149d 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/PrivateElementProcessor.java +++ b/core/src/main/java/org/elasticsearch/common/inject/PrivateElementProcessor.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/PrivateModule.java b/core/src/main/java/org/elasticsearch/common/inject/PrivateModule.java index a69ba75e0d..4413028f90 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/PrivateModule.java +++ b/core/src/main/java/org/elasticsearch/common/inject/PrivateModule.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -31,17 +31,16 @@ import java.lang.annotation.Annotation; * A module whose configuration information is hidden from its environment by default. Only bindings * that are explicitly exposed will be available to other modules and to the users of the injector. * This module may expose the bindings it creates and the bindings of the modules it installs. - * <p/> - * <p>A private module can be nested within a regular module or within another private module using + * <p> + * A private module can be nested within a regular module or within another private module using * {@link Binder#install install()}. Its bindings live in a new environment that inherits bindings, * type converters, scopes, and interceptors from the surrounding ("parent") environment. When you * nest multiple private modules, the result is a tree of environments where the injector's * environment is the root. - * <p/> - * <p>Guice EDSL bindings can be exposed with {@link #expose(Class) expose()}. {@literal @}{@link + * <p> + * Guice EDSL bindings can be exposed with {@link #expose(Class) expose()}. {@literal @}{@link * org.elasticsearch.common.inject.Provides Provides} bindings can be exposed with the {@literal @}{@link * Exposed} annotation: - * <p/> * <pre> * public class FooBarBazModule extends PrivateModule { * protected void configure() { @@ -61,20 +60,20 @@ import java.lang.annotation.Annotation; * } * } * </pre> - * <p/> - * <p>Private modules are implemented using {@link Injector#createChildInjector(Module[]) parent + * <p> + * Private modules are implemented using {@link Injector#createChildInjector(Module[]) parent * injectors}. When it can satisfy their dependencies, just-in-time bindings will be created in the * root environment. Such bindings are shared among all environments in the tree. - * <p/> - * <p>The scope of a binding is constrained to its environment. A singleton bound in a private + * <p> + * The scope of a binding is constrained to its environment. A singleton bound in a private * module will be unique to its environment. But a binding for the same type in a different private * module will yield a different instance. - * <p/> - * <p>A shared binding that injects the {@code Injector} gets the root injector, which only has + * <p> + * A shared binding that injects the {@code Injector} gets the root injector, which only has * access to bindings in the root environment. An explicit binding that injects the {@code Injector} * gets access to all bindings in the child environment. - * <p/> - * <p>To promote a just-in-time binding to an explicit binding, bind it: + * <p> + * To promote a just-in-time binding to an explicit binding, bind it: * <pre> * bind(FooImpl.class); * </pre> diff --git a/core/src/main/java/org/elasticsearch/common/inject/ProvidedBy.java b/core/src/main/java/org/elasticsearch/common/inject/ProvidedBy.java index 6232dd7055..945de83cf9 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/ProvidedBy.java +++ b/core/src/main/java/org/elasticsearch/common/inject/ProvidedBy.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/Provider.java b/core/src/main/java/org/elasticsearch/common/inject/Provider.java index f9f446670d..610062debe 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/Provider.java +++ b/core/src/main/java/org/elasticsearch/common/inject/Provider.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -19,21 +19,17 @@ package org.elasticsearch.common.inject; /** * An object capable of providing instances of type {@code T}. Providers are used in numerous ways * by Guice: - * <p/> * <ul> * <li>When the default means for obtaining instances (an injectable or parameterless constructor) * is insufficient for a particular binding, the module can specify a custom {@code Provider} * instead, to control exactly how Guice creates or obtains instances for the binding. - * <p/> * <li>An implementation class may always choose to have a {@code Provider<T>} instance injected, * rather than having a {@code T} injected directly. This may give you access to multiple * instances, instances you wish to safely mutate and discard, instances which are out of scope * (e.g. using a {@code @RequestScoped} object from within a {@code @SessionScoped} object), or * instances that will be initialized lazily. - * <p/> * <li>A custom {@link Scope} is implemented as a decorator of {@code Provider<T>}, which decides * when to delegate to the backing provider and when to provide the instance some other way. - * <p/> * <li>The {@link Injector} offers access to the {@code Provider<T>} it uses to fulfill requests * for a given key, via the {@link Injector#getProvider} methods. * </ul> diff --git a/core/src/main/java/org/elasticsearch/common/inject/ProviderToInternalFactoryAdapter.java b/core/src/main/java/org/elasticsearch/common/inject/ProviderToInternalFactoryAdapter.java index ceb016baed..d7b6afbe6d 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/ProviderToInternalFactoryAdapter.java +++ b/core/src/main/java/org/elasticsearch/common/inject/ProviderToInternalFactoryAdapter.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/Provides.java b/core/src/main/java/org/elasticsearch/common/inject/Provides.java index 0920b85424..587005f883 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/Provides.java +++ b/core/src/main/java/org/elasticsearch/common/inject/Provides.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2007 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/ProvisionException.java b/core/src/main/java/org/elasticsearch/common/inject/ProvisionException.java index 9497169d17..6fc7c30c7d 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/ProvisionException.java +++ b/core/src/main/java/org/elasticsearch/common/inject/ProvisionException.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/Reflection.java b/core/src/main/java/org/elasticsearch/common/inject/Reflection.java index ba34e6a7a9..22c542bb9e 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/Reflection.java +++ b/core/src/main/java/org/elasticsearch/common/inject/Reflection.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/Scope.java b/core/src/main/java/org/elasticsearch/common/inject/Scope.java index ccaa4c8c8b..dacb105fa3 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/Scope.java +++ b/core/src/main/java/org/elasticsearch/common/inject/Scope.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -24,8 +24,8 @@ package org.elasticsearch.common.inject; * and then immediately forgets it. Associating a scope with a particular * binding allows the created instance to be "remembered" and possibly used * again for other injections. - * <p/> - * <p>An example of a scope is {@link Scopes#SINGLETON}. + * <p> + * An example of a scope is {@link Scopes#SINGLETON}. * * @author crazybob@google.com (Bob Lee) */ @@ -35,8 +35,8 @@ public interface Scope { * Scopes a provider. The returned provider returns objects from this scope. * If an object does not exist in this scope, the provider can use the given * unscoped provider to retrieve one. - * <p/> - * <p>Scope implementations are strongly encouraged to override + * <p> + * Scope implementations are strongly encouraged to override * {@link Object#toString} in the returned provider and include the backing * provider's {@code toString()} output. * diff --git a/core/src/main/java/org/elasticsearch/common/inject/ScopeAnnotation.java b/core/src/main/java/org/elasticsearch/common/inject/ScopeAnnotation.java index 7c6ab299c8..ea1dd376b2 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/ScopeAnnotation.java +++ b/core/src/main/java/org/elasticsearch/common/inject/ScopeAnnotation.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -26,7 +26,6 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME; * Annotates annotations which are used for scoping. Only one such annotation * may apply to a single implementation class. You must also annotate scope * annotations with {@code @Retention(RUNTIME)}. For example: - * <p/> * <pre> * {@code @}Retention(RUNTIME) * {@code @}Target(TYPE) diff --git a/core/src/main/java/org/elasticsearch/common/inject/ScopeBindingProcessor.java b/core/src/main/java/org/elasticsearch/common/inject/ScopeBindingProcessor.java index 187db3b9b8..9705867350 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/ScopeBindingProcessor.java +++ b/core/src/main/java/org/elasticsearch/common/inject/ScopeBindingProcessor.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/Scopes.java b/core/src/main/java/org/elasticsearch/common/inject/Scopes.java index babc4bd65c..f94460d7ca 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/Scopes.java +++ b/core/src/main/java/org/elasticsearch/common/inject/Scopes.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -81,8 +81,8 @@ public class Scopes { * Injector obtains an instance of an object with "no scope", it injects this * instance then immediately forgets it. When the next request for the same * binding arrives it will need to obtain the instance over again. - * <p/> - * <p>This exists only in case a class has been annotated with a scope + * <p> + * This exists only in case a class has been annotated with a scope * annotation such as {@link Singleton @Singleton}, and you need to override * this to "no scope" in your binding. * diff --git a/core/src/main/java/org/elasticsearch/common/inject/SingleFieldInjector.java b/core/src/main/java/org/elasticsearch/common/inject/SingleFieldInjector.java index a1375de789..10ba17d86c 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/SingleFieldInjector.java +++ b/core/src/main/java/org/elasticsearch/common/inject/SingleFieldInjector.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/SingleMemberInjector.java b/core/src/main/java/org/elasticsearch/common/inject/SingleMemberInjector.java index 791a4f8ca4..cca00751cd 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/SingleMemberInjector.java +++ b/core/src/main/java/org/elasticsearch/common/inject/SingleMemberInjector.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/SingleMethodInjector.java b/core/src/main/java/org/elasticsearch/common/inject/SingleMethodInjector.java index 65f7b0692a..9c40779116 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/SingleMethodInjector.java +++ b/core/src/main/java/org/elasticsearch/common/inject/SingleMethodInjector.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/SingleParameterInjector.java b/core/src/main/java/org/elasticsearch/common/inject/SingleParameterInjector.java index 372b4837f0..b9570e1b81 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/SingleParameterInjector.java +++ b/core/src/main/java/org/elasticsearch/common/inject/SingleParameterInjector.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/Singleton.java b/core/src/main/java/org/elasticsearch/common/inject/Singleton.java index eeca5e0185..68b05448e5 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/Singleton.java +++ b/core/src/main/java/org/elasticsearch/common/inject/Singleton.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/Stage.java b/core/src/main/java/org/elasticsearch/common/inject/Stage.java index f6969a2069..5533cae4c4 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/Stage.java +++ b/core/src/main/java/org/elasticsearch/common/inject/Stage.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/State.java b/core/src/main/java/org/elasticsearch/common/inject/State.java index 53d1bddd31..0388bb04a6 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/State.java +++ b/core/src/main/java/org/elasticsearch/common/inject/State.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/TypeConverterBindingProcessor.java b/core/src/main/java/org/elasticsearch/common/inject/TypeConverterBindingProcessor.java index ba711e401c..485fab738a 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/TypeConverterBindingProcessor.java +++ b/core/src/main/java/org/elasticsearch/common/inject/TypeConverterBindingProcessor.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/TypeListenerBindingProcessor.java b/core/src/main/java/org/elasticsearch/common/inject/TypeListenerBindingProcessor.java index 4139fc04f2..533576ddf5 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/TypeListenerBindingProcessor.java +++ b/core/src/main/java/org/elasticsearch/common/inject/TypeListenerBindingProcessor.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2009 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/TypeLiteral.java b/core/src/main/java/org/elasticsearch/common/inject/TypeLiteral.java index ee50b129dc..81ee9cbbe6 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/TypeLiteral.java +++ b/core/src/main/java/org/elasticsearch/common/inject/TypeLiteral.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -31,28 +31,27 @@ import static org.elasticsearch.common.inject.internal.MoreTypes.canonicalize; * represent generic types, so this class does. Forces clients to create a * subclass of this class which enables retrieval the type information even at * runtime. - * <p/> - * <p>For example, to create a type literal for {@code List<String>}, you can + * <p> + * For example, to create a type literal for {@code List<String>}, you can * create an empty anonymous inner class: - * <p/> - * <p/> + * <p> * {@code TypeLiteral<List<String>> list = new TypeLiteral<List<String>>() {};} - * <p/> - * <p>This syntax cannot be used to create type literals that have wildcard + * <p> + * This syntax cannot be used to create type literals that have wildcard * parameters, such as {@code Class<?>} or {@code List<? extends CharSequence>}. * Such type literals must be constructed programatically, either by {@link * Method#getGenericReturnType extracting types from members} or by using the * {@link Types} factory class. - * <p/> - * <p>Along with modeling generic types, this class can resolve type parameters. + * <p> + * Along with modeling generic types, this class can resolve type parameters. * For example, to figure out what type {@code keySet()} returns on a {@code - * Map<Integer, String>}, use this code:<pre> {@code - * <p/> + * Map<Integer, String>}, use this code:{@code + * <p> * TypeLiteral<Map<Integer, String>> mapType * = new TypeLiteral<Map<Integer, String>>() {}; * TypeLiteral<?> keySetType * = mapType.getReturnType(Map.class.getMethod("keySet")); - * System.out.println(keySetType); // prints "Set<Integer>"}</pre> + * System.out.println(keySetType); // prints "Set<Integer>"} * * @author crazybob@google.com (Bob Lee) * @author jessewilson@google.com (Jesse Wilson) @@ -66,8 +65,8 @@ public class TypeLiteral<T> { /** * Constructs a new type literal. Derives represented class from type * parameter. - * <p/> - * <p>Clients create an empty anonymous subclass. Doing so embeds the type + * <p> + * Clients create an empty anonymous subclass. Doing so embeds the type * parameter in the anonymous class's type hierarchy so we can reconstitute it * at runtime despite erasure. */ diff --git a/core/src/main/java/org/elasticsearch/common/inject/WeakKeySet.java b/core/src/main/java/org/elasticsearch/common/inject/WeakKeySet.java index f13ff34727..6e49e01a41 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/WeakKeySet.java +++ b/core/src/main/java/org/elasticsearch/common/inject/WeakKeySet.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -28,8 +28,8 @@ final class WeakKeySet { /** * We store strings rather than keys so we don't hold strong references. - * <p/> - * <p>One potential problem with this approach is that parent and child injectors cannot define + * <p> + * One potential problem with this approach is that parent and child injectors cannot define * keys whose class names are equal but class loaders are different. This shouldn't be an issue * in practice. */ diff --git a/core/src/main/java/org/elasticsearch/common/inject/assistedinject/Assisted.java b/core/src/main/java/org/elasticsearch/common/inject/assistedinject/Assisted.java index 7dba708ef0..32b1d60bc1 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/assistedinject/Assisted.java +++ b/core/src/main/java/org/elasticsearch/common/inject/assistedinject/Assisted.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2007 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -40,4 +40,4 @@ public @interface Assisted { * parameter with the same value. Names are not necessary when the parameter types are distinct. */ String value() default ""; -}
\ No newline at end of file +} diff --git a/core/src/main/java/org/elasticsearch/common/inject/assistedinject/AssistedConstructor.java b/core/src/main/java/org/elasticsearch/common/inject/assistedinject/AssistedConstructor.java index e3410bf97b..edceb3f906 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/assistedinject/AssistedConstructor.java +++ b/core/src/main/java/org/elasticsearch/common/inject/assistedinject/AssistedConstructor.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2007 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/assistedinject/AssistedInject.java b/core/src/main/java/org/elasticsearch/common/inject/assistedinject/AssistedInject.java index cbba8be237..ce661d27cd 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/assistedinject/AssistedInject.java +++ b/core/src/main/java/org/elasticsearch/common/inject/assistedinject/AssistedInject.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2007 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -26,8 +26,8 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME; * <p>Constructors annotated with {@code @AssistedInject} indicate that they can be instantiated by * the {@link FactoryProvider}. Each constructor must exactly match one corresponding factory method * within the factory interface. - * <p/> - * <p>Constructor parameters must be either supplied by the factory interface and marked with + * <p> + * Constructor parameters must be either supplied by the factory interface and marked with * <code>@Assisted</code>, or they must be injectable. * * @author jmourits@google.com (Jerome Mourits) diff --git a/core/src/main/java/org/elasticsearch/common/inject/assistedinject/FactoryProvider.java b/core/src/main/java/org/elasticsearch/common/inject/assistedinject/FactoryProvider.java index d66037b24a..78aeb56fdc 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/assistedinject/FactoryProvider.java +++ b/core/src/main/java/org/elasticsearch/common/inject/assistedinject/FactoryProvider.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2007 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -44,7 +44,6 @@ import java.util.Set; /** * Provides a factory that combines the caller's arguments with injector-supplied values to * construct objects. - * <p/> * <h3>Defining a factory</h3> * Create an interface whose methods return the constructed type, or any of its supertypes. The * method's parameters are the arguments required to build the constructed type. @@ -53,7 +52,6 @@ import java.util.Set; * }</pre> * You can name your factory methods whatever you like, such as <i>create</i>, <i>createPayment</i> * or <i>newPayment</i>. - * <p/> * <h3>Creating a type that accepts factory parameters</h3> * {@code constructedType} is a concrete class with an {@literal @}{@link Inject}-annotated * constructor. In addition to injector-supplied parameters, the constructor should have @@ -71,7 +69,6 @@ import java.util.Set; * } * }</pre> * Any parameter that permits a null value should also be annotated {@code @Nullable}. - * <p/> * <h3>Configuring factories</h3> * In your {@link org.elasticsearch.common.inject.Module module}, bind the factory interface to the returned * factory: @@ -79,24 +76,20 @@ import java.util.Set; * FactoryProvider.newFactory(PaymentFactory.class, RealPayment.class));</pre> * As a side-effect of this binding, Guice will inject the factory to initialize it for use. The * factory cannot be used until the injector has been initialized. - * <p/> * <h3>Using the factory</h3> * Inject your factory into your application classes. When you use the factory, your arguments * will be combined with values from the injector to construct an instance. * <pre>public class PaymentAction { * {@literal @}Inject private PaymentFactory paymentFactory; - * <p/> * public void doPayment(Money amount) { * Payment payment = paymentFactory.create(new Date(), amount); * payment.apply(); * } * }</pre> - * <p/> * <h3>Making parameter types distinct</h3> * The types of the factory method's parameters must be distinct. To use multiple parameters of * the same type, use a named {@literal @}{@link Assisted} annotation to disambiguate the * parameters. The names must be applied to the factory method's parameters: - * <p/> * <pre>public interface PaymentFactory { * Payment create( * <strong>{@literal @}Assisted("startDate")</strong> Date startDate, @@ -115,21 +108,17 @@ import java.util.Set; * ... * } * }</pre> - * <p/> * <h3>Values are created by Guice</h3> * Returned factories use child injectors to create values. The values are eligible for method * interception. In addition, {@literal @}{@literal Inject} members will be injected before they are * returned. - * <p/> * <h3>Backwards compatibility using {@literal @}AssistedInject</h3> * Instead of the {@literal @}Inject annotation, you may annotate the constructed classes with * {@literal @}{@link AssistedInject}. This triggers a limited backwards-compatibility mode. - * <p/> * <p>Instead of matching factory method arguments to constructor parameters using their names, the * <strong>parameters are matched by their order</strong>. The first factory method argument is * used for the first {@literal @}Assisted constructor parameter, etc.. Annotation names have no * effect. - * <p/> * <p>Returned values are <strong>not created by Guice</strong>. These types are not eligible for * method interception. They do receive post-construction member injection. * diff --git a/core/src/main/java/org/elasticsearch/common/inject/assistedinject/FactoryProvider2.java b/core/src/main/java/org/elasticsearch/common/inject/assistedinject/FactoryProvider2.java index bedd7969cc..c52b2dda3f 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/assistedinject/FactoryProvider2.java +++ b/core/src/main/java/org/elasticsearch/common/inject/assistedinject/FactoryProvider2.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/assistedinject/Parameter.java b/core/src/main/java/org/elasticsearch/common/inject/assistedinject/Parameter.java index 16e4deb65d..e067cc813b 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/assistedinject/Parameter.java +++ b/core/src/main/java/org/elasticsearch/common/inject/assistedinject/Parameter.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2007 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -101,7 +101,7 @@ class Parameter { /** * Replace annotation instances with annotation types, this is only * appropriate for testing if a key is bound and not for injecting. - * <p/> + * <p> * See Guice bug 125, * http://code.google.com/p/google-guice/issues/detail?id=125 */ diff --git a/core/src/main/java/org/elasticsearch/common/inject/assistedinject/ParameterListKey.java b/core/src/main/java/org/elasticsearch/common/inject/assistedinject/ParameterListKey.java index cfaa980045..fea6a62938 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/assistedinject/ParameterListKey.java +++ b/core/src/main/java/org/elasticsearch/common/inject/assistedinject/ParameterListKey.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2007 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -63,4 +63,4 @@ class ParameterListKey { public String toString() { return paramList.toString(); } -}
\ No newline at end of file +} diff --git a/core/src/main/java/org/elasticsearch/common/inject/binder/AnnotatedBindingBuilder.java b/core/src/main/java/org/elasticsearch/common/inject/binder/AnnotatedBindingBuilder.java index a093f7dee0..a6370a0d84 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/binder/AnnotatedBindingBuilder.java +++ b/core/src/main/java/org/elasticsearch/common/inject/binder/AnnotatedBindingBuilder.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/binder/AnnotatedConstantBindingBuilder.java b/core/src/main/java/org/elasticsearch/common/inject/binder/AnnotatedConstantBindingBuilder.java index bd92496173..2d0a52391c 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/binder/AnnotatedConstantBindingBuilder.java +++ b/core/src/main/java/org/elasticsearch/common/inject/binder/AnnotatedConstantBindingBuilder.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/binder/AnnotatedElementBuilder.java b/core/src/main/java/org/elasticsearch/common/inject/binder/AnnotatedElementBuilder.java index d41f308659..14c5292f52 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/binder/AnnotatedElementBuilder.java +++ b/core/src/main/java/org/elasticsearch/common/inject/binder/AnnotatedElementBuilder.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/binder/LinkedBindingBuilder.java b/core/src/main/java/org/elasticsearch/common/inject/binder/LinkedBindingBuilder.java index 831935c37e..42c9228983 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/binder/LinkedBindingBuilder.java +++ b/core/src/main/java/org/elasticsearch/common/inject/binder/LinkedBindingBuilder.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/binder/ScopedBindingBuilder.java b/core/src/main/java/org/elasticsearch/common/inject/binder/ScopedBindingBuilder.java index b25bed59de..a73619fbb0 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/binder/ScopedBindingBuilder.java +++ b/core/src/main/java/org/elasticsearch/common/inject/binder/ScopedBindingBuilder.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/AbstractBindingBuilder.java b/core/src/main/java/org/elasticsearch/common/inject/internal/AbstractBindingBuilder.java index e6c3b1c952..d037b1de37 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/AbstractBindingBuilder.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/AbstractBindingBuilder.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/Annotations.java b/core/src/main/java/org/elasticsearch/common/inject/internal/Annotations.java index 24b3b8055d..6cf8821a08 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/Annotations.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/Annotations.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/BindingBuilder.java b/core/src/main/java/org/elasticsearch/common/inject/internal/BindingBuilder.java index 45a125966d..6b03be5796 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/BindingBuilder.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/BindingBuilder.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/BindingImpl.java b/core/src/main/java/org/elasticsearch/common/inject/internal/BindingImpl.java index 1c7552d8b6..291ecb207f 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/BindingImpl.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/BindingImpl.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/ConstantBindingBuilderImpl.java b/core/src/main/java/org/elasticsearch/common/inject/internal/ConstantBindingBuilderImpl.java index 5befe112d6..1cf37c1199 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/ConstantBindingBuilderImpl.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/ConstantBindingBuilderImpl.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/ConstructionContext.java b/core/src/main/java/org/elasticsearch/common/inject/internal/ConstructionContext.java index 7934fb46dc..34c9faf77e 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/ConstructionContext.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/ConstructionContext.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/ErrorHandler.java b/core/src/main/java/org/elasticsearch/common/inject/internal/ErrorHandler.java index 86f132134f..63173bd318 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/ErrorHandler.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/ErrorHandler.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/Errors.java b/core/src/main/java/org/elasticsearch/common/inject/internal/Errors.java index a38b2c0b34..6c9d155d6b 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/Errors.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/Errors.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -52,12 +52,12 @@ import java.util.Locale; /** * A collection of error messages. If this type is passed as a method parameter, the method is * considered to have executed successfully only if new errors were not added to this collection. - * <p/> - * <p>Errors can be chained to provide additional context. To add context, call {@link #withSource} + * <p> + * Errors can be chained to provide additional context. To add context, call {@link #withSource} * to create a new Errors instance that contains additional context. All messages added to the * returned instance will contain full context. - * <p/> - * <p>To avoid messages with redundant context, {@link #withSource} should be added sparingly. A + * <p> + * To avoid messages with redundant context, {@link #withSource} should be added sparingly. A * good rule of thumb is to assume a ethod's caller has already specified enough context to * identify that method. When calling a method that's defined in a different context, call that * method with an errors object that includes its context. diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/ErrorsException.java b/core/src/main/java/org/elasticsearch/common/inject/internal/ErrorsException.java index c570853ced..570a787d36 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/ErrorsException.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/ErrorsException.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/ExposedBindingImpl.java b/core/src/main/java/org/elasticsearch/common/inject/internal/ExposedBindingImpl.java index 64961cdc23..335b415fa6 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/ExposedBindingImpl.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/ExposedBindingImpl.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/ExposureBuilder.java b/core/src/main/java/org/elasticsearch/common/inject/internal/ExposureBuilder.java index 6b5f5f95a9..36b148ebbe 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/ExposureBuilder.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/ExposureBuilder.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2009 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/FailableCache.java b/core/src/main/java/org/elasticsearch/common/inject/internal/FailableCache.java index 23c6b15e17..c0dd95fdf8 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/FailableCache.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/FailableCache.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/InstanceBindingImpl.java b/core/src/main/java/org/elasticsearch/common/inject/internal/InstanceBindingImpl.java index 64bae0b022..73c447ea1f 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/InstanceBindingImpl.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/InstanceBindingImpl.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/InternalContext.java b/core/src/main/java/org/elasticsearch/common/inject/internal/InternalContext.java index aed51b104d..1184a97edc 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/InternalContext.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/InternalContext.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/InternalFactory.java b/core/src/main/java/org/elasticsearch/common/inject/internal/InternalFactory.java index c1b36d6a9d..b2203ed3b6 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/InternalFactory.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/InternalFactory.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/Join.java b/core/src/main/java/org/elasticsearch/common/inject/internal/Join.java index db0afe95d3..1c8c835615 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/Join.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/Join.java @@ -29,8 +29,8 @@ import java.util.Objects; * iterators, collections, arrays, and varargs, and can append to any * {@link Appendable} or just return a {@link String}. For example, * {@code join(":", "a", "b", "c")} returns {@code "a:b:c"}. - * <p/> - * <p>All methods of this class throw {@link NullPointerException} when a value + * <p> + * All methods of this class throw {@link NullPointerException} when a value * of {@code null} is supplied for any parameter. The elements within the * collection, iterator, array, or varargs parameter list <i>may</i> be null -- * these will be represented in the output by the string {@code "null"}. @@ -45,8 +45,8 @@ public final class Join { * Returns a string containing the {@code tokens}, converted to strings if * necessary, separated by {@code delimiter}. If {@code tokens} is empty, it * returns an empty string. - * <p/> - * <p>Each token will be converted to a {@link CharSequence} using + * <p> + * Each token will be converted to a {@link CharSequence} using * {@link String#valueOf(Object)}, if it isn't a {@link CharSequence} already. * Note that this implies that null tokens will be appended as the * four-character string {@code "null"}. @@ -64,8 +64,8 @@ public final class Join { * Returns a string containing the {@code tokens}, converted to strings if * necessary, separated by {@code delimiter}. If {@code tokens} is empty, it * returns an empty string. - * <p/> - * <p>Each token will be converted to a {@link CharSequence} using + * <p> + * Each token will be converted to a {@link CharSequence} using * {@link String#valueOf(Object)}, if it isn't a {@link CharSequence} already. * Note that this implies that null tokens will be appended as the * four-character string {@code "null"}. @@ -82,8 +82,8 @@ public final class Join { /** * Returns a string containing the {@code tokens}, converted to strings if * necessary, separated by {@code delimiter}. - * <p/> - * <p>Each token will be converted to a {@link CharSequence} using + * <p> + * Each token will be converted to a {@link CharSequence} using * {@link String#valueOf(Object)}, if it isn't a {@link CharSequence} already. * Note that this implies that null tokens will be appended as the * four-character string {@code "null"}. @@ -104,8 +104,8 @@ public final class Join { * Returns a string containing the {@code tokens}, converted to strings if * necessary, separated by {@code delimiter}. If {@code tokens} is empty, it * returns an empty string. - * <p/> - * <p>Each token will be converted to a {@link CharSequence} using + * <p> + * Each token will be converted to a {@link CharSequence} using * {@link String#valueOf(Object)}, if it isn't a {@link CharSequence} already. * Note that this implies that null tokens will be appended as the * four-character string {@code "null"}. @@ -125,8 +125,8 @@ public final class Join { * Returns a string containing the contents of {@code map}, with entries * separated by {@code entryDelimiter}, and keys and values separated with * {@code keyValueSeparator}. - * <p/> - * <p>Each key and value will be converted to a {@link CharSequence} using + * <p> + * Each key and value will be converted to a {@link CharSequence} using * {@link String#valueOf(Object)}, if it isn't a {@link CharSequence} already. * Note that this implies that null tokens will be appended as the * four-character string {@code "null"}. @@ -148,8 +148,8 @@ public final class Join { /** * Appends each of the {@code tokens} to {@code appendable}, separated by * {@code delimiter}. - * <p/> - * <p>Each token will be converted to a {@link CharSequence} using + * <p> + * Each token will be converted to a {@link CharSequence} using * {@link String#valueOf(Object)}, if it isn't a {@link CharSequence} already. * Note that this implies that null tokens will be appended as the * four-character string {@code "null"}. @@ -169,8 +169,8 @@ public final class Join { /** * Appends each of the {@code tokens} to {@code appendable}, separated by * {@code delimiter}. - * <p/> - * <p>Each token will be converted to a {@link CharSequence} using + * <p> + * Each token will be converted to a {@link CharSequence} using * {@link String#valueOf(Object)}, if it isn't a {@link CharSequence} already. * Note that this implies that null tokens will be appended as the * four-character string {@code "null"}. @@ -190,8 +190,8 @@ public final class Join { /** * Appends each of the {@code tokens} to {@code appendable}, separated by * {@code delimiter}. - * <p/> - * <p>Each token will be converted to a {@link CharSequence} using + * <p> + * Each token will be converted to a {@link CharSequence} using * {@link String#valueOf(Object)}, if it isn't a {@link CharSequence} already. * Note that this implies that null tokens will be appended as the * four-character string {@code "null"}. @@ -213,8 +213,8 @@ public final class Join { /** * Appends each of the {@code tokens} to {@code appendable}, separated by * {@code delimiter}. - * <p/> - * <p>Each token will be converted to a {@link CharSequence} using + * <p> + * Each token will be converted to a {@link CharSequence} using * {@link String#valueOf(Object)}, if it isn't a {@link CharSequence} already. * Note that this implies that null tokens will be appended as the * four-character string {@code "null"}. @@ -251,8 +251,8 @@ public final class Join { * Appends the contents of {@code map} to {@code appendable}, with entries * separated by {@code entryDelimiter}, and keys and values separated with * {@code keyValueSeparator}. - * <p/> - * <p>Each key and value will be converted to a {@link CharSequence} using + * <p> + * Each key and value will be converted to a {@link CharSequence} using * {@link String#valueOf(Object)}, if it isn't a {@link CharSequence} already. * Note that this implies that null tokens will be appended as the * four-character string {@code "null"}. @@ -316,4 +316,4 @@ public final class Join { private static final long serialVersionUID = 1L; } -}
\ No newline at end of file +} diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/MoreTypes.java b/core/src/main/java/org/elasticsearch/common/inject/internal/MoreTypes.java index 2a6111674e..737b8fa7d1 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/MoreTypes.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/MoreTypes.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/Nullability.java b/core/src/main/java/org/elasticsearch/common/inject/internal/Nullability.java index 621ff4d756..aad0c3a5ef 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/Nullability.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/Nullability.java @@ -4,11 +4,9 @@ import java.lang.annotation.Annotation; /** * Whether a member supports null values injected. - * <p/> * <p>Support for {@code Nullable} annotations in Guice is loose. * Any annotation type whose simplename is "Nullable" is sufficient to indicate * support for null values injected. - * <p/> * <p>This allows support for JSR-305's * <a href="http://groups.google.com/group/jsr-305/web/proposed-annotations"> * javax.annotation.meta.Nullable</a> annotation and IntelliJ IDEA's diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/Nullable.java b/core/src/main/java/org/elasticsearch/common/inject/internal/Nullable.java index ec48aedb6e..4dd499e432 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/Nullable.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/Nullable.java @@ -22,8 +22,8 @@ import java.lang.annotation.*; * The presence of this annotation on a method parameter indicates that * {@code null} is an acceptable value for that parameter. It should not be * used for parameters of primitive types. - * <p/> - * <p>This annotation may be used with the Google Web Toolkit (GWT). + * <p> + * This annotation may be used with the Google Web Toolkit (GWT). * * @author Kevin Bourrillion */ diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/PrivateElementsImpl.java b/core/src/main/java/org/elasticsearch/common/inject/internal/PrivateElementsImpl.java index 6ab5454325..685073b2c4 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/PrivateElementsImpl.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/PrivateElementsImpl.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/ProviderMethod.java b/core/src/main/java/org/elasticsearch/common/inject/internal/ProviderMethod.java index 84fbae4bec..a5d2f091d3 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/ProviderMethod.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/ProviderMethod.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/ProviderMethodsModule.java b/core/src/main/java/org/elasticsearch/common/inject/internal/ProviderMethodsModule.java index aa556edb37..fdd9402d14 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/ProviderMethodsModule.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/ProviderMethodsModule.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/Scoping.java b/core/src/main/java/org/elasticsearch/common/inject/internal/Scoping.java index b870f4273b..f6e26595e5 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/Scoping.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/Scoping.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/SourceProvider.java b/core/src/main/java/org/elasticsearch/common/inject/internal/SourceProvider.java index a149c5739a..d498de90c0 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/SourceProvider.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/SourceProvider.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/StackTraceElements.java b/core/src/main/java/org/elasticsearch/common/inject/internal/StackTraceElements.java index 2b55ddd9a1..5589c7b308 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/StackTraceElements.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/StackTraceElements.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/Stopwatch.java b/core/src/main/java/org/elasticsearch/common/inject/internal/Stopwatch.java index 849e869353..a7e332174e 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/Stopwatch.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/Stopwatch.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/Strings.java b/core/src/main/java/org/elasticsearch/common/inject/internal/Strings.java index 7c2e703d7f..4021581060 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/Strings.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/Strings.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -31,8 +31,8 @@ public class Strings { * The returned string will have the same value as the specified string if * its first character is non-alphabetic, if its first character is already * uppercase, or if the specified string is of length 0. - * <p/> - * <p>For example: + * <p> + * For example: * <pre> * capitalize("foo bar").equals("Foo bar"); * capitalize("2b or not 2b").equals("2b or not 2b") diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/ToStringBuilder.java b/core/src/main/java/org/elasticsearch/common/inject/internal/ToStringBuilder.java index 1b36d63ed5..4e975280cb 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/ToStringBuilder.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/ToStringBuilder.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/internal/UniqueAnnotations.java b/core/src/main/java/org/elasticsearch/common/inject/internal/UniqueAnnotations.java index 15c7736911..4324eb4d00 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/internal/UniqueAnnotations.java +++ b/core/src/main/java/org/elasticsearch/common/inject/internal/UniqueAnnotations.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/matcher/AbstractMatcher.java b/core/src/main/java/org/elasticsearch/common/inject/matcher/AbstractMatcher.java index 5000716363..a180ecacb8 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/matcher/AbstractMatcher.java +++ b/core/src/main/java/org/elasticsearch/common/inject/matcher/AbstractMatcher.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/matcher/Matcher.java b/core/src/main/java/org/elasticsearch/common/inject/matcher/Matcher.java index e2bfa1b060..a6da311810 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/matcher/Matcher.java +++ b/core/src/main/java/org/elasticsearch/common/inject/matcher/Matcher.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/matcher/Matchers.java b/core/src/main/java/org/elasticsearch/common/inject/matcher/Matchers.java index c29a48ddd9..96df76c0b9 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/matcher/Matchers.java +++ b/core/src/main/java/org/elasticsearch/common/inject/matcher/Matchers.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/multibindings/Element.java b/core/src/main/java/org/elasticsearch/common/inject/multibindings/Element.java index 02323dc568..68ffa4e858 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/multibindings/Element.java +++ b/core/src/main/java/org/elasticsearch/common/inject/multibindings/Element.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/multibindings/MapBinder.java b/core/src/main/java/org/elasticsearch/common/inject/multibindings/MapBinder.java index 01bd59f7d9..81f66561b8 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/multibindings/MapBinder.java +++ b/core/src/main/java/org/elasticsearch/common/inject/multibindings/MapBinder.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -48,43 +48,43 @@ import static org.elasticsearch.common.inject.util.Types.newParameterizedTypeWit * mapbinder.addBinding("skittles").to(Skittles.class); * } * }</code></pre> - * <p/> - * <p>With this binding, a {@link Map}{@code <String, Snack>} can now be + * <p> + * With this binding, a {@link Map}{@code <String, Snack>} can now be * injected: * <pre><code> * class SnackMachine { * {@literal @}Inject * public SnackMachine(Map<String, Snack> snacks) { ... } * }</code></pre> - * <p/> - * <p>In addition to binding {@code Map<K, V>}, a mapbinder will also bind + * <p> + * In addition to binding {@code Map<K, V>}, a mapbinder will also bind * {@code Map<K, Provider<V>>} for lazy value provision: * <pre><code> * class SnackMachine { * {@literal @}Inject * public SnackMachine(Map<String, Provider<Snack>> snackProviders) { ... } * }</code></pre> - * <p/> - * <p>Creating mapbindings from different modules is supported. For example, it + * <p> + * Creating mapbindings from different modules is supported. For example, it * is okay to have both {@code CandyModule} and {@code ChipsModule} both * create their own {@code MapBinder<String, Snack>}, and to each contribute * bindings to the snacks map. When that map is injected, it will contain * entries from both modules. - * <p/> - * <p>Values are resolved at map injection time. If a value is bound to a + * <p> + * Values are resolved at map injection time. If a value is bound to a * provider, that provider's get method will be called each time the map is * injected (unless the binding is also scoped, or a map of providers is injected). - * <p/> - * <p>Annotations are used to create different maps of the same key/value + * <p> + * Annotations are used to create different maps of the same key/value * type. Each distinct annotation gets its own independent map. - * <p/> - * <p><strong>Keys must be distinct.</strong> If the same key is bound more than + * <p> + * <strong>Keys must be distinct.</strong> If the same key is bound more than * once, map injection will fail. - * <p/> - * <p><strong>Keys must be non-null.</strong> {@code addBinding(null)} will + * <p> + * <strong>Keys must be non-null.</strong> {@code addBinding(null)} will * throw an unchecked exception. - * <p/> - * <p><strong>Values must be non-null to use map injection.</strong> If any + * <p> + * <strong>Values must be non-null to use map injection.</strong> If any * value is null, map injection will fail (although injecting a map of providers * will not). * @@ -195,38 +195,38 @@ public abstract class MapBinder<K, V> { * Returns a binding builder used to add a new entry in the map. Each * key must be distinct (and non-null). Bound providers will be evaluated each * time the map is injected. - * <p/> - * <p>It is an error to call this method without also calling one of the + * <p> + * It is an error to call this method without also calling one of the * {@code to} methods on the returned binding builder. - * <p/> - * <p>Scoping elements independently is supported. Use the {@code in} method + * <p> + * Scoping elements independently is supported. Use the {@code in} method * to specify a binding scope. */ public abstract LinkedBindingBuilder<V> addBinding(K key); /** * The actual mapbinder plays several roles: - * <p/> - * <p>As a MapBinder, it acts as a factory for LinkedBindingBuilders for + * <p> + * As a MapBinder, it acts as a factory for LinkedBindingBuilders for * each of the map's values. It delegates to a {@link Multibinder} of * entries (keys to value providers). - * <p/> - * <p>As a Module, it installs the binding to the map itself, as well as to + * <p> + * As a Module, it installs the binding to the map itself, as well as to * a corresponding map whose values are providers. It uses the entry set * multibinder to construct the map and the provider map. - * <p/> - * <p>As a module, this implements equals() and hashcode() in order to trick + * <p> + * As a module, this implements equals() and hashcode() in order to trick * Guice into executing its configure() method only once. That makes it so * that multiple mapbinders can be created for the same target map, but * only one is bound. Since the list of bindings is retrieved from the * injector itself (and not the mapbinder), each mapbinder has access to * all contributions from all equivalent mapbinders. - * <p/> - * <p>Rather than binding a single Map.Entry<K, V>, the map binder + * <p> + * Rather than binding a single Map.Entry<K, V>, the map binder * binds keys and values independently. This allows the values to be properly * scoped. - * <p/> - * <p>We use a subclass to hide 'implements Module' from the public API. + * <p> + * We use a subclass to hide 'implements Module' from the public API. */ public static final class RealMapBinder<K, V> extends MapBinder<K, V> implements Module { private final TypeLiteral<V> valueType; diff --git a/core/src/main/java/org/elasticsearch/common/inject/multibindings/Multibinder.java b/core/src/main/java/org/elasticsearch/common/inject/multibindings/Multibinder.java index 87ee3c3c99..9455dc57ba 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/multibindings/Multibinder.java +++ b/core/src/main/java/org/elasticsearch/common/inject/multibindings/Multibinder.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -56,32 +56,32 @@ import java.util.Set; * multibinder.addBinding().to(Skittles.class); * } * }</code></pre> - * <p/> - * <p>With this binding, a {@link Set}{@code <Snack>} can now be injected: + * <p> + * With this binding, a {@link Set}{@code <Snack>} can now be injected: * <pre><code> * class SnackMachine { * {@literal @}Inject * public SnackMachine(Set<Snack> snacks) { ... } * }</code></pre> - * <p/> - * <p>Create multibindings from different modules is supported. For example, it + * <p> + * Create multibindings from different modules is supported. For example, it * is okay to have both {@code CandyModule} and {@code ChipsModule} to both * create their own {@code Multibinder<Snack>}, and to each contribute bindings * to the set of snacks. When that set is injected, it will contain elements * from both modules. - * <p/> - * <p>Elements are resolved at set injection time. If an element is bound to a + * <p> + * Elements are resolved at set injection time. If an element is bound to a * provider, that provider's get method will be called each time the set is * injected (unless the binding is also scoped). - * <p/> - * <p>Annotations are be used to create different sets of the same element + * <p> + * Annotations are be used to create different sets of the same element * type. Each distinct annotation gets its own independent collection of * elements. - * <p/> - * <p><strong>Elements must be distinct.</strong> If multiple bound elements + * <p> + * <strong>Elements must be distinct.</strong> If multiple bound elements * have the same value, set injection will fail. - * <p/> - * <p><strong>Elements must be non-null.</strong> If any set element is null, + * <p> + * <strong>Elements must be non-null.</strong> If any set element is null, * set injection will fail. * * @author jessewilson@google.com (Jesse Wilson) @@ -164,33 +164,33 @@ public abstract class Multibinder<T> { * Returns a binding builder used to add a new element in the set. Each * bound element must have a distinct value. Bound providers will be * evaluated each time the set is injected. - * <p/> - * <p>It is an error to call this method without also calling one of the + * <p> + * It is an error to call this method without also calling one of the * {@code to} methods on the returned binding builder. - * <p/> - * <p>Scoping elements independently is supported. Use the {@code in} method + * <p> + * Scoping elements independently is supported. Use the {@code in} method * to specify a binding scope. */ public abstract LinkedBindingBuilder<T> addBinding(); /** * The actual multibinder plays several roles: - * <p/> - * <p>As a Multibinder, it acts as a factory for LinkedBindingBuilders for + * <p> + * As a Multibinder, it acts as a factory for LinkedBindingBuilders for * each of the set's elements. Each binding is given an annotation that * identifies it as a part of this set. - * <p/> - * <p>As a Module, it installs the binding to the set itself. As a module, + * <p> + * As a Module, it installs the binding to the set itself. As a module, * this implements equals() and hashcode() in order to trick Guice into * executing its configure() method only once. That makes it so that * multiple multibinders can be created for the same target collection, but * only one is bound. Since the list of bindings is retrieved from the * injector itself (and not the multibinder), each multibinder has access to * all contributions from all multibinders. - * <p/> - * <p>As a Provider, this constructs the set instances. - * <p/> - * <p>We use a subclass to hide 'implements Module, Provider' from the public + * <p> + * As a Provider, this constructs the set instances. + * <p> + * We use a subclass to hide 'implements Module, Provider' from the public * API. */ public static final class RealMultibinder<T> extends Multibinder<T> diff --git a/core/src/main/java/org/elasticsearch/common/inject/multibindings/RealElement.java b/core/src/main/java/org/elasticsearch/common/inject/multibindings/RealElement.java index cc123de8ca..acc859162b 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/multibindings/RealElement.java +++ b/core/src/main/java/org/elasticsearch/common/inject/multibindings/RealElement.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/name/Named.java b/core/src/main/java/org/elasticsearch/common/inject/name/Named.java index 0d914be6f5..54ec471e49 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/name/Named.java +++ b/core/src/main/java/org/elasticsearch/common/inject/name/Named.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/name/NamedImpl.java b/core/src/main/java/org/elasticsearch/common/inject/name/NamedImpl.java index 8cf7af12f0..7c43e7c5a7 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/name/NamedImpl.java +++ b/core/src/main/java/org/elasticsearch/common/inject/name/NamedImpl.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/name/Names.java b/core/src/main/java/org/elasticsearch/common/inject/name/Names.java index 7f3636f6b7..c3da515350 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/name/Names.java +++ b/core/src/main/java/org/elasticsearch/common/inject/name/Names.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/package-info.java b/core/src/main/java/org/elasticsearch/common/inject/package-info.java index 44ff5b2f30..2fa93ef48e 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/package-info.java +++ b/core/src/main/java/org/elasticsearch/common/inject/package-info.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/BindingScopingVisitor.java b/core/src/main/java/org/elasticsearch/common/inject/spi/BindingScopingVisitor.java index fb2f4ff176..6025466b9e 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/BindingScopingVisitor.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/BindingScopingVisitor.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/BindingTargetVisitor.java b/core/src/main/java/org/elasticsearch/common/inject/spi/BindingTargetVisitor.java index b13611588a..56ca0c57fa 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/BindingTargetVisitor.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/BindingTargetVisitor.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/ConstructorBinding.java b/core/src/main/java/org/elasticsearch/common/inject/spi/ConstructorBinding.java index df464fa00f..85951dacda 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/ConstructorBinding.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/ConstructorBinding.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/ConvertedConstantBinding.java b/core/src/main/java/org/elasticsearch/common/inject/spi/ConvertedConstantBinding.java index ebabfa318f..3c4ec4d9ed 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/ConvertedConstantBinding.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/ConvertedConstantBinding.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/DefaultBindingScopingVisitor.java b/core/src/main/java/org/elasticsearch/common/inject/spi/DefaultBindingScopingVisitor.java index 106f9e722b..deced4e141 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/DefaultBindingScopingVisitor.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/DefaultBindingScopingVisitor.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/DefaultBindingTargetVisitor.java b/core/src/main/java/org/elasticsearch/common/inject/spi/DefaultBindingTargetVisitor.java index 508c289913..75a3b615a1 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/DefaultBindingTargetVisitor.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/DefaultBindingTargetVisitor.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/DefaultElementVisitor.java b/core/src/main/java/org/elasticsearch/common/inject/spi/DefaultElementVisitor.java index 7ee9e0f462..d86f0bacdb 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/DefaultElementVisitor.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/DefaultElementVisitor.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/Dependency.java b/core/src/main/java/org/elasticsearch/common/inject/spi/Dependency.java index 919e8d331b..2bac853d2d 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/Dependency.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/Dependency.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -26,8 +26,8 @@ import java.util.Set; /** * A variable that can be resolved by an injector. - * <p/> - * <p>Use {@link #get} to build a freestanding dependency, or {@link InjectionPoint} to build one + * <p> + * Use {@link #get} to build a freestanding dependency, or {@link InjectionPoint} to build one * that's attached to a constructor, method or field. * * @author crazybob@google.com (Bob Lee) diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/Element.java b/core/src/main/java/org/elasticsearch/common/inject/spi/Element.java index a222c37bba..f9128d98f5 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/Element.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/Element.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -20,13 +20,13 @@ import org.elasticsearch.common.inject.Binder; /** * A core component of a module or injector. - * <p/> - * <p>The elements of a module can be inspected, validated and rewritten. Use {@link + * <p> + * The elements of a module can be inspected, validated and rewritten. Use {@link * Elements#getElements(org.elasticsearch.common.inject.Module[]) Elements.getElements()} to read the elements * from a module, and {@link Elements#getModule(Iterable) Elements.getModule()} to rewrite them. * This can be used for static analysis and generation of Guice modules. - * <p/> - * <p>The elements of an injector can be inspected and exercised. Use {@link + * <p> + * The elements of an injector can be inspected and exercised. Use {@link * org.elasticsearch.common.inject.Injector#getBindings Injector.getBindings()} to reflect on Guice injectors. * * @author jessewilson@google.com (Jesse Wilson) @@ -38,8 +38,8 @@ public interface Element { /** * Returns an arbitrary object containing information about the "place" where this element was * configured. Used by Guice in the production of descriptive error messages. - * <p/> - * <p>Tools might specially handle types they know about; {@code StackTraceElement} is a good + * <p> + * Tools might specially handle types they know about; {@code StackTraceElement} is a good * example. Tools should simply call {@code toString()} on the source object if the type is * unfamiliar. */ diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/ElementVisitor.java b/core/src/main/java/org/elasticsearch/common/inject/spi/ElementVisitor.java index 1cf17af035..6711456004 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/ElementVisitor.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/ElementVisitor.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/Elements.java b/core/src/main/java/org/elasticsearch/common/inject/spi/Elements.java index afc85458df..38456a4d04 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/Elements.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/Elements.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/ExposedBinding.java b/core/src/main/java/org/elasticsearch/common/inject/spi/ExposedBinding.java index 33dc6c9d03..d5490c8138 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/ExposedBinding.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/ExposedBinding.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -37,4 +37,4 @@ public interface ExposedBinding<T> extends Binding<T>, HasDependencies { */ @Override void applyTo(Binder binder); -}
\ No newline at end of file +} diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/HasDependencies.java b/core/src/main/java/org/elasticsearch/common/inject/spi/HasDependencies.java index 3ff1ffd438..29367acdeb 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/HasDependencies.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/HasDependencies.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/InjectionPoint.java b/core/src/main/java/org/elasticsearch/common/inject/spi/InjectionPoint.java index 72fde2c11d..2aa07b4f00 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/InjectionPoint.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/InjectionPoint.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/InjectionRequest.java b/core/src/main/java/org/elasticsearch/common/inject/spi/InjectionRequest.java index f52e6c387e..00c6be4b98 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/InjectionRequest.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/InjectionRequest.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/InstanceBinding.java b/core/src/main/java/org/elasticsearch/common/inject/spi/InstanceBinding.java index 13712fe56f..bd0bf66c65 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/InstanceBinding.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/InstanceBinding.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/LinkedKeyBinding.java b/core/src/main/java/org/elasticsearch/common/inject/spi/LinkedKeyBinding.java index 31b1b74d1a..82c36c7c2e 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/LinkedKeyBinding.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/LinkedKeyBinding.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/MembersInjectorLookup.java b/core/src/main/java/org/elasticsearch/common/inject/spi/MembersInjectorLookup.java index 9bde624735..d12c6bdd49 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/MembersInjectorLookup.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/MembersInjectorLookup.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2009 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/Message.java b/core/src/main/java/org/elasticsearch/common/inject/spi/Message.java index 37aa3b9d0d..e5488d0741 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/Message.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/Message.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2006 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/PrivateElements.java b/core/src/main/java/org/elasticsearch/common/inject/spi/PrivateElements.java index 64ead9c0b0..6da4f29aa2 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/PrivateElements.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/PrivateElements.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -50,8 +50,8 @@ public interface PrivateElements extends Element { /** * Returns an arbitrary object containing information about the "place" where this key was * exposed. Used by Guice in the production of descriptive error messages. - * <p/> - * <p>Tools might specially handle types they know about; {@code StackTraceElement} is a good + * <p> + * Tools might specially handle types they know about; {@code StackTraceElement} is a good * example. Tools should simply call {@code toString()} on the source object if the type is * unfamiliar. * diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/ProviderBinding.java b/core/src/main/java/org/elasticsearch/common/inject/spi/ProviderBinding.java index b6f67b764f..04fb78d028 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/ProviderBinding.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/ProviderBinding.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/ProviderInstanceBinding.java b/core/src/main/java/org/elasticsearch/common/inject/spi/ProviderInstanceBinding.java index 246bc8a91a..9277d9f7ef 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/ProviderInstanceBinding.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/ProviderInstanceBinding.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/ProviderKeyBinding.java b/core/src/main/java/org/elasticsearch/common/inject/spi/ProviderKeyBinding.java index 4d934f8216..15aa751f4a 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/ProviderKeyBinding.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/ProviderKeyBinding.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/ProviderLookup.java b/core/src/main/java/org/elasticsearch/common/inject/spi/ProviderLookup.java index 464b8501af..9b925cd046 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/ProviderLookup.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/ProviderLookup.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/ProviderWithDependencies.java b/core/src/main/java/org/elasticsearch/common/inject/spi/ProviderWithDependencies.java index 2c21437773..81cd2cd638 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/ProviderWithDependencies.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/ProviderWithDependencies.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/ScopeBinding.java b/core/src/main/java/org/elasticsearch/common/inject/spi/ScopeBinding.java index 9db84af19a..a1c52c5f8c 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/ScopeBinding.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/ScopeBinding.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/StaticInjectionRequest.java b/core/src/main/java/org/elasticsearch/common/inject/spi/StaticInjectionRequest.java index b7a052561d..cc0fc09c0f 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/StaticInjectionRequest.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/StaticInjectionRequest.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/TypeConverterBinding.java b/core/src/main/java/org/elasticsearch/common/inject/spi/TypeConverterBinding.java index 84215c7e5d..bff5bc1906 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/TypeConverterBinding.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/TypeConverterBinding.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/TypeEncounter.java b/core/src/main/java/org/elasticsearch/common/inject/spi/TypeEncounter.java index b8487a1e4b..49e84c81ca 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/TypeEncounter.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/TypeEncounter.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2009 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/TypeListener.java b/core/src/main/java/org/elasticsearch/common/inject/spi/TypeListener.java index f066683fec..134faa2661 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/TypeListener.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/TypeListener.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2009 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -22,9 +22,9 @@ import org.elasticsearch.common.inject.TypeLiteral; * Listens for Guice to encounter injectable types. If a given type has its constructor injected in * one situation but only its methods and fields injected in another, Guice will notify this * listener once. - * <p/> - * <p>Useful for extra type checking, {@linkplain TypeEncounter#register(InjectionListener) - * registering injection listeners}, and {@linkplain TypeEncounter#bindInterceptor( + * <p> + * Useful for extra type checking, {@linkplain TypeEncounter#register(InjectionListener) + * registering injection listeners}, and {@code TypeEncounter#bindInterceptor( *org.elasticsearch.common.inject.matcher.Matcher, org.aopalliance.intercept.MethodInterceptor[]) * binding method interceptors}. * diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/TypeListenerBinding.java b/core/src/main/java/org/elasticsearch/common/inject/spi/TypeListenerBinding.java index 88feaa873e..c52c239f16 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/TypeListenerBinding.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/TypeListenerBinding.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2009 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -23,9 +23,8 @@ import org.elasticsearch.common.inject.matcher.Matcher; /** * Binds types (picked using a Matcher) to an type listener. Registrations are created explicitly in * a module using {@link org.elasticsearch.common.inject.Binder#bindListener(Matcher, TypeListener)} statements: - * <p/> * <pre> - * register(only(new TypeLiteral<PaymentService<CreditCard>>() {}), listener);</pre> + * register(only(new TypeLiteral<PaymentService<CreditCard>>() {}), listener);</pre> * * @author jessewilson@google.com (Jesse Wilson) * @since 2.0 diff --git a/core/src/main/java/org/elasticsearch/common/inject/spi/UntargettedBinding.java b/core/src/main/java/org/elasticsearch/common/inject/spi/UntargettedBinding.java index ba2dc9ad42..824469627d 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/spi/UntargettedBinding.java +++ b/core/src/main/java/org/elasticsearch/common/inject/spi/UntargettedBinding.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/inject/util/Modules.java b/core/src/main/java/org/elasticsearch/common/inject/util/Modules.java index 6e0fdca22f..f29e5aadae 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/util/Modules.java +++ b/core/src/main/java/org/elasticsearch/common/inject/util/Modules.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -64,8 +64,8 @@ public final class Modules { * Module functionalTestModule * = Modules.override(new ProductionModule()).with(new TestModule()); * </pre> - * <p/> - * <p>Prefer to write smaller modules that can be reused and tested without overrides. + * <p> + * Prefer to write smaller modules that can be reused and tested without overrides. * * @param modules the modules whose bindings are open to be overridden */ @@ -81,8 +81,8 @@ public final class Modules { * Module functionalTestModule * = Modules.override(getProductionModules()).with(getTestModules()); * </pre> - * <p/> - * <p>Prefer to write smaller modules that can be reused and tested without overrides. + * <p> + * Prefer to write smaller modules that can be reused and tested without overrides. * * @param modules the modules whose bindings are open to be overridden */ diff --git a/core/src/main/java/org/elasticsearch/common/inject/util/Types.java b/core/src/main/java/org/elasticsearch/common/inject/util/Types.java index ffd8aa69f4..43bb97c149 100644 --- a/core/src/main/java/org/elasticsearch/common/inject/util/Types.java +++ b/core/src/main/java/org/elasticsearch/common/inject/util/Types.java @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2008 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/core/src/main/java/org/elasticsearch/common/io/Channels.java b/core/src/main/java/org/elasticsearch/common/io/Channels.java index 79e89fcce5..2fa7ca1cde 100644 --- a/core/src/main/java/org/elasticsearch/common/io/Channels.java +++ b/core/src/main/java/org/elasticsearch/common/io/Channels.java @@ -167,7 +167,6 @@ public final class Channels { * @param sourceIndex index in <i>source</i> to start copying from * @param length how many bytes to copy * @param channel target GatheringByteChannel - * @throws IOException */ public static void writeToChannel(ChannelBuffer source, int sourceIndex, int length, GatheringByteChannel channel) throws IOException { while (length > 0) { @@ -184,7 +183,6 @@ public final class Channels { * * @param source byte array to copy from * @param channel target WritableByteChannel - * @throws IOException */ public static void writeToChannel(byte[] source, WritableByteChannel channel) throws IOException { writeToChannel(source, 0, source.length, channel); @@ -198,7 +196,6 @@ public final class Channels { * @param offset start copying from this offset * @param length how many bytes to copy * @param channel target WritableByteChannel - * @throws IOException */ public static void writeToChannel(byte[] source, int offset, int length, WritableByteChannel channel) throws IOException { int toWrite = Math.min(length, WRITE_CHUNK_SIZE); @@ -219,7 +216,6 @@ public final class Channels { * * @param byteBuffer source buffer * @param channel channel to write to - * @throws IOException */ public static void writeToChannel(ByteBuffer byteBuffer, WritableByteChannel channel) throws IOException { if (byteBuffer.isDirect() || (byteBuffer.remaining() <= WRITE_CHUNK_SIZE)) { diff --git a/core/src/main/java/org/elasticsearch/common/io/FastCharArrayReader.java b/core/src/main/java/org/elasticsearch/common/io/FastCharArrayReader.java index f202f38403..53b932afd5 100644 --- a/core/src/main/java/org/elasticsearch/common/io/FastCharArrayReader.java +++ b/core/src/main/java/org/elasticsearch/common/io/FastCharArrayReader.java @@ -61,8 +61,8 @@ public class FastCharArrayReader extends Reader { /** * Creates a CharArrayReader from the specified array of chars. - * <p/> - * <p> The resulting reader will start reading at the given + * <p> + * The resulting reader will start reading at the given * <tt>offset</tt>. The total number of <tt>char</tt> values that can be * read from this reader will be either <tt>length</tt> or * <tt>buf.length-offset</tt>, whichever is smaller. @@ -143,8 +143,8 @@ public class FastCharArrayReader extends Reader { /** * Skips characters. Returns the number of characters that were skipped. - * <p/> - * <p>The <code>n</code> parameter may be negative, even though the + * <p> + * The <code>n</code> parameter may be negative, even though the * <code>skip</code> method of the {@link Reader} superclass throws * an exception in this case. If <code>n</code> is negative, then * this method does nothing and returns <code>0</code>. diff --git a/core/src/main/java/org/elasticsearch/common/io/FastCharArrayWriter.java b/core/src/main/java/org/elasticsearch/common/io/FastCharArrayWriter.java index 8594b2c153..87313eae7f 100644 --- a/core/src/main/java/org/elasticsearch/common/io/FastCharArrayWriter.java +++ b/core/src/main/java/org/elasticsearch/common/io/FastCharArrayWriter.java @@ -124,10 +124,9 @@ public class FastCharArrayWriter extends Writer { /** * Appends the specified character sequence to this writer. - * <p/> - * <p> An invocation of this method of the form <tt>out.append(csq)</tt> + * <p> + * An invocation of this method of the form <tt>out.append(csq)</tt> * behaves in exactly the same way as the invocation - * <p/> * <pre> * out.write(csq.toString()) </pre> * @@ -152,11 +151,10 @@ public class FastCharArrayWriter extends Writer { /** * Appends a subsequence of the specified character sequence to this writer. - * <p/> - * <p> An invocation of this method of the form <tt>out.append(csq, start, + * <p> + * An invocation of this method of the form <tt>out.append(csq, start, * end)</tt> when <tt>csq</tt> is not <tt>null</tt>, behaves in * exactly the same way as the invocation - * <p/> * <pre> * out.write(csq.subSequence(start, end).toString()) </pre> * @@ -182,10 +180,9 @@ public class FastCharArrayWriter extends Writer { /** * Appends the specified character to this writer. - * <p/> - * <p> An invocation of this method of the form <tt>out.append(c)</tt> + * <p> + * An invocation of this method of the form <tt>out.append(c)</tt> * behaves in exactly the same way as the invocation - * <p/> * <pre> * out.write(c) </pre> * diff --git a/core/src/main/java/org/elasticsearch/common/io/FastStringReader.java b/core/src/main/java/org/elasticsearch/common/io/FastStringReader.java index 13bea142fe..2501914950 100644 --- a/core/src/main/java/org/elasticsearch/common/io/FastStringReader.java +++ b/core/src/main/java/org/elasticsearch/common/io/FastStringReader.java @@ -24,7 +24,7 @@ import java.io.Reader; /** * A character stream whose source is a string that is <b>not thread safe</b> - * <p/> + * <p> * (shay.banon * ) */ @@ -110,15 +110,15 @@ public class FastStringReader extends CharSequenceReader { /** * Skips the specified number of characters in the stream. Returns * the number of characters that were skipped. - * <p/> - * <p>The <code>ns</code> parameter may be negative, even though the + * <p> + * The <code>ns</code> parameter may be negative, even though the * <code>skip</code> method of the {@link Reader} superclass throws * an exception in this case. Negative values of <code>ns</code> cause the * stream to skip backwards. Negative return values indicate a skip * backwards. It is not possible to skip backwards past the beginning of * the string. - * <p/> - * <p>If the entire string has been read or skipped, then this method has + * <p> + * If the entire string has been read or skipped, then this method has * no effect and always returns 0. * * @throws IOException If an I/O error occurs @@ -164,7 +164,7 @@ public class FastStringReader extends CharSequenceReader { * the stream's input comes from a string, there * is no actual limit, so this argument must not * be negative, but is otherwise ignored. - * @throws IllegalArgumentException If readAheadLimit is < 0 + * @throws IllegalArgumentException If readAheadLimit is < 0 * @throws IOException If an I/O error occurs */ @Override diff --git a/core/src/main/java/org/elasticsearch/common/io/FileSystemUtils.java b/core/src/main/java/org/elasticsearch/common/io/FileSystemUtils.java index bf7eb5ee28..cb5ca5fec6 100644 --- a/core/src/main/java/org/elasticsearch/common/io/FileSystemUtils.java +++ b/core/src/main/java/org/elasticsearch/common/io/FileSystemUtils.java @@ -100,7 +100,7 @@ public final class FileSystemUtils { } /** - * Appends the path to the given base and strips N elements off the path if strip is > 0. + * Appends the path to the given base and strips N elements off the path if strip is > 0. */ public static Path append(Path base, Path path, int strip) { for (Path subPath : path) { diff --git a/core/src/main/java/org/elasticsearch/common/io/Streams.java b/core/src/main/java/org/elasticsearch/common/io/Streams.java index caa7053e86..8adf0919e5 100644 --- a/core/src/main/java/org/elasticsearch/common/io/Streams.java +++ b/core/src/main/java/org/elasticsearch/common/io/Streams.java @@ -38,8 +38,8 @@ import java.util.Objects; * Simple utility methods for file and stream copying. * All copy methods use a block size of 4096 bytes, * and close all affected streams when done. - * <p/> - * <p>Mainly for use within the framework, + * <p> + * Mainly for use within the framework, * but also useful for application code. */ public abstract class Streams { diff --git a/core/src/main/java/org/elasticsearch/common/io/stream/BytesStreamOutput.java b/core/src/main/java/org/elasticsearch/common/io/stream/BytesStreamOutput.java index 2107a9958d..155a8ca02f 100644 --- a/core/src/main/java/org/elasticsearch/common/io/stream/BytesStreamOutput.java +++ b/core/src/main/java/org/elasticsearch/common/io/stream/BytesStreamOutput.java @@ -28,8 +28,8 @@ import org.elasticsearch.common.util.ByteArray; import java.io.IOException; /** - * A @link {@link StreamOutput} that uses{@link BigArrays} to acquire pages of - * bytes, which avoids frequent reallocation & copying of the internal data. + * A @link {@link StreamOutput} that uses {@link BigArrays} to acquire pages of + * bytes, which avoids frequent reallocation & copying of the internal data. */ public class BytesStreamOutput extends StreamOutput implements BytesStream { diff --git a/core/src/main/java/org/elasticsearch/common/io/stream/ReleasableBytesStreamOutput.java b/core/src/main/java/org/elasticsearch/common/io/stream/ReleasableBytesStreamOutput.java index cf451c2e25..4e5380e66d 100644 --- a/core/src/main/java/org/elasticsearch/common/io/stream/ReleasableBytesStreamOutput.java +++ b/core/src/main/java/org/elasticsearch/common/io/stream/ReleasableBytesStreamOutput.java @@ -26,7 +26,7 @@ import org.elasticsearch.common.util.BigArrays; /** * An bytes stream output that allows providing a {@link BigArrays} instance * expecting it to require releasing its content ({@link #bytes()}) once done. - * <p/> + * <p> * Please note, its is the responsibility of the caller to make sure the bytes * reference do not "escape" and are released only once. */ diff --git a/core/src/main/java/org/elasticsearch/common/logging/log4j/ConsoleAppender.java b/core/src/main/java/org/elasticsearch/common/logging/log4j/ConsoleAppender.java index 940749bfa8..30c3aa91f5 100644 --- a/core/src/main/java/org/elasticsearch/common/logging/log4j/ConsoleAppender.java +++ b/core/src/main/java/org/elasticsearch/common/logging/log4j/ConsoleAppender.java @@ -32,7 +32,6 @@ import java.io.OutputStream; * ConsoleAppender appends log events to <code>System.out</code> or * <code>System.err</code> using a layout specified by the user. The * default target is <code>System.out</code>. - * <p/> * <p>Elasticsearch: Adapter from log4j to allow to disable console logging...</p> * * @author Ceki Gülcü @@ -99,7 +98,7 @@ public class ConsoleAppender extends WriterAppender { /** * Returns the current value of the <b>Target</b> property. The * default value of the option is "System.out". - * <p/> + * <p> * See also {@link #setTarget}. */ public String getTarget() { diff --git a/core/src/main/java/org/elasticsearch/common/lucene/Lucene.java b/core/src/main/java/org/elasticsearch/common/lucene/Lucene.java index db2bb12cb8..060482e2e8 100644 --- a/core/src/main/java/org/elasticsearch/common/lucene/Lucene.java +++ b/core/src/main/java/org/elasticsearch/common/lucene/Lucene.java @@ -265,7 +265,7 @@ public class Lucene { } /** - * Performs an exists (count > 0) query on the <code>searcher</code> for <code>query</code> + * Performs an exists (count > 0) query on the <code>searcher</code> for <code>query</code> * with <code>filter</code> using the given <code>collector</code> * * The <code>collector</code> can be instantiated using <code>Lucene.createExistsCollector()</code> @@ -279,7 +279,7 @@ public class Lucene { /** - * Performs an exists (count > 0) query on the <code>searcher</code> for <code>query</code> + * Performs an exists (count > 0) query on the <code>searcher</code> for <code>query</code> * using the given <code>collector</code> * * The <code>collector</code> can be instantiated using <code>Lucene.createExistsCollector()</code> @@ -318,7 +318,7 @@ public class Lucene { } /** - * Performs an exists (count > 0) query on the searcher from the <code>searchContext</code> for <code>query</code> + * Performs an exists (count > 0) query on the searcher from the <code>searchContext</code> for <code>query</code> * using the given <code>collector</code> * * The <code>collector</code> can be instantiated using <code>Lucene.createExistsCollector()</code> diff --git a/core/src/main/java/org/elasticsearch/common/lucene/search/XMoreLikeThis.java b/core/src/main/java/org/elasticsearch/common/lucene/search/XMoreLikeThis.java index 4275647df0..85e1899582 100644 --- a/core/src/main/java/org/elasticsearch/common/lucene/search/XMoreLikeThis.java +++ b/core/src/main/java/org/elasticsearch/common/lucene/search/XMoreLikeThis.java @@ -17,7 +17,7 @@ * under the License. */ -/** +/* * Copyright 2004-2005 The Apache Software Foundation. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -56,12 +56,11 @@ import java.util.*; /** * Generate "more like this" similarity queries. * Based on this mail: - * <code><pre> + * <pre> * Lucene does let you access the document frequency of terms, with IndexReader.docFreq(). * Term frequencies can be computed by re-tokenizing the text, which, for a single document, * is usually fast enough. But looking up the docFreq() of every term in the document is * probably too slow. - * <p/> * You can use some heuristics to prune the set of terms, to avoid calling docFreq() too much, * or at all. Since you're trying to maximize a tf*idf score, you're probably most interested * in terms with a high tf. Choosing a tf threshold even as low as two or three will radically @@ -70,44 +69,36 @@ import java.util.*; * number of characters, not selecting anything less than, e.g., six or seven characters. * With these sorts of heuristics you can usually find small set of, e.g., ten or fewer terms * that do a pretty good job of characterizing a document. - * <p/> * It all depends on what you're trying to do. If you're trying to eek out that last percent * of precision and recall regardless of computational difficulty so that you can win a TREC * competition, then the techniques I mention above are useless. But if you're trying to * provide a "more like this" button on a search results page that does a decent job and has * good performance, such techniques might be useful. - * <p/> * An efficient, effective "more-like-this" query generator would be a great contribution, if * anyone's interested. I'd imagine that it would take a Reader or a String (the document's * text), analyzer Analyzer, and return a set of representative terms using heuristics like those * above. The frequency and length thresholds could be parameters, etc. - * <p/> * Doug - * </pre></code> - * <p/> - * <p/> - * <p/> + * </pre> * <h3>Initial Usage</h3> - * <p/> + * <p> * This class has lots of options to try to make it efficient and flexible. * The simplest possible usage is as follows. The bold * fragment is specific to this class. - * <p/> * <pre class="prettyprint"> - * <p/> * IndexReader ir = ... * IndexSearcher is = ... - * <p/> + * MoreLikeThis mlt = new MoreLikeThis(ir); * Reader target = ... // orig source of doc you want to find similarities to * Query query = mlt.like( target); - * <p/> + * Hits hits = is.search(query); * // now the usual iteration thru 'hits' - the only thing to watch for is to make sure * //you ignore the doc if it matches your 'target' document, as it should be similar to itself - * <p/> + * </pre> - * <p/> + * <p> * Thus you: * <ol> * <li> do your normal, Lucene setup for searching, @@ -116,13 +107,11 @@ import java.util.*; * <li> then call one of the like() calls to generate a similarity query * <li> call the searcher to find the similar docs * </ol> - * <p/> * <h3>More Advanced Usage</h3> - * <p/> + * <p> * You may want to use {@link #setFieldNames setFieldNames(...)} so you can examine * multiple fields (e.g. body and title) for similarity. - * <p/> - * <p/> + * <p> * Depending on the size of your index and the size and makeup of your documents you * may want to call the other set methods to control how the similarity queries are * generated: @@ -137,7 +126,6 @@ import java.util.*; * <li> {@link #setMaxNumTokensParsed setMaxNumTokensParsed(...)} * <li> {@link #setStopWords setStopWord(...)} * </ul> - * <p/> * <hr> * <pre> * Changes: Mark Harwood 29/02/04 @@ -702,7 +690,7 @@ public final class XMoreLikeThis { } /** - * Create a PriorityQueue from a word->tf map. + * Create a PriorityQueue from a word->tf map. * * @param words a map of words keyed on the word(String) with Int objects as the values. */ @@ -711,7 +699,7 @@ public final class XMoreLikeThis { } /** - * Create a PriorityQueue from a word->tf map. + * Create a PriorityQueue from a word->tf map. * * @param words a map of words keyed on the word(String) with Int objects as the values. * @param fieldNames an array of field names to override defaults. diff --git a/core/src/main/java/org/elasticsearch/common/lucene/search/function/RandomScoreFunction.java b/core/src/main/java/org/elasticsearch/common/lucene/search/function/RandomScoreFunction.java index a95f24eee9..bc1962ad0b 100644 --- a/core/src/main/java/org/elasticsearch/common/lucene/search/function/RandomScoreFunction.java +++ b/core/src/main/java/org/elasticsearch/common/lucene/search/function/RandomScoreFunction.java @@ -26,7 +26,7 @@ import org.elasticsearch.index.fielddata.IndexFieldData; import org.elasticsearch.index.fielddata.SortedBinaryDocValues; /** - * Pseudo randomly generate a score for each {@link #score}. + * Pseudo randomly generate a score for each {@link LeafScoreFunction#score}. */ public class RandomScoreFunction extends ScoreFunction { diff --git a/core/src/main/java/org/elasticsearch/common/metrics/EWMA.java b/core/src/main/java/org/elasticsearch/common/metrics/EWMA.java index a4d06af2ff..b0cfd1bebc 100644 --- a/core/src/main/java/org/elasticsearch/common/metrics/EWMA.java +++ b/core/src/main/java/org/elasticsearch/common/metrics/EWMA.java @@ -28,7 +28,7 @@ import java.util.concurrent.TimeUnit; * * @see <a href="http://www.teamquest.com/pdfs/whitepaper/ldavg1.pdf">UNIX Load Average Part 1: How It Works</a> * @see <a href="http://www.teamquest.com/pdfs/whitepaper/ldavg2.pdf">UNIX Load Average Part 2: Not Your Average Average</a> - * <p/> + * <p> * Taken from codahale metric module, changed to use LongAdder */ public class EWMA { diff --git a/core/src/main/java/org/elasticsearch/common/metrics/MeterMetric.java b/core/src/main/java/org/elasticsearch/common/metrics/MeterMetric.java index 531e0e9bae..4bd995c429 100644 --- a/core/src/main/java/org/elasticsearch/common/metrics/MeterMetric.java +++ b/core/src/main/java/org/elasticsearch/common/metrics/MeterMetric.java @@ -31,7 +31,7 @@ import java.util.concurrent.TimeUnit; * fifteen-minute exponentially-weighted moving average throughputs. * * @see <a href="http://en.wikipedia.org/wiki/Moving_average#Exponential_moving_average">EMA</a> - * <p/> + * <p> * taken from codahale metric module, replaced with LongAdder */ public class MeterMetric implements Metric { diff --git a/core/src/main/java/org/elasticsearch/common/netty/NettyUtils.java b/core/src/main/java/org/elasticsearch/common/netty/NettyUtils.java index b33ed2b7b3..164ed57e26 100644 --- a/core/src/main/java/org/elasticsearch/common/netty/NettyUtils.java +++ b/core/src/main/java/org/elasticsearch/common/netty/NettyUtils.java @@ -32,43 +32,43 @@ public class NettyUtils { /** * Here we go.... - * <p/> + * <p> * When using the socket or file channel API to write or read using heap ByteBuffer, the sun.nio * package will convert it to a direct buffer before doing the actual operation. The direct buffer is * cached on an array of buffers under the nio.ch.Util$BufferCache on a thread local. - * <p/> + * <p> * In netty specifically, if we send a single ChannelBuffer that is bigger than * SocketSendBufferPool#DEFAULT_PREALLOCATION_SIZE (64kb), it will just convert the ChannelBuffer * to a ByteBuffer and send it. The problem is, that then same size DirectByteBuffer will be * allocated (or reused) and kept around on a thread local in the sun.nio BufferCache. If very * large buffer is sent, imagine a 10mb one, then a 10mb direct buffer will be allocated as an * entry within the thread local buffers. - * <p/> + * <p> * In ES, we try and page the buffers allocated, all serialized data uses {@link org.elasticsearch.common.bytes.PagedBytesReference} * typically generated from {@link org.elasticsearch.common.io.stream.BytesStreamOutput}. When sending it over * to netty, it creates a {@link org.jboss.netty.buffer.CompositeChannelBuffer} that wraps the relevant pages. - * <p/> + * <p> * The idea with the usage of composite channel buffer is that a single large buffer will not be sent over * to the sun.nio layer. But, this will only happen if the composite channel buffer is created with a gathering * flag set to true. In such a case, the GatheringSendBuffer is used in netty, resulting in calling the sun.nio * layer with a ByteBuffer array. - * <p/> + * <p> * This, potentially would have been as disastrous if the sun.nio layer would have tried to still copy over * all of it to a direct buffer. But, the write(ByteBuffer[]) API (see sun.nio.ch.IOUtil), goes one buffer * at a time, and gets a temporary direct buffer from the BufferCache, up to a limit of IOUtil#IOV_MAX (which * is 1024 on most OSes). This means that there will be a max of 1024 direct buffer per thread. - * <p/> + * <p> * This is still less than optimal to be honest, since it means that if not all data was written successfully * (1024 paged buffers), then the rest of the data will need to be copied over again to the direct buffer * and re-transmitted, but its much better than trying to send the full large buffer over and over again. - * <p/> + * <p> * In ES, we use by default, in our paged data structures, a page of 16kb, so this is not so terrible. - * <p/> + * <p> * Note, on the read size of netty, it uses a single direct buffer that is defined in both the transport * and http configuration (based on the direct memory available), and the upstream handlers (SizeHeaderFrameDecoder, * or more specifically the FrameDecoder base class) makes sure to use a cumulation buffer and not copy it * over all the time. - * <p/> + * <p> * TODO: potentially, a more complete solution would be to write a netty channel handler that is the last * in the pipeline, and if the buffer is composite, verifies that its a gathering one with reasonable * sized pages, and if its a single one, makes sure that it gets sliced and wrapped in a composite diff --git a/core/src/main/java/org/elasticsearch/common/property/PropertyPlaceholder.java b/core/src/main/java/org/elasticsearch/common/property/PropertyPlaceholder.java index 11f7d8b67c..a210f3ae6d 100644 --- a/core/src/main/java/org/elasticsearch/common/property/PropertyPlaceholder.java +++ b/core/src/main/java/org/elasticsearch/common/property/PropertyPlaceholder.java @@ -30,8 +30,8 @@ import java.util.Set; * Utility class for working with Strings that have placeholder values in them. A placeholder takes the form * <tt>${name}</tt>. Using <tt>PropertyPlaceholder</tt> these placeholders can be substituted for * user-supplied values. - * <p/> - * <p> Values for substitution can be supplied using a {@link Properties} instance or using a + * <p> + * Values for substitution can be supplied using a {@link Properties} instance or using a * {@link PlaceholderResolver}. */ public class PropertyPlaceholder { diff --git a/core/src/main/java/org/elasticsearch/common/settings/Settings.java b/core/src/main/java/org/elasticsearch/common/settings/Settings.java index 2c2440c254..e36843038d 100644 --- a/core/src/main/java/org/elasticsearch/common/settings/Settings.java +++ b/core/src/main/java/org/elasticsearch/common/settings/Settings.java @@ -511,13 +511,12 @@ public final class Settings implements ToXContent { /** * The values associated with a setting prefix as an array. The settings array is in the format of: * <tt>settingPrefix.[index]</tt>. - * <p/> - * <p>It will also automatically load a comma separated list under the settingPrefix and merge with + * <p> + * It will also automatically load a comma separated list under the settingPrefix and merge with * the numbered format. * * @param settingPrefix The setting prefix to load the array by * @return The setting array values - * @throws org.elasticsearch.common.settings.SettingsException */ public String[] getAsArray(String settingPrefix) throws SettingsException { return getAsArray(settingPrefix, Strings.EMPTY_ARRAY, true); @@ -526,13 +525,12 @@ public final class Settings implements ToXContent { /** * The values associated with a setting prefix as an array. The settings array is in the format of: * <tt>settingPrefix.[index]</tt>. - * <p/> - * <p>If commaDelimited is true, it will automatically load a comma separated list under the settingPrefix and merge with + * <p> + * If commaDelimited is true, it will automatically load a comma separated list under the settingPrefix and merge with * the numbered format. * * @param settingPrefix The setting prefix to load the array by * @return The setting array values - * @throws org.elasticsearch.common.settings.SettingsException */ public String[] getAsArray(String settingPrefix, String[] defaultArray) throws SettingsException { return getAsArray(settingPrefix, defaultArray, true); @@ -541,15 +539,14 @@ public final class Settings implements ToXContent { /** * The values associated with a setting prefix as an array. The settings array is in the format of: * <tt>settingPrefix.[index]</tt>. - * <p/> - * <p>It will also automatically load a comma separated list under the settingPrefix and merge with + * <p> + * It will also automatically load a comma separated list under the settingPrefix and merge with * the numbered format. * * @param settingPrefix The setting prefix to load the array by * @param defaultArray The default array to use if no value is specified * @param commaDelimited Whether to try to parse a string as a comma-delimited value * @return The setting array values - * @throws org.elasticsearch.common.settings.SettingsException */ public String[] getAsArray(String settingPrefix, String[] defaultArray, Boolean commaDelimited) throws SettingsException { List<String> result = new ArrayList<>(); @@ -1122,8 +1119,8 @@ public final class Settings implements ToXContent { /** * Runs across all the settings set on this builder and replaces <tt>${...}</tt> elements in the * each setting value according to the following logic: - * <p/> - * <p>First, tries to resolve it against a System property ({@link System#getProperty(String)}), next, + * <p> + * First, tries to resolve it against a System property ({@link System#getProperty(String)}), next, * tries and resolve it against an environment variable ({@link System#getenv(String)}), and last, tries * and replace it with another setting already set on this builder. */ diff --git a/core/src/main/java/org/elasticsearch/common/settings/SettingsFilter.java b/core/src/main/java/org/elasticsearch/common/settings/SettingsFilter.java index d2bde25133..421e008199 100644 --- a/core/src/main/java/org/elasticsearch/common/settings/SettingsFilter.java +++ b/core/src/main/java/org/elasticsearch/common/settings/SettingsFilter.java @@ -50,8 +50,6 @@ public class SettingsFilter extends AbstractComponent { /** * Adds a new simple pattern to the list of filters - * - * @param pattern */ public void addFilter(String pattern) { patterns.add(pattern); @@ -59,8 +57,6 @@ public class SettingsFilter extends AbstractComponent { /** * Removes a simple pattern from the list of filters - * - * @param pattern */ public void removeFilter(String pattern) { patterns.remove(pattern); diff --git a/core/src/main/java/org/elasticsearch/common/transport/TransportAddressSerializers.java b/core/src/main/java/org/elasticsearch/common/transport/TransportAddressSerializers.java index 9bfbcaaf50..d8e121bec9 100644 --- a/core/src/main/java/org/elasticsearch/common/transport/TransportAddressSerializers.java +++ b/core/src/main/java/org/elasticsearch/common/transport/TransportAddressSerializers.java @@ -33,8 +33,8 @@ import static org.elasticsearch.common.collect.MapBuilder.newMapBuilder; /** * A global registry of all different types of {@link org.elasticsearch.common.transport.TransportAddress} allowing * to perform serialization of them. - * <p/> - * <p>By default, adds {@link org.elasticsearch.common.transport.InetSocketTransportAddress}. + * <p> + * By default, adds {@link org.elasticsearch.common.transport.InetSocketTransportAddress}. * * */ diff --git a/core/src/main/java/org/elasticsearch/common/unit/DistanceUnit.java b/core/src/main/java/org/elasticsearch/common/unit/DistanceUnit.java index cb89ca83d5..9abce6989f 100644 --- a/core/src/main/java/org/elasticsearch/common/unit/DistanceUnit.java +++ b/core/src/main/java/org/elasticsearch/common/unit/DistanceUnit.java @@ -214,7 +214,6 @@ public enum DistanceUnit { * * @param out {@link StreamOutput} to write to * @param unit {@link DistanceUnit} to write - * @throws IOException */ public static void writeDistanceUnit(StreamOutput out, DistanceUnit unit) throws IOException { out.writeByte((byte) unit.ordinal()); diff --git a/core/src/main/java/org/elasticsearch/common/util/BigArrays.java b/core/src/main/java/org/elasticsearch/common/util/BigArrays.java index 0f0bced9cf..faa377bacc 100644 --- a/core/src/main/java/org/elasticsearch/common/util/BigArrays.java +++ b/core/src/main/java/org/elasticsearch/common/util/BigArrays.java @@ -494,7 +494,7 @@ public class BigArrays { return resize(array, newSize); } - /** @see Arrays.hashCode(byte[]) */ + /** @see Arrays#hashCode(byte[]) */ public int hashCode(ByteArray array) { if (array == null) { return 0; @@ -508,7 +508,7 @@ public class BigArrays { return hash; } - /** @see Arrays.equals(byte[], byte[]) */ + /** @see Arrays#equals(byte[], byte[]) */ public boolean equals(ByteArray array, ByteArray other) { if (array == other) { return true; diff --git a/core/src/main/java/org/elasticsearch/common/util/BloomFilter.java b/core/src/main/java/org/elasticsearch/common/util/BloomFilter.java index 360bd39e80..b19d727f02 100644 --- a/core/src/main/java/org/elasticsearch/common/util/BloomFilter.java +++ b/core/src/main/java/org/elasticsearch/common/util/BloomFilter.java @@ -285,7 +285,7 @@ public class BloomFilter { /** * Computes the optimal k (number of hashes per element inserted in Bloom filter), given the * expected insertions and total number of bits in the Bloom filter. - * <p/> + * <p> * See http://en.wikipedia.org/wiki/File:Bloom_filter_fp_probability.svg for the formula. * * @param n expected insertions (must be positive) @@ -298,11 +298,11 @@ public class BloomFilter { /** * Computes m (total bits of Bloom filter) which is expected to achieve, for the specified * expected insertions, the required false positive probability. - * <p/> + * <p> * See http://en.wikipedia.org/wiki/Bloom_filter#Probability_of_false_positives for the formula. * * @param n expected insertions (must be positive) - * @param p false positive rate (must be 0 < p < 1) + * @param p false positive rate (must be 0 < p < 1) */ static long optimalNumOfBits(long n, double p) { if (p == 0) { diff --git a/core/src/main/java/org/elasticsearch/common/util/BytesRefHash.java b/core/src/main/java/org/elasticsearch/common/util/BytesRefHash.java index 3e5dac597c..5a2e21e5e1 100644 --- a/core/src/main/java/org/elasticsearch/common/util/BytesRefHash.java +++ b/core/src/main/java/org/elasticsearch/common/util/BytesRefHash.java @@ -61,8 +61,8 @@ public final class BytesRefHash extends AbstractHash { } /** - * Return the key at <code>0 <e; index <e; capacity()</code>. The result is undefined if the slot is unused. - * <p color="red">Beware that the content of the {@link BytesRef} may become invalid as soon as {@link #close()} is called</p> + * Return the key at <code>0 <= index <= capacity()</code>. The result is undefined if the slot is unused. + * <p>Beware that the content of the {@link BytesRef} may become invalid as soon as {@link #close()} is called</p> */ public BytesRef get(long id, BytesRef dest) { final long startOffset = startOffsets.get(id); @@ -135,7 +135,7 @@ public final class BytesRefHash extends AbstractHash { } /** - * Try to add <code>key</code>. Return its newly allocated id if it wasn't in the hash table yet, or </code>-1-id</code> + * Try to add <code>key</code>. Return its newly allocated id if it wasn't in the hash table yet, or <code>-1-id</code> * if it was already present in the hash table. */ public long add(BytesRef key, int code) { diff --git a/core/src/main/java/org/elasticsearch/common/util/CancellableThreads.java b/core/src/main/java/org/elasticsearch/common/util/CancellableThreads.java index 67b844bf7a..781218c661 100644 --- a/core/src/main/java/org/elasticsearch/common/util/CancellableThreads.java +++ b/core/src/main/java/org/elasticsearch/common/util/CancellableThreads.java @@ -53,7 +53,7 @@ public class CancellableThreads { * the default implementation always throws an {@link ExecutionCancelledException}, suppressing * any other exception that occurred before cancellation * - * @param reason reason for failure supplied by the caller of {@link @cancel} + * @param reason reason for failure supplied by the caller of {@link #cancel} * @param suppressedException any error that was encountered during the execution before the operation was cancelled. */ protected void onCancel(String reason, @Nullable Throwable suppressedException) { diff --git a/core/src/main/java/org/elasticsearch/common/util/ExtensionPoint.java b/core/src/main/java/org/elasticsearch/common/util/ExtensionPoint.java index a5878e1c42..056142a48c 100644 --- a/core/src/main/java/org/elasticsearch/common/util/ExtensionPoint.java +++ b/core/src/main/java/org/elasticsearch/common/util/ExtensionPoint.java @@ -218,7 +218,7 @@ public abstract class ExtensionPoint { } /** - * Registers a mapping from {@param key} to {@param value} + * Registers a mapping from {@code key} to {@code value} * * @throws IllegalArgumentException iff the key is already registered */ diff --git a/core/src/main/java/org/elasticsearch/common/util/LongHash.java b/core/src/main/java/org/elasticsearch/common/util/LongHash.java index ef82566303..9f19e6cf8e 100644 --- a/core/src/main/java/org/elasticsearch/common/util/LongHash.java +++ b/core/src/main/java/org/elasticsearch/common/util/LongHash.java @@ -45,7 +45,7 @@ public final class LongHash extends AbstractHash { } /** - * Return the key at <code>0 <e; index <e; capacity()</code>. The result is undefined if the slot is unused. + * Return the key at <code>0 <= index <= capacity()</code>. The result is undefined if the slot is unused. */ public long get(long id) { return keys.get(id); @@ -98,7 +98,7 @@ public final class LongHash extends AbstractHash { } /** - * Try to add <code>key</code>. Return its newly allocated id if it wasn't in the hash table yet, or </code>-1-id</code> + * Try to add <code>key</code>. Return its newly allocated id if it wasn't in the hash table yet, or <code>-1-id</code> * if it was already present in the hash table. */ public long add(long key) { diff --git a/core/src/main/java/org/elasticsearch/common/util/URIPattern.java b/core/src/main/java/org/elasticsearch/common/util/URIPattern.java index 0b9bb22252..13337ff084 100644 --- a/core/src/main/java/org/elasticsearch/common/util/URIPattern.java +++ b/core/src/main/java/org/elasticsearch/common/util/URIPattern.java @@ -37,7 +37,6 @@ public class URIPattern { /** * Constructs uri pattern - * @param pattern */ public URIPattern(String pattern) { try { diff --git a/core/src/main/java/org/elasticsearch/common/util/concurrent/BaseFuture.java b/core/src/main/java/org/elasticsearch/common/util/concurrent/BaseFuture.java index ae806713bf..cd5789f5d7 100644 --- a/core/src/main/java/org/elasticsearch/common/util/concurrent/BaseFuture.java +++ b/core/src/main/java/org/elasticsearch/common/util/concurrent/BaseFuture.java @@ -33,22 +33,22 @@ import java.util.concurrent.locks.AbstractQueuedSynchronizer; * {@code Runnable}. (If you want a {@code Runnable} implementation of {@code * ListenableFuture}, create a {@link com.google.common.util.concurrent.ListenableFutureTask}, or submit your * tasks to a {@link com.google.common.util.concurrent.ListeningExecutorService}.) - * <p/> - * <p>This class implements all methods in {@code ListenableFuture}. + * <p> + * This class implements all methods in {@code ListenableFuture}. * Subclasses should provide a way to set the result of the computation through * the protected methods {@link #set(Object)} and * {@link #setException(Throwable)}. Subclasses may also override {@link * #interruptTask()}, which will be invoked automatically if a call to {@link * #cancel(boolean) cancel(true)} succeeds in canceling the future. - * <p/> - * <p>{@code AbstractFuture} uses an {@link AbstractQueuedSynchronizer} to deal + * <p> + * {@code AbstractFuture} uses an {@link AbstractQueuedSynchronizer} to deal * with concurrency issues and guarantee thread safety. - * <p/> - * <p>The state changing methods all return a boolean indicating success or + * <p> + * The state changing methods all return a boolean indicating success or * failure in changing the future's state. Valid states are running, * completed, failed, or cancelled. - * <p/> - * <p>This class uses an {@link com.google.common.util.concurrent.ExecutionList} to guarantee that all registered + * <p> + * This class uses an {@link com.google.common.util.concurrent.ExecutionList} to guarantee that all registered * listeners will be executed, either when the future finishes or, for listeners * that are added after the future completes, immediately. * {@code Runnable}-{@code Executor} pairs are stored in the execution list but @@ -77,8 +77,8 @@ public abstract class BaseFuture<V> implements Future<V> { /** * {@inheritDoc} - * <p/> - * <p>The default {@link BaseFuture} implementation throws {@code + * <p> + * The default {@link BaseFuture} implementation throws {@code * InterruptedException} if the current thread is interrupted before or during * the call, even if the value is already available. * @@ -100,8 +100,8 @@ public abstract class BaseFuture<V> implements Future<V> { /** * {@inheritDoc} - * <p/> - * <p>The default {@link BaseFuture} implementation throws {@code + * <p> + * The default {@link BaseFuture} implementation throws {@code * InterruptedException} if the current thread is interrupted before or during * the call, even if the value is already available. * @@ -141,8 +141,8 @@ public abstract class BaseFuture<V> implements Future<V> { * Subclasses can override this method to implement interruption of the * future's computation. The method is invoked automatically by a successful * call to {@link #cancel(boolean) cancel(true)}. - * <p/> - * <p>The default implementation does nothing. + * <p> + * The default implementation does nothing. * * @since 10.0 */ @@ -203,13 +203,13 @@ public abstract class BaseFuture<V> implements Future<V> { * in a thread-safe manner. The current state of the future is held in the * Sync state, and the lock is released whenever the state changes to either * {@link #COMPLETED} or {@link #CANCELLED}. - * <p/> - * <p>To avoid races between threads doing release and acquire, we transition + * <p> + * To avoid races between threads doing release and acquire, we transition * to the final state in two steps. One thread will successfully CAS from * RUNNING to COMPLETING, that thread will then set the result of the * computation, and only then transition to COMPLETED or CANCELLED. - * <p/> - * <p>We don't use the integer argument passed between acquire methods so we + * <p> + * We don't use the integer argument passed between acquire methods so we * pass around a -1 everywhere. */ static final class Sync<V> extends AbstractQueuedSynchronizer { diff --git a/core/src/main/java/org/elasticsearch/common/util/concurrent/PrioritizedEsThreadPoolExecutor.java b/core/src/main/java/org/elasticsearch/common/util/concurrent/PrioritizedEsThreadPoolExecutor.java index aad6cee12f..d0d2906dee 100644 --- a/core/src/main/java/org/elasticsearch/common/util/concurrent/PrioritizedEsThreadPoolExecutor.java +++ b/core/src/main/java/org/elasticsearch/common/util/concurrent/PrioritizedEsThreadPoolExecutor.java @@ -38,7 +38,7 @@ import java.util.concurrent.atomic.AtomicLong; * A prioritizing executor which uses a priority queue as a work queue. The jobs that will be submitted will be treated * as {@link PrioritizedRunnable} and/or {@link PrioritizedCallable}, those tasks that are not instances of these two will * be wrapped and assign a default {@link Priority#NORMAL} priority. - * <p/> + * <p> * Note, if two tasks have the same priority, the first to arrive will be executed first (FIFO style). */ public class PrioritizedEsThreadPoolExecutor extends EsThreadPoolExecutor { diff --git a/core/src/main/java/org/elasticsearch/common/util/concurrent/ThreadBarrier.java b/core/src/main/java/org/elasticsearch/common/util/concurrent/ThreadBarrier.java index 1892aa7696..a3d10ff825 100644 --- a/core/src/main/java/org/elasticsearch/common/util/concurrent/ThreadBarrier.java +++ b/core/src/main/java/org/elasticsearch/common/util/concurrent/ThreadBarrier.java @@ -32,12 +32,12 @@ import java.util.concurrent.TimeoutException; * <code>ThreadBarrier</code> adds a <i>cause</i> to * {@link BrokenBarrierException} thrown by a {@link #reset()} operation defined * by {@link CyclicBarrier}. - * <p/> - * <p/> + * <p> * <b>Sample usage:</b> <br> - * <li>Barrier as a synchronization and Exception handling aid </li> - * <li>Barrier as a trigger for elapsed notification events </li> - * <p/> + * <ul> + * <li>Barrier as a synchronization and Exception handling aid </li> + * <li>Barrier as a trigger for elapsed notification events </li> + * </ul> * <pre> * class MyTestClass implements RemoteEventListener * { @@ -86,7 +86,7 @@ import java.util.concurrent.TimeoutException; * * // too many notifications? * Assert.assertFalse("Exceeded notification count", - * actualNotificationCount > EXPECTED_COUNT); + * actualNotificationCount > EXPECTED_COUNT); * } * catch(Throwable t) { * log("Worker thread caught exception", t); @@ -211,7 +211,7 @@ public class ThreadBarrier extends CyclicBarrier { /** * breaks this barrier if it has been reset or broken for any other reason. - * <p/> + * <p> * Note: This call is not atomic in respect to await/reset calls. A * breakIfBroken() may be context switched to invoke a reset() prior to * await(). This resets the barrier to its initial state - parties not @@ -244,7 +244,7 @@ public class ThreadBarrier extends CyclicBarrier { * Measurement. * * @see ThreadBarrier#ThreadBarrier(int, Runnable) - * <p/> + * <p> * <B>Usage example:</B><br> * <pre><code> * BarrierTimer timer = new BarrierTimer(); diff --git a/core/src/main/java/org/elasticsearch/common/xcontent/XContentParser.java b/core/src/main/java/org/elasticsearch/common/xcontent/XContentParser.java index a6b4f460f4..9c95413d5b 100644 --- a/core/src/main/java/org/elasticsearch/common/xcontent/XContentParser.java +++ b/core/src/main/java/org/elasticsearch/common/xcontent/XContentParser.java @@ -217,28 +217,28 @@ public interface XContentParser extends Releasable { /** * Reads a plain binary value that was written via one of the following methods: * - * <li> - * <ul>{@link XContentBuilder#field(String, org.apache.lucene.util.BytesRef)}</ul> - * <ul>{@link XContentBuilder#field(String, org.elasticsearch.common.bytes.BytesReference)}</ul> - * <ul>{@link XContentBuilder#field(String, byte[], int, int)}}</ul> - * <ul>{@link XContentBuilder#field(String, byte[])}}</ul> - * </li> + * <ul> + * <li>{@link XContentBuilder#field(String, org.apache.lucene.util.BytesRef)}</li> + * <li>{@link XContentBuilder#field(String, org.elasticsearch.common.bytes.BytesReference)}</li> + * <li>{@link XContentBuilder#field(String, byte[], int, int)}}</li> + * <li>{@link XContentBuilder#field(String, byte[])}}</li> + * </ul> * * as well as via their <code>XContentBuilderString</code> variants of the separated value methods. * Note: Do not use this method to read values written with: - * <li> - * <ul>{@link XContentBuilder#utf8Field(XContentBuilderString, org.apache.lucene.util.BytesRef)}</ul> - * <ul>{@link XContentBuilder#utf8Field(String, org.apache.lucene.util.BytesRef)}</ul> - * </li> + * <ul> + * <li>{@link XContentBuilder#utf8Field(XContentBuilderString, org.apache.lucene.util.BytesRef)}</li> + * <li>{@link XContentBuilder#utf8Field(String, org.apache.lucene.util.BytesRef)}</li> + * </ul> * * these methods write UTF-8 encoded strings and must be read through: - * <li> - * <ul>{@link XContentParser#utf8Bytes()}</ul> - * <ul>{@link XContentParser#utf8BytesOrNull()}}</ul> - * <ul>{@link XContentParser#text()} ()}</ul> - * <ul>{@link XContentParser#textOrNull()} ()}</ul> - * <ul>{@link XContentParser#textCharacters()} ()}}</ul> - * </li> + * <ul> + * <li>{@link XContentParser#utf8Bytes()}</li> + * <li>{@link XContentParser#utf8BytesOrNull()}}</li> + * <li>{@link XContentParser#text()} ()}</li> + * <li>{@link XContentParser#textOrNull()} ()}</li> + * <li>{@link XContentParser#textCharacters()} ()}}</li> + * </ul> * */ byte[] binaryValue() throws IOException; diff --git a/core/src/main/java/org/elasticsearch/common/xcontent/support/filtering/FilterContext.java b/core/src/main/java/org/elasticsearch/common/xcontent/support/filtering/FilterContext.java index 215af370b3..66f20cce43 100644 --- a/core/src/main/java/org/elasticsearch/common/xcontent/support/filtering/FilterContext.java +++ b/core/src/main/java/org/elasticsearch/common/xcontent/support/filtering/FilterContext.java @@ -198,9 +198,6 @@ public class FilterContext { /** * Ensure that the full path to the current field is write by the JsonGenerator - * - * @param generator - * @throws IOException */ public void writePath(JsonGenerator generator) throws IOException { if (parent != null) { diff --git a/core/src/main/java/org/elasticsearch/discovery/BlockingClusterStatePublishResponseHandler.java b/core/src/main/java/org/elasticsearch/discovery/BlockingClusterStatePublishResponseHandler.java index 40aca3fe35..3fe99face5 100644 --- a/core/src/main/java/org/elasticsearch/discovery/BlockingClusterStatePublishResponseHandler.java +++ b/core/src/main/java/org/elasticsearch/discovery/BlockingClusterStatePublishResponseHandler.java @@ -71,7 +71,6 @@ public class BlockingClusterStatePublishResponseHandler { * Allows to wait for all non master nodes to reply to the publish event up to a timeout * @param timeout the timeout * @return true if the timeout expired or not, false otherwise - * @throws InterruptedException */ public boolean awaitAllNodes(TimeValue timeout) throws InterruptedException { boolean success = latch.await(timeout.millis(), TimeUnit.MILLISECONDS); diff --git a/core/src/main/java/org/elasticsearch/discovery/DiscoveryService.java b/core/src/main/java/org/elasticsearch/discovery/DiscoveryService.java index c86033b85d..9a8b19e371 100644 --- a/core/src/main/java/org/elasticsearch/discovery/DiscoveryService.java +++ b/core/src/main/java/org/elasticsearch/discovery/DiscoveryService.java @@ -127,7 +127,7 @@ public class DiscoveryService extends AbstractLifecycleComponent<DiscoveryServic /** * Publish all the changes to the cluster from the master (can be called just by the master). The publish * process should not publish this state to the master as well! (the master is sending it...). - * <p/> + * <p> * The {@link org.elasticsearch.discovery.Discovery.AckListener} allows to acknowledge the publish * event based on the response gotten from all nodes */ diff --git a/core/src/main/java/org/elasticsearch/discovery/InitialStateDiscoveryListener.java b/core/src/main/java/org/elasticsearch/discovery/InitialStateDiscoveryListener.java index 8488488294..1ec55c874b 100644 --- a/core/src/main/java/org/elasticsearch/discovery/InitialStateDiscoveryListener.java +++ b/core/src/main/java/org/elasticsearch/discovery/InitialStateDiscoveryListener.java @@ -22,8 +22,8 @@ package org.elasticsearch.discovery; /** * A listener that should be called by the {@link org.elasticsearch.discovery.Discovery} component * when the first valid initial cluster state has been submitted and processed by the cluster service. - * <p/> - * <p>Note, this listener should be registered with the discovery service before it has started. + * <p> + * Note, this listener should be registered with the discovery service before it has started. * * */ diff --git a/core/src/main/java/org/elasticsearch/discovery/zen/NodeJoinController.java b/core/src/main/java/org/elasticsearch/discovery/zen/NodeJoinController.java index 8fc623a3a2..6aa6ac5e5f 100644 --- a/core/src/main/java/org/elasticsearch/discovery/zen/NodeJoinController.java +++ b/core/src/main/java/org/elasticsearch/discovery/zen/NodeJoinController.java @@ -68,9 +68,9 @@ public class NodeJoinController extends AbstractComponent { /** * waits for enough incoming joins from master eligible nodes to complete the master election - * <p/> + * <p> * You must start accumulating joins before calling this method. See {@link #startAccumulatingJoins()} - * <p/> + * <p> * The method will return once the local node has been elected as master or some failure/timeout has happened. * The exact outcome is communicated via the callback parameter, which is guaranteed to be called. * @@ -175,7 +175,7 @@ public class NodeJoinController extends AbstractComponent { /** * processes or queues an incoming join request. - * <p/> + * <p> * Note: doesn't do any validation. This should have been done before. */ public void handleJoinRequest(final DiscoveryNode node, final MembershipAction.JoinCallback callback) { @@ -436,4 +436,4 @@ public class NodeJoinController extends AbstractComponent { } } } -}
\ No newline at end of file +} diff --git a/core/src/main/java/org/elasticsearch/discovery/zen/elect/ElectMasterService.java b/core/src/main/java/org/elasticsearch/discovery/zen/elect/ElectMasterService.java index 80b3ec0f4e..9164a85388 100644 --- a/core/src/main/java/org/elasticsearch/discovery/zen/elect/ElectMasterService.java +++ b/core/src/main/java/org/elasticsearch/discovery/zen/elect/ElectMasterService.java @@ -98,8 +98,6 @@ public class ElectMasterService extends AbstractComponent { /** * Returns the given nodes sorted by likelyhood of being elected as master, most likely first. * Non-master nodes are not removed but are rather put in the end - * @param nodes - * @return */ public List<DiscoveryNode> sortByMasterLikelihood(Iterable<DiscoveryNode> nodes) { ArrayList<DiscoveryNode> sortedNodes = CollectionUtils.iterableAsArrayList(nodes); diff --git a/core/src/main/java/org/elasticsearch/discovery/zen/fd/FaultDetection.java b/core/src/main/java/org/elasticsearch/discovery/zen/fd/FaultDetection.java index d3e644f216..436ef6bc2b 100644 --- a/core/src/main/java/org/elasticsearch/discovery/zen/fd/FaultDetection.java +++ b/core/src/main/java/org/elasticsearch/discovery/zen/fd/FaultDetection.java @@ -30,7 +30,7 @@ import org.elasticsearch.transport.TransportService; import static org.elasticsearch.common.unit.TimeValue.timeValueSeconds; /** - * A base class for {@link org.elasticsearch.discovery.zen.fd.MasterFaultDetection} & {@link org.elasticsearch.discovery.zen.fd.NodesFaultDetection}, + * A base class for {@link org.elasticsearch.discovery.zen.fd.MasterFaultDetection} & {@link org.elasticsearch.discovery.zen.fd.NodesFaultDetection}, * making sure both use the same setting. */ public abstract class FaultDetection extends AbstractComponent { diff --git a/core/src/main/java/org/elasticsearch/discovery/zen/publish/PendingClusterStatesQueue.java b/core/src/main/java/org/elasticsearch/discovery/zen/publish/PendingClusterStatesQueue.java index fc894f3d07..e3550e657f 100644 --- a/core/src/main/java/org/elasticsearch/discovery/zen/publish/PendingClusterStatesQueue.java +++ b/core/src/main/java/org/elasticsearch/discovery/zen/publish/PendingClusterStatesQueue.java @@ -31,10 +31,10 @@ import java.util.Objects; * A queue that holds all "in-flight" incoming cluster states from the master. Once a master commits a cluster * state, it is made available via {@link #getNextClusterStateToProcess()}. The class also takes care of batching * cluster states for processing and failures. - * <p/> + * <p> * The queue is bound by {@link #maxQueueSize}. When the queue is at capacity and a new cluster state is inserted * the oldest cluster state will be dropped. This is safe because: - * 1) Under normal operations, master will publish & commit a cluster state before processing another change (i.e., the queue length is 1) + * 1) Under normal operations, master will publish & commit a cluster state before processing another change (i.e., the queue length is 1) * 2) If the master fails to commit a change, it will step down, causing a master election, which will flush the queue. * 3) In general it's safe to process the incoming cluster state as a replacement to the cluster state that's dropped. * a) If the dropped cluster is from the same master as the incoming one is, it is likely to be superseded by the incoming state (or another state in the queue). @@ -42,7 +42,7 @@ import java.util.Objects; * b) If the dropping cluster state is not from the same master, it means that: * i) we are no longer following the master of the dropped cluster state but follow the incoming one * ii) we are no longer following any master, in which case it doesn't matter which cluster state will be processed first. - * <p/> + * <p> * The class is fully thread safe and can be used concurrently. */ public class PendingClusterStatesQueue { @@ -130,7 +130,7 @@ public class PendingClusterStatesQueue { /** * indicates that a cluster state was successfully processed. Any committed state that is {@link ClusterState#supersedes(ClusterState)}-ed * by the processed state will be marked as processed as well. - * <p/> + * <p> * NOTE: successfully processing a state indicates we are following the master it came from. Any committed state from another master will * be failed by this method */ @@ -204,7 +204,7 @@ public class PendingClusterStatesQueue { /** * Gets the next committed state to process. - * <p/> + * <p> * The method tries to batch operation by getting the cluster state the highest possible committed states * which succeeds the first committed state in queue (i.e., it comes from the same master). */ diff --git a/core/src/main/java/org/elasticsearch/discovery/zen/publish/PublishClusterStateAction.java b/core/src/main/java/org/elasticsearch/discovery/zen/publish/PublishClusterStateAction.java index 9d31b2d1b4..a8c2952301 100644 --- a/core/src/main/java/org/elasticsearch/discovery/zen/publish/PublishClusterStateAction.java +++ b/core/src/main/java/org/elasticsearch/discovery/zen/publish/PublishClusterStateAction.java @@ -96,8 +96,8 @@ public class PublishClusterStateAction extends AbstractComponent { /** * publishes a cluster change event to other nodes. if at least minMasterNodes acknowledge the change it is committed and will * be processed by the master and the other nodes. - * <p/> - * The method is guaranteed to throw a {@link Discovery.FailedToCommitClusterStateException} if the change is not committed and should be rejected. + * <p> + * The method is guaranteed to throw a {@link org.elasticsearch.discovery.Discovery.FailedToCommitClusterStateException} if the change is not committed and should be rejected. * Any other exception signals the something wrong happened but the change is committed. */ public void publish(final ClusterChangedEvent clusterChangedEvent, final int minMasterNodes, final Discovery.AckListener ackListener) throws Discovery.FailedToCommitClusterStateException { @@ -606,4 +606,4 @@ public class PublishClusterStateAction extends AbstractComponent { publishingTimedOut.set(isTimedOut); } } -}
\ No newline at end of file +} diff --git a/core/src/main/java/org/elasticsearch/env/NodeEnvironment.java b/core/src/main/java/org/elasticsearch/env/NodeEnvironment.java index 7fe71d8535..41f209b8ea 100644 --- a/core/src/main/java/org/elasticsearch/env/NodeEnvironment.java +++ b/core/src/main/java/org/elasticsearch/env/NodeEnvironment.java @@ -377,7 +377,7 @@ public class NodeEnvironment extends AbstractComponent implements Closeable { * @param index the index to delete * @param lockTimeoutMS how long to wait for acquiring the indices shard locks * @param indexSettings settings for the index being deleted - * @throws Exception if any of the shards data directories can't be locked or deleted + * @throws IOException if any of the shards data directories can't be locked or deleted */ public void deleteIndexDirectorySafe(Index index, long lockTimeoutMS, @IndexSettings Settings indexSettings) throws IOException { // This is to ensure someone doesn't use Settings.EMPTY diff --git a/core/src/main/java/org/elasticsearch/gateway/AsyncShardFetch.java b/core/src/main/java/org/elasticsearch/gateway/AsyncShardFetch.java index d937fa614e..20a3dd6da6 100644 --- a/core/src/main/java/org/elasticsearch/gateway/AsyncShardFetch.java +++ b/core/src/main/java/org/elasticsearch/gateway/AsyncShardFetch.java @@ -43,7 +43,7 @@ import java.util.*; /** * Allows to asynchronously fetch shard related data from other nodes for allocation, without blocking * the cluster update thread. - * <p/> + * <p> * The async fetch logic maintains a map of which nodes are being fetched from in an async manner, * and once the results are back, it makes sure to schedule a reroute to make sure those results will * be taken into account. @@ -93,7 +93,7 @@ public abstract class AsyncShardFetch<T extends BaseNodeResponse> implements Rel /** * Fetches the data for the relevant shard. If there any ongoing async fetches going on, or new ones have * been initiated by this call, the result will have no data. - * <p/> + * <p> * The ignoreNodes are nodes that are supposed to be ignored for this round, since fetching is async, we need * to keep them around and make sure we add them back when all the responses are fetched and returned. */ diff --git a/core/src/main/java/org/elasticsearch/index/aliases/IndexAliasesService.java b/core/src/main/java/org/elasticsearch/index/aliases/IndexAliasesService.java index fc93153b50..2b519c2b84 100644 --- a/core/src/main/java/org/elasticsearch/index/aliases/IndexAliasesService.java +++ b/core/src/main/java/org/elasticsearch/index/aliases/IndexAliasesService.java @@ -56,8 +56,8 @@ public class IndexAliasesService extends AbstractIndexComponent { /** * Returns the filter associated with listed filtering aliases. - * <p/> - * <p>The list of filtering aliases should be obtained by calling MetaData.filteringAliases. + * <p> + * The list of filtering aliases should be obtained by calling MetaData.filteringAliases. * Returns <tt>null</tt> if no filtering is required.</p> */ public Query aliasFilter(String... aliasNames) { diff --git a/core/src/main/java/org/elasticsearch/index/analysis/AnalysisSettingsRequired.java b/core/src/main/java/org/elasticsearch/index/analysis/AnalysisSettingsRequired.java index 155b78a11d..847752c514 100644 --- a/core/src/main/java/org/elasticsearch/index/analysis/AnalysisSettingsRequired.java +++ b/core/src/main/java/org/elasticsearch/index/analysis/AnalysisSettingsRequired.java @@ -22,11 +22,11 @@ import java.lang.annotation.*; /** * A marker annotation on {@link CharFilterFactory}, {@link AnalyzerProvider}, {@link TokenFilterFactory}, - * or {@link @TokenizerFactory} which will cause the provider/factory to only be created when explicit settings + * or {@link TokenizerFactory} which will cause the provider/factory to only be created when explicit settings * are provided. */ @Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface AnalysisSettingsRequired { -}
\ No newline at end of file +} diff --git a/core/src/main/java/org/elasticsearch/index/analysis/CJKBigramFilterFactory.java b/core/src/main/java/org/elasticsearch/index/analysis/CJKBigramFilterFactory.java index 4b3a1e3bcb..7221c4b12e 100644 --- a/core/src/main/java/org/elasticsearch/index/analysis/CJKBigramFilterFactory.java +++ b/core/src/main/java/org/elasticsearch/index/analysis/CJKBigramFilterFactory.java @@ -34,15 +34,15 @@ import java.util.Set; /** * Factory that creates a {@link CJKBigramFilter} to form bigrams of CJK terms * that are generated from StandardTokenizer or ICUTokenizer. - * <p/> + * <p> * CJK types are set by these tokenizers, but you can also use flags to * explicitly control which of the CJK scripts are turned into bigrams. - * <p/> + * <p> * By default, when a CJK character has no adjacent characters to form a bigram, * it is output in unigram form. If you want to always output both unigrams and * bigrams, set the <code>outputUnigrams</code> flag. This can be used for a * combined unigram+bigram approach. - * <p/> + * <p> * In all cases, all non-CJK input is passed thru unmodified. */ public final class CJKBigramFilterFactory extends AbstractTokenFilterFactory { diff --git a/core/src/main/java/org/elasticsearch/index/analysis/KeepTypesFilterFactory.java b/core/src/main/java/org/elasticsearch/index/analysis/KeepTypesFilterFactory.java index 6b8e81f495..9f17dadfeb 100644 --- a/core/src/main/java/org/elasticsearch/index/analysis/KeepTypesFilterFactory.java +++ b/core/src/main/java/org/elasticsearch/index/analysis/KeepTypesFilterFactory.java @@ -33,12 +33,11 @@ import java.util.HashSet; import java.util.Set; /** - * A {@link TokenFilterFactory} for {@link TypeFilter}. This filter only + * A {@link TokenFilterFactory} for {@link TypeTokenFilter}. This filter only * keep tokens that are contained in the set configured via * {@value #KEEP_TYPES_KEY} setting. - * <p/> + * <p> * Configuration options: - * <p/> * <ul> * <li>{@value #KEEP_TYPES_KEY} the array of words / tokens to keep.</li> * </ul> diff --git a/core/src/main/java/org/elasticsearch/index/analysis/KeepWordFilterFactory.java b/core/src/main/java/org/elasticsearch/index/analysis/KeepWordFilterFactory.java index a92ade2467..2c082288ed 100644 --- a/core/src/main/java/org/elasticsearch/index/analysis/KeepWordFilterFactory.java +++ b/core/src/main/java/org/elasticsearch/index/analysis/KeepWordFilterFactory.java @@ -36,20 +36,16 @@ import org.elasticsearch.index.settings.IndexSettings; * keep tokens that are contained in the term set configured via * {@value #KEEP_WORDS_KEY} setting. This filter acts like an inverse stop * filter. - * <p/> + * <p> * Configuration options: - * <p/> * <ul> * <li>{@value #KEEP_WORDS_KEY} the array of words / tokens to keep.</li> - * <p/> * <li>{@value #KEEP_WORDS_PATH_KEY} an reference to a file containing the words * / tokens to keep. Note: this is an alternative to {@value #KEEP_WORDS_KEY} if * both are set an exception will be thrown.</li> - * <p/> * <li>{@value #ENABLE_POS_INC_KEY} <code>true</code> iff the filter should * maintain position increments for dropped tokens. The default is * <code>true</code>.</li> - * <p/> * <li>{@value #KEEP_WORDS_CASE_KEY} to use case sensitive keep words. The * default is <code>false</code> which corresponds to case-sensitive.</li> * </ul> diff --git a/core/src/main/java/org/elasticsearch/index/analysis/SnowballAnalyzer.java b/core/src/main/java/org/elasticsearch/index/analysis/SnowballAnalyzer.java index 76bf8d4265..4ce0bee7a2 100644 --- a/core/src/main/java/org/elasticsearch/index/analysis/SnowballAnalyzer.java +++ b/core/src/main/java/org/elasticsearch/index/analysis/SnowballAnalyzer.java @@ -28,6 +28,7 @@ import org.apache.lucene.analysis.core.LowerCaseFilter; import org.apache.lucene.analysis.core.StopFilter; import org.apache.lucene.analysis.snowball.SnowballFilter; import org.apache.lucene.analysis.standard.StandardTokenizer; +import org.apache.lucene.analysis.standard.StandardFilter; import org.apache.lucene.analysis.standard.std40.StandardTokenizer40; import org.apache.lucene.analysis.util.CharArraySet; import org.apache.lucene.util.Version; @@ -83,4 +84,4 @@ public final class SnowballAnalyzer extends Analyzer { result = new SnowballFilter(result, name); return new TokenStreamComponents(tokenizer, result); } -}
\ No newline at end of file +} diff --git a/core/src/main/java/org/elasticsearch/index/analysis/SnowballAnalyzerProvider.java b/core/src/main/java/org/elasticsearch/index/analysis/SnowballAnalyzerProvider.java index 1d1a9ebb70..39cf56b406 100644 --- a/core/src/main/java/org/elasticsearch/index/analysis/SnowballAnalyzerProvider.java +++ b/core/src/main/java/org/elasticsearch/index/analysis/SnowballAnalyzerProvider.java @@ -39,7 +39,7 @@ import org.elasticsearch.index.settings.IndexSettings; * Stemmer, use them directly with the SnowballFilter and a CustomAnalyzer. * Configuration of language is done with the "language" attribute or the analyzer. * Also supports additional stopwords via "stopwords" attribute - * <p/> + * <p> * The SnowballAnalyzer comes with a StandardFilter, LowerCaseFilter, StopFilter * and the SnowballFilter. * @@ -73,4 +73,4 @@ public class SnowballAnalyzerProvider extends AbstractIndexAnalyzerProvider<Snow public SnowballAnalyzer get() { return this.analyzer; } -}
\ No newline at end of file +} diff --git a/core/src/main/java/org/elasticsearch/index/analysis/StandardHtmlStripAnalyzer.java b/core/src/main/java/org/elasticsearch/index/analysis/StandardHtmlStripAnalyzer.java index 7202f1f94a..a6cfe91cbf 100644 --- a/core/src/main/java/org/elasticsearch/index/analysis/StandardHtmlStripAnalyzer.java +++ b/core/src/main/java/org/elasticsearch/index/analysis/StandardHtmlStripAnalyzer.java @@ -34,8 +34,7 @@ import org.apache.lucene.util.Version; public class StandardHtmlStripAnalyzer extends StopwordAnalyzerBase { /** - * @deprecated use {@link StandardHtmlStripAnalyzer#StandardHtmlStripAnalyzer(org.apache.lucene.util.Version, - * org.apache.lucene.analysis.util.CharArraySet)} instead + * @deprecated use {@link StandardHtmlStripAnalyzer#StandardHtmlStripAnalyzer(CharArraySet)} instead */ @Deprecated public StandardHtmlStripAnalyzer() { @@ -62,4 +61,4 @@ public class StandardHtmlStripAnalyzer extends StopwordAnalyzerBase { return new TokenStreamComponents(src, tok); } -}
\ No newline at end of file +} diff --git a/core/src/main/java/org/elasticsearch/index/cache/bitset/BitsetFilterCache.java b/core/src/main/java/org/elasticsearch/index/cache/bitset/BitsetFilterCache.java index 58768cd08d..30c0905dc0 100644 --- a/core/src/main/java/org/elasticsearch/index/cache/bitset/BitsetFilterCache.java +++ b/core/src/main/java/org/elasticsearch/index/cache/bitset/BitsetFilterCache.java @@ -65,7 +65,7 @@ import java.util.concurrent.*; /** * This is a cache for {@link BitDocIdSet} based filters and is unbounded by size or time. - * <p/> + * <p> * Use this cache with care, only components that require that a filter is to be materialized as a {@link BitDocIdSet} * and require that it should always be around should use this cache, otherwise the * {@link org.elasticsearch.index.cache.query.QueryCache} should be used instead. diff --git a/core/src/main/java/org/elasticsearch/index/cache/query/QueryCacheStats.java b/core/src/main/java/org/elasticsearch/index/cache/query/QueryCacheStats.java index aaf2730a31..947968deab 100644 --- a/core/src/main/java/org/elasticsearch/index/cache/query/QueryCacheStats.java +++ b/core/src/main/java/org/elasticsearch/index/cache/query/QueryCacheStats.java @@ -27,6 +27,8 @@ import org.elasticsearch.common.xcontent.ToXContent; import org.elasticsearch.common.xcontent.XContentBuilder; import org.elasticsearch.common.xcontent.XContentBuilderString; +import org.apache.lucene.search.DocIdSet; + import java.io.IOException; /** diff --git a/core/src/main/java/org/elasticsearch/index/codec/CodecService.java b/core/src/main/java/org/elasticsearch/index/codec/CodecService.java index aa29f79ba7..77d8319b55 100644 --- a/core/src/main/java/org/elasticsearch/index/codec/CodecService.java +++ b/core/src/main/java/org/elasticsearch/index/codec/CodecService.java @@ -34,12 +34,10 @@ import org.elasticsearch.index.settings.IndexSettings; /** * Since Lucene 4.0 low level index segments are read and written through a - * codec layer that allows to use use-case specific file formats & + * codec layer that allows to use use-case specific file formats & * data-structures per field. Elasticsearch exposes the full * {@link Codec} capabilities through this {@link CodecService}. * - * @see PostingsFormatService - * @see DocValuesFormatService */ public class CodecService extends AbstractIndexComponent { diff --git a/core/src/main/java/org/elasticsearch/index/codec/postingsformat/BloomFilterPostingsFormat.java b/core/src/main/java/org/elasticsearch/index/codec/postingsformat/BloomFilterPostingsFormat.java index 9b29c9cc81..71a52a7fbd 100644 --- a/core/src/main/java/org/elasticsearch/index/codec/postingsformat/BloomFilterPostingsFormat.java +++ b/core/src/main/java/org/elasticsearch/index/codec/postingsformat/BloomFilterPostingsFormat.java @@ -39,8 +39,7 @@ import java.util.Map.Entry; * </p> * <p> * This is a special bloom filter version, based on {@link org.elasticsearch.common.util.BloomFilter} and inspired - * by Lucene {@link org.apache.lucene.codecs.bloom.BloomFilteringPostingsFormat}. - * </p> + * by Lucene {@code org.apache.lucene.codecs.bloom.BloomFilteringPostingsFormat}. * @deprecated only for reading old segments */ @Deprecated @@ -67,7 +66,7 @@ public class BloomFilterPostingsFormat extends PostingsFormat { * * @param delegatePostingsFormat The PostingsFormat that records all the non-bloom filter data i.e. * postings info. - * @param bloomFilterFactory The {@link BloomFilter.Factory} responsible for sizing BloomFilters + * @param bloomFilterFactory The {@link org.elasticsearch.common.util.BloomFilter.Factory} responsible for sizing BloomFilters * appropriately */ public BloomFilterPostingsFormat(PostingsFormat delegatePostingsFormat, diff --git a/core/src/main/java/org/elasticsearch/index/engine/Engine.java b/core/src/main/java/org/elasticsearch/index/engine/Engine.java index 92434d340c..0c66b5148c 100644 --- a/core/src/main/java/org/elasticsearch/index/engine/Engine.java +++ b/core/src/main/java/org/elasticsearch/index/engine/Engine.java @@ -1131,7 +1131,6 @@ public abstract class Engine implements Closeable { /** * Returns <code>true</code> the internal writer has any uncommitted changes. Otherwise <code>false</code> - * @return */ public abstract boolean hasUncommittedChanges(); diff --git a/core/src/main/java/org/elasticsearch/index/engine/EngineClosedException.java b/core/src/main/java/org/elasticsearch/index/engine/EngineClosedException.java index ef55708622..062e79eac1 100644 --- a/core/src/main/java/org/elasticsearch/index/engine/EngineClosedException.java +++ b/core/src/main/java/org/elasticsearch/index/engine/EngineClosedException.java @@ -27,8 +27,8 @@ import java.io.IOException; /** * An engine is already closed. - * <p/> - * <p>Note, the relationship between shard and engine indicates that engine closed is shard closed, and + * <p> + * Note, the relationship between shard and engine indicates that engine closed is shard closed, and * we might get something slipping through the the shard and into the engine while the shard is closing. * * diff --git a/core/src/main/java/org/elasticsearch/index/fielddata/FieldData.java b/core/src/main/java/org/elasticsearch/index/fielddata/FieldData.java index 0e286217ab..97750cf069 100644 --- a/core/src/main/java/org/elasticsearch/index/fielddata/FieldData.java +++ b/core/src/main/java/org/elasticsearch/index/fielddata/FieldData.java @@ -218,9 +218,9 @@ public enum FieldData { /** * Returns a single-valued view of the {@link SortedNumericDoubleValues}, - * if it was previously wrapped with {@link #singleton(NumericDocValues, Bits)}, + * if it was previously wrapped with {@link DocValues#singleton(NumericDocValues, Bits)}, * or null. - * @see #unwrapSingletonBits(SortedNumericDocValues) + * @see DocValues#unwrapSingletonBits(SortedNumericDocValues) */ public static NumericDoubleValues unwrapSingleton(SortedNumericDoubleValues values) { if (values instanceof SingletonSortedNumericDoubleValues) { diff --git a/core/src/main/java/org/elasticsearch/index/fielddata/MultiGeoPointValues.java b/core/src/main/java/org/elasticsearch/index/fielddata/MultiGeoPointValues.java index 1d79077abc..6fa9c799dd 100644 --- a/core/src/main/java/org/elasticsearch/index/fielddata/MultiGeoPointValues.java +++ b/core/src/main/java/org/elasticsearch/index/fielddata/MultiGeoPointValues.java @@ -27,7 +27,7 @@ import org.elasticsearch.common.geo.GeoPoint; * GeoPointValues values = ..; * values.setDocId(docId); * final int numValues = values.count(); - * for (int i = 0; i < numValues; i++) { + * for (int i = 0; i < numValues; i++) { * GeoPoint value = values.valueAt(i); * // process value * } diff --git a/core/src/main/java/org/elasticsearch/index/fielddata/ordinals/OrdinalsBuilder.java b/core/src/main/java/org/elasticsearch/index/fielddata/ordinals/OrdinalsBuilder.java index fa7eef6e6b..3b66adfee9 100644 --- a/core/src/main/java/org/elasticsearch/index/fielddata/ordinals/OrdinalsBuilder.java +++ b/core/src/main/java/org/elasticsearch/index/fielddata/ordinals/OrdinalsBuilder.java @@ -34,7 +34,7 @@ import java.io.IOException; import java.util.Arrays; /** - * Simple class to build document ID <-> ordinal mapping. Note: Ordinals are + * Simple class to build document ID <-> ordinal mapping. Note: Ordinals are * <tt>1</tt> based monotonically increasing positive integers. <tt>0</tt> * donates the missing value in this context. */ @@ -75,7 +75,7 @@ public final class OrdinalsBuilder implements Closeable { * with document 2: it has 2 more ordinals on level 1: 3 and 4 and its next level index is 1 meaning that there are remaining * ordinals on the next level. On level 2 at index 1, we can read [5 0 0 0] meaning that 5 is an ordinal as well, but the * fact that it is followed by zeros means that there are no more ordinals. In the end, document 2 has 2, 3, 4 and 5 as ordinals. - * <p/> + * <p> * In addition to these structures, there is another array which stores the current position (level + slice + offset in the slice) * in order to be able to append data in constant time. */ @@ -300,7 +300,7 @@ public final class OrdinalsBuilder implements Closeable { } /** - * Return a {@link PackedInts.Reader} instance mapping every doc ID to its first ordinal + 1 if it exists and 0 otherwise. + * Return a {@link org.apache.lucene.util.packed.PackedInts.Reader} instance mapping every doc ID to its first ordinal + 1 if it exists and 0 otherwise. */ public PackedInts.Reader getFirstOrdinals() { return ordinals.firstOrdinals; @@ -419,7 +419,7 @@ public final class OrdinalsBuilder implements Closeable { /** * A {@link TermsEnum} that iterates only full precision prefix coded 64 bit values. * - * @see #buildFromTerms(TermsEnum, Bits) + * @see #buildFromTerms(TermsEnum) */ public static TermsEnum wrapNumeric64Bit(TermsEnum termsEnum) { return new FilteredTermsEnum(termsEnum, false) { @@ -434,7 +434,7 @@ public final class OrdinalsBuilder implements Closeable { /** * A {@link TermsEnum} that iterates only full precision prefix coded 32 bit values. * - * @see #buildFromTerms(TermsEnum, Bits) + * @see #buildFromTerms(TermsEnum) */ public static TermsEnum wrapNumeric32Bit(TermsEnum termsEnum) { return new FilteredTermsEnum(termsEnum, false) { diff --git a/core/src/main/java/org/elasticsearch/index/fielddata/plain/AbstractIndexFieldData.java b/core/src/main/java/org/elasticsearch/index/fielddata/plain/AbstractIndexFieldData.java index 1601edc7ad..4cd172fd22 100644 --- a/core/src/main/java/org/elasticsearch/index/fielddata/plain/AbstractIndexFieldData.java +++ b/core/src/main/java/org/elasticsearch/index/fielddata/plain/AbstractIndexFieldData.java @@ -99,7 +99,7 @@ public abstract class AbstractIndexFieldData<FD extends AtomicFieldData> extends * the memory overhead for loading the data. Each field data * implementation should implement its own {@code PerValueEstimator} if it * intends to take advantage of the MemoryCircuitBreaker. - * <p/> + * <p> * Note that the .beforeLoad(...) and .afterLoad(...) methods must be * manually called. */ @@ -118,7 +118,6 @@ public abstract class AbstractIndexFieldData<FD extends AtomicFieldData> extends * * @param terms terms to be estimated * @return A TermsEnum for the given terms - * @throws IOException */ public TermsEnum beforeLoad(Terms terms) throws IOException; diff --git a/core/src/main/java/org/elasticsearch/index/fielddata/plain/PackedArrayIndexFieldData.java b/core/src/main/java/org/elasticsearch/index/fielddata/plain/PackedArrayIndexFieldData.java index 1b54e386c0..5f95d99f85 100644 --- a/core/src/main/java/org/elasticsearch/index/fielddata/plain/PackedArrayIndexFieldData.java +++ b/core/src/main/java/org/elasticsearch/index/fielddata/plain/PackedArrayIndexFieldData.java @@ -418,7 +418,6 @@ public class PackedArrayIndexFieldData extends AbstractIndexFieldData<AtomicNume /** * @return A TermsEnum wrapped in a RamAccountingTermsEnum - * @throws IOException */ @Override public TermsEnum beforeLoad(Terms terms) throws IOException { diff --git a/core/src/main/java/org/elasticsearch/index/fielddata/plain/PagedBytesIndexFieldData.java b/core/src/main/java/org/elasticsearch/index/fielddata/plain/PagedBytesIndexFieldData.java index dce5e403e2..48c954394e 100644 --- a/core/src/main/java/org/elasticsearch/index/fielddata/plain/PagedBytesIndexFieldData.java +++ b/core/src/main/java/org/elasticsearch/index/fielddata/plain/PagedBytesIndexFieldData.java @@ -189,7 +189,6 @@ public class PagedBytesIndexFieldData extends AbstractIndexOrdinalsFieldData { * * @param terms terms to be estimated * @return A possibly wrapped TermsEnum for the terms - * @throws IOException */ @Override public TermsEnum beforeLoad(Terms terms) throws IOException { diff --git a/core/src/main/java/org/elasticsearch/index/fielddata/plain/SortedNumericDVIndexFieldData.java b/core/src/main/java/org/elasticsearch/index/fielddata/plain/SortedNumericDVIndexFieldData.java index 354ad43a0c..0c78d2e5f1 100644 --- a/core/src/main/java/org/elasticsearch/index/fielddata/plain/SortedNumericDVIndexFieldData.java +++ b/core/src/main/java/org/elasticsearch/index/fielddata/plain/SortedNumericDVIndexFieldData.java @@ -37,7 +37,7 @@ import java.util.Collections; /** * FieldData backed by {@link LeafReader#getSortedNumericDocValues(String)} - * @see FieldInfo.DocValuesType#SORTED_NUMERIC + * @see DocValuesType#SORTED_NUMERIC */ public class SortedNumericDVIndexFieldData extends DocValuesIndexFieldData implements IndexNumericFieldData { private final NumericType numericType; @@ -132,9 +132,7 @@ public class SortedNumericDVIndexFieldData extends DocValuesIndexFieldData imple * Order of values within a document is consistent with * {@link Float#compareTo(Float)}, hence the following reversible * transformation is applied at both index and search: - * {code} - * bits ^ (bits >> 31) & 0x7fffffff - * {code} + * {@code bits ^ (bits >> 31) & 0x7fffffff} * <p> * Although the API is multi-valued, most codecs in Lucene specialize * for the case where documents have at most one value. In this case @@ -223,9 +221,7 @@ public class SortedNumericDVIndexFieldData extends DocValuesIndexFieldData imple * Order of values within a document is consistent with * {@link Double#compareTo(Double)}, hence the following reversible * transformation is applied at both index and search: - * {code} - * bits ^ (bits >> 63) & 0x7fffffffffffffffL - * {code} + * {@code bits ^ (bits >> 63) & 0x7fffffffffffffffL} * <p> * Although the API is multi-valued, most codecs in Lucene specialize * for the case where documents have at most one value. In this case diff --git a/core/src/main/java/org/elasticsearch/index/fieldvisitor/FieldsVisitor.java b/core/src/main/java/org/elasticsearch/index/fieldvisitor/FieldsVisitor.java index 5048baec12..31b0a08022 100644 --- a/core/src/main/java/org/elasticsearch/index/fieldvisitor/FieldsVisitor.java +++ b/core/src/main/java/org/elasticsearch/index/fieldvisitor/FieldsVisitor.java @@ -46,8 +46,10 @@ import java.util.List; import java.util.Map; import java.util.Set; +import org.apache.lucene.index.StoredFieldVisitor; + /** - * Base {@link StoredFieldsVisitor} that retrieves all non-redundant metadata. + * Base {@link StoredFieldVisitor} that retrieves all non-redundant metadata. */ public class FieldsVisitor extends StoredFieldVisitor { diff --git a/core/src/main/java/org/elasticsearch/index/get/ShardGetService.java b/core/src/main/java/org/elasticsearch/index/get/ShardGetService.java index 212362c394..1cf68ad383 100644 --- a/core/src/main/java/org/elasticsearch/index/get/ShardGetService.java +++ b/core/src/main/java/org/elasticsearch/index/get/ShardGetService.java @@ -102,10 +102,10 @@ public final class ShardGetService extends AbstractIndexShardComponent { } /** - * Returns {@link GetResult} based on the specified {@link Engine.GetResult} argument. + * Returns {@link GetResult} based on the specified {@link org.elasticsearch.index.engine.Engine.GetResult} argument. * This method basically loads specified fields for the associated document in the engineGetResult. * This method load the fields from the Lucene index and not from transaction log and therefore isn't realtime. - * <p/> + * <p> * Note: Call <b>must</b> release engine searcher associated with engineGetResult! */ public GetResult get(Engine.GetResult engineGetResult, String id, String type, String[] fields, FetchSourceContext fetchSourceContext, boolean ignoreErrorsOnGeneratedFields) { diff --git a/core/src/main/java/org/elasticsearch/index/indexing/IndexingOperationListener.java b/core/src/main/java/org/elasticsearch/index/indexing/IndexingOperationListener.java index bb4c109e6a..858453fcba 100644 --- a/core/src/main/java/org/elasticsearch/index/indexing/IndexingOperationListener.java +++ b/core/src/main/java/org/elasticsearch/index/indexing/IndexingOperationListener.java @@ -35,7 +35,7 @@ public abstract class IndexingOperationListener { /** * Called after the indexing occurs, under a locking scheme to maintain * concurrent updates to the same doc. - * <p/> + * <p> * Note, long operations should not occur under this callback. */ public void postCreateUnderLock(Engine.Create create) { @@ -66,7 +66,7 @@ public abstract class IndexingOperationListener { /** * Called after the indexing occurs, under a locking scheme to maintain * concurrent updates to the same doc. - * <p/> + * <p> * Note, long operations should not occur under this callback. */ public void postIndexUnderLock(Engine.Index index) { @@ -97,7 +97,7 @@ public abstract class IndexingOperationListener { /** * Called after the delete occurs, under a locking scheme to maintain * concurrent updates to the same doc. - * <p/> + * <p> * Note, long operations should not occur under this callback. */ public void postDeleteUnderLock(Engine.Delete delete) { diff --git a/core/src/main/java/org/elasticsearch/index/indexing/IndexingStats.java b/core/src/main/java/org/elasticsearch/index/indexing/IndexingStats.java index 5bda1de73b..af4add9132 100644 --- a/core/src/main/java/org/elasticsearch/index/indexing/IndexingStats.java +++ b/core/src/main/java/org/elasticsearch/index/indexing/IndexingStats.java @@ -113,7 +113,6 @@ public class IndexingStats implements Streamable, ToXContent { /** * Returns if the index is under merge throttling control - * @return */ public boolean isThrottled() { return isThrottled; @@ -121,7 +120,6 @@ public class IndexingStats implements Streamable, ToXContent { /** * Gets the amount of time in milliseconds that the index has been under merge throttling control - * @return */ public long getThrottleTimeInMillis() { return throttleTimeInMillis; @@ -129,7 +127,6 @@ public class IndexingStats implements Streamable, ToXContent { /** * Gets the amount of time in a TimeValue that the index has been under merge throttling control - * @return */ public TimeValue getThrottleTime() { return new TimeValue(throttleTimeInMillis); diff --git a/core/src/main/java/org/elasticsearch/index/mapper/geo/GeoPointFieldMapper.java b/core/src/main/java/org/elasticsearch/index/mapper/geo/GeoPointFieldMapper.java index 863d71f30b..222d2623c5 100644 --- a/core/src/main/java/org/elasticsearch/index/mapper/geo/GeoPointFieldMapper.java +++ b/core/src/main/java/org/elasticsearch/index/mapper/geo/GeoPointFieldMapper.java @@ -69,7 +69,7 @@ import static org.elasticsearch.index.mapper.core.TypeParsers.parsePathType; /** * Parsing: We handle: - * <p/> + * <p> * - "field" : "geo_hash" * - "field" : "lat,lon" * - "field" : { diff --git a/core/src/main/java/org/elasticsearch/index/mapper/geo/GeoShapeFieldMapper.java b/core/src/main/java/org/elasticsearch/index/mapper/geo/GeoShapeFieldMapper.java index 417950808a..770df633b9 100644 --- a/core/src/main/java/org/elasticsearch/index/mapper/geo/GeoShapeFieldMapper.java +++ b/core/src/main/java/org/elasticsearch/index/mapper/geo/GeoShapeFieldMapper.java @@ -61,13 +61,13 @@ import static org.elasticsearch.index.mapper.MapperBuilders.geoShapeField; /** * FieldMapper for indexing {@link com.spatial4j.core.shape.Shape}s. - * <p/> + * <p> * Currently Shapes can only be indexed and can only be queried using * {@link org.elasticsearch.index.query.GeoShapeQueryParser}, consequently * a lot of behavior in this Mapper is disabled. - * <p/> + * <p> * Format supported: - * <p/> + * <p> * "field" : { * "type" : "polygon", * "coordinates" : [ diff --git a/core/src/main/java/org/elasticsearch/index/percolator/PercolatorQueriesRegistry.java b/core/src/main/java/org/elasticsearch/index/percolator/PercolatorQueriesRegistry.java index 9283a9b033..9740054c18 100644 --- a/core/src/main/java/org/elasticsearch/index/percolator/PercolatorQueriesRegistry.java +++ b/core/src/main/java/org/elasticsearch/index/percolator/PercolatorQueriesRegistry.java @@ -60,7 +60,7 @@ import java.util.concurrent.atomic.AtomicBoolean; /** * Each shard will have a percolator registry even if there isn't a {@link PercolatorService#TYPE_NAME} document type in the index. * For shards with indices that have no {@link PercolatorService#TYPE_NAME} document type, this will hold no percolate queries. - * <p/> + * <p> * Once a document type has been created, the real-time percolator will start to listen to write events and update the * this registry with queries in real time. */ diff --git a/core/src/main/java/org/elasticsearch/index/query/BoolQueryBuilder.java b/core/src/main/java/org/elasticsearch/index/query/BoolQueryBuilder.java index c377667310..d3fa929945 100644 --- a/core/src/main/java/org/elasticsearch/index/query/BoolQueryBuilder.java +++ b/core/src/main/java/org/elasticsearch/index/query/BoolQueryBuilder.java @@ -108,12 +108,12 @@ public class BoolQueryBuilder extends QueryBuilder implements BoostableQueryBuil /** * Specifies a minimum number of the optional (should) boolean clauses which must be satisfied. - * <p/> - * <p>By default no optional clauses are necessary for a match + * <p> + * By default no optional clauses are necessary for a match * (unless there are no required clauses). If this method is used, * then the specified number of clauses is required. - * <p/> - * <p>Use of this method is totally independent of specifying that + * <p> + * Use of this method is totally independent of specifying that * any specific clauses are required (or prohibited). This number will * only be compared against the number of matching optional clauses. * diff --git a/core/src/main/java/org/elasticsearch/index/query/BoostingQueryBuilder.java b/core/src/main/java/org/elasticsearch/index/query/BoostingQueryBuilder.java index 9d67469deb..1e2f9c4d00 100644 --- a/core/src/main/java/org/elasticsearch/index/query/BoostingQueryBuilder.java +++ b/core/src/main/java/org/elasticsearch/index/query/BoostingQueryBuilder.java @@ -27,7 +27,7 @@ import java.io.IOException; * The BoostingQuery class can be used to effectively demote results that match a given query. * Unlike the "NOT" clause, this still selects documents that contain undesirable terms, * but reduces their overall score: - * <p/> + * <p> * Query balancedQuery = new BoostingQuery(positiveQuery, negativeQuery, 0.01f); * In this scenario the positiveQuery contains the mandatory, desirable criteria which is used to * select all matching documents, and the negativeQuery contains the undesirable elements which diff --git a/core/src/main/java/org/elasticsearch/index/query/CommonTermsQueryBuilder.java b/core/src/main/java/org/elasticsearch/index/query/CommonTermsQueryBuilder.java index ae9c10d295..32b74d0c09 100644 --- a/core/src/main/java/org/elasticsearch/index/query/CommonTermsQueryBuilder.java +++ b/core/src/main/java/org/elasticsearch/index/query/CommonTermsQueryBuilder.java @@ -29,7 +29,7 @@ import java.io.IOException; /** * CommonTermsQuery query is a query that executes high-frequency terms in a * optional sub-query to prevent slow queries due to "common" terms like - * stopwords. This query basically builds 2 queries off the {@link #add(Term) + * stopwords. This query basically builds 2 queries off the {@code #add(Term) * added} terms where low-frequency terms are added to a required boolean clause * and high-frequency terms are added to an optional boolean clause. The * optional clause is only executed if the required "low-frequency' clause @@ -40,7 +40,6 @@ import java.io.IOException; * significantly contribute to the document score unless at least one of the * low-frequency terms are matched such that this query can improve query * execution times significantly if applicable. - * <p> */ public class CommonTermsQueryBuilder extends QueryBuilder implements BoostableQueryBuilder<CommonTermsQueryBuilder> { @@ -123,7 +122,7 @@ public class CommonTermsQueryBuilder extends QueryBuilder implements BoostableQu /** * Sets the cutoff document frequency for high / low frequent terms. A value - * in [0..1] (or absolute number >=1) representing the maximum threshold of + * in [0..1] (or absolute number >=1) representing the maximum threshold of * a terms document frequency to be considered a low frequency term. * Defaults to * <tt>{@value CommonTermsQueryParser#DEFAULT_MAX_TERM_DOC_FREQ}</tt> diff --git a/core/src/main/java/org/elasticsearch/index/query/GeoPolygonQueryBuilder.java b/core/src/main/java/org/elasticsearch/index/query/GeoPolygonQueryBuilder.java index da1dac2c11..2d486e05a1 100644 --- a/core/src/main/java/org/elasticsearch/index/query/GeoPolygonQueryBuilder.java +++ b/core/src/main/java/org/elasticsearch/index/query/GeoPolygonQueryBuilder.java @@ -49,7 +49,6 @@ public class GeoPolygonQueryBuilder extends QueryBuilder { * * @param lat The latitude * @param lon The longitude - * @return */ public GeoPolygonQueryBuilder addPoint(double lat, double lon) { return addPoint(new GeoPoint(lat, lon)); diff --git a/core/src/main/java/org/elasticsearch/index/query/GeohashCellQuery.java b/core/src/main/java/org/elasticsearch/index/query/GeohashCellQuery.java index 6067bc675b..84d3857812 100644 --- a/core/src/main/java/org/elasticsearch/index/query/GeohashCellQuery.java +++ b/core/src/main/java/org/elasticsearch/index/query/GeohashCellQuery.java @@ -44,7 +44,7 @@ import java.util.List; * Geohash prefix is defined by the filter and all geohashes that are matching this * prefix will be returned. The <code>neighbors</code> flag allows to filter * geohashes that surround the given geohash. In general the neighborhood of a - * geohash is defined by its eight adjacent cells.<br /> + * geohash is defined by its eight adjacent cells.<br> * The structure of the {@link GeohashCellQuery} is defined as: * <pre> * "geohash_bbox" { diff --git a/core/src/main/java/org/elasticsearch/index/query/MatchQueryBuilder.java b/core/src/main/java/org/elasticsearch/index/query/MatchQueryBuilder.java index 6f73f08dc0..c7c530b1d5 100644 --- a/core/src/main/java/org/elasticsearch/index/query/MatchQueryBuilder.java +++ b/core/src/main/java/org/elasticsearch/index/query/MatchQueryBuilder.java @@ -163,7 +163,7 @@ public class MatchQueryBuilder extends QueryBuilder implements BoostableQueryBui } /** - * Set a cutoff value in [0..1] (or absolute number >=1) representing the + * Set a cutoff value in [0..1] (or absolute number >=1) representing the * maximum threshold of a terms document frequency to be considered a low * frequency term. */ @@ -266,4 +266,4 @@ public class MatchQueryBuilder extends QueryBuilder implements BoostableQueryBui builder.endObject(); builder.endObject(); } -}
\ No newline at end of file +} diff --git a/core/src/main/java/org/elasticsearch/index/query/MoreLikeThisQueryBuilder.java b/core/src/main/java/org/elasticsearch/index/query/MoreLikeThisQueryBuilder.java index 4994070fd7..5c7e24b53c 100644 --- a/core/src/main/java/org/elasticsearch/index/query/MoreLikeThisQueryBuilder.java +++ b/core/src/main/java/org/elasticsearch/index/query/MoreLikeThisQueryBuilder.java @@ -512,8 +512,8 @@ public class MoreLikeThisQueryBuilder extends QueryBuilder implements BoostableQ /** * Set the set of stopwords. - * <p/> - * <p>Any word in this set is considered "uninteresting" and ignored. Even if your Analyzer allows stopwords, you + * <p> + * Any word in this set is considered "uninteresting" and ignored. Even if your Analyzer allows stopwords, you * might want to tell the MoreLikeThis code to ignore them, as for the purposes of document similarity it seems * reasonable to assume that "a stop word is never interesting". */ diff --git a/core/src/main/java/org/elasticsearch/index/query/MultiMatchQueryBuilder.java b/core/src/main/java/org/elasticsearch/index/query/MultiMatchQueryBuilder.java index b0949159b2..d42f0c786c 100644 --- a/core/src/main/java/org/elasticsearch/index/query/MultiMatchQueryBuilder.java +++ b/core/src/main/java/org/elasticsearch/index/query/MultiMatchQueryBuilder.java @@ -302,7 +302,7 @@ public class MultiMatchQueryBuilder extends QueryBuilder implements BoostableQue /** - * Set a cutoff value in [0..1] (or absolute number >=1) representing the + * Set a cutoff value in [0..1] (or absolute number >=1) representing the * maximum threshold of a terms document frequency to be considered a low * frequency term. */ diff --git a/core/src/main/java/org/elasticsearch/index/query/QueryBuilders.java b/core/src/main/java/org/elasticsearch/index/query/QueryBuilders.java index aa2dd1d242..f042056b27 100644 --- a/core/src/main/java/org/elasticsearch/index/query/QueryBuilders.java +++ b/core/src/main/java/org/elasticsearch/index/query/QueryBuilders.java @@ -340,7 +340,6 @@ public abstract class QueryBuilders { * * @param multiTermQueryBuilder The {@link MultiTermQueryBuilder} that * backs the created builder. - * @return */ public static SpanMultiTermQueryBuilder spanMultiTermQueryBuilder(MultiTermQueryBuilder multiTermQueryBuilder) { diff --git a/core/src/main/java/org/elasticsearch/index/query/QueryParser.java b/core/src/main/java/org/elasticsearch/index/query/QueryParser.java index d561a0a42b..9553d93bce 100644 --- a/core/src/main/java/org/elasticsearch/index/query/QueryParser.java +++ b/core/src/main/java/org/elasticsearch/index/query/QueryParser.java @@ -38,7 +38,7 @@ public interface QueryParser { /** * Parses the into a query from the current parser location. Will be at "START_OBJECT" location, * and should end when the token is at the matching "END_OBJECT". - * <p/> + * <p> * Returns <tt>null</tt> if this query should be ignored in the context of the DSL. */ @Nullable diff --git a/core/src/main/java/org/elasticsearch/index/query/QueryStringQueryBuilder.java b/core/src/main/java/org/elasticsearch/index/query/QueryStringQueryBuilder.java index c7a297e319..78bfac73f9 100644 --- a/core/src/main/java/org/elasticsearch/index/query/QueryStringQueryBuilder.java +++ b/core/src/main/java/org/elasticsearch/index/query/QueryStringQueryBuilder.java @@ -34,7 +34,6 @@ import java.util.Locale; * will use the {@link #defaultField(String)} set. The second, when one or more fields are added * (using {@link #field(String)}), will run the parsed query against the provided fields, and combine * them either using DisMax or a plain boolean query (see {@link #useDisMax(boolean)}). - * <p/> */ public class QueryStringQueryBuilder extends QueryBuilder implements BoostableQueryBuilder<QueryStringQueryBuilder> { @@ -157,12 +156,12 @@ public class QueryStringQueryBuilder extends QueryBuilder implements BoostableQu /** * Sets the boolean operator of the query parser used to parse the query string. - * <p/> - * <p>In default mode ({@link Operator#OR}) terms without any modifiers + * <p> + * In default mode ({@link Operator#OR}) terms without any modifiers * are considered optional: for example <code>capital of Hungary</code> is equal to * <code>capital OR of OR Hungary</code>. - * <p/> - * <p>In {@link Operator#AND} mode terms are considered to be in conjunction: the + * <p> + * In {@link Operator#AND} mode terms are considered to be in conjunction: the * above mentioned query is parsed as <code>capital AND of AND Hungary</code> */ public QueryStringQueryBuilder defaultOperator(Operator defaultOperator) { @@ -194,7 +193,7 @@ public class QueryStringQueryBuilder extends QueryBuilder implements BoostableQu * when the analyzer returns more than one term from whitespace * delimited text. * NOTE: this behavior may not be suitable for all languages. - * <p/> + * <p> * Set to false if phrase queries should only be generated when * surrounded by double quotes. */ @@ -231,8 +230,8 @@ public class QueryStringQueryBuilder extends QueryBuilder implements BoostableQu /** * Set to <tt>true</tt> to enable position increments in result query. Defaults to * <tt>true</tt>. - * <p/> - * <p>When set, result phrase and multi-phrase queries will be aware of position increments. + * <p> + * When set, result phrase and multi-phrase queries will be aware of position increments. * Useful when e.g. a StopFilter increases the position increment of the token that follows an omitted token. */ public QueryStringQueryBuilder enablePositionIncrements(boolean enablePositionIncrements) { diff --git a/core/src/main/java/org/elasticsearch/index/query/RegexpFlag.java b/core/src/main/java/org/elasticsearch/index/query/RegexpFlag.java index 0af6b86db3..45f58c47da 100644 --- a/core/src/main/java/org/elasticsearch/index/query/RegexpFlag.java +++ b/core/src/main/java/org/elasticsearch/index/query/RegexpFlag.java @@ -89,9 +89,9 @@ public enum RegexpFlag { /** * Resolves the combined OR'ed value for the given list of regular expression flags. The given flags must follow the * following syntax: - * <p/> + * <p> * <tt>flag_name</tt>(|<tt>flag_name</tt>)* - * <p/> + * <p> * Where <tt>flag_name</tt> is one of the following: * <ul> * <li>INTERSECTION</li> @@ -102,10 +102,10 @@ public enum RegexpFlag { * <li>NONE</li> * <li>ALL</li> * </ul> - * <p/> + * <p> * Example: <tt>INTERSECTION|COMPLEMENT|EMPTY</tt> * - * @param flags A string representing a list of regualr expression flags + * @param flags A string representing a list of regular expression flags * @return The combined OR'ed value for all the flags */ static int resolveValue(String flags) { diff --git a/core/src/main/java/org/elasticsearch/index/query/SimpleQueryStringParser.java b/core/src/main/java/org/elasticsearch/index/query/SimpleQueryStringParser.java index a81ffbf348..4207f93fa7 100644 --- a/core/src/main/java/org/elasticsearch/index/query/SimpleQueryStringParser.java +++ b/core/src/main/java/org/elasticsearch/index/query/SimpleQueryStringParser.java @@ -42,7 +42,6 @@ import java.util.Map; * SimpleQueryStringParser is a query parser that acts similar to a query_string * query, but won't throw exceptions for any weird string syntax. It supports * the following: - * <p/> * <ul> * <li>'{@code +}' specifies {@code AND} operation: <tt>token1+token2</tt> * <li>'{@code |}' specifies {@code OR} operation: <tt>token1|token2</tt> @@ -53,14 +52,14 @@ import java.util.Map; * <li>'{@code ~}N' at the end of terms specifies fuzzy query: <tt>term~1</tt> * <li>'{@code ~}N' at the end of phrases specifies near/slop query: <tt>"term1 term2"~5</tt> * </ul> - * <p/> + * <p> * See: {@link SimpleQueryParser} for more information. - * <p/> + * <p> * This query supports these options: - * <p/> + * <p> * Required: * {@code query} - query text to be converted into other queries - * <p/> + * <p> * Optional: * {@code analyzer} - anaylzer to be used for analyzing tokens to determine * which kind of query they should be converted into, defaults to "standard" diff --git a/core/src/main/java/org/elasticsearch/index/query/WrapperQueryBuilder.java b/core/src/main/java/org/elasticsearch/index/query/WrapperQueryBuilder.java index a6e8e23e00..e7de5fd048 100644 --- a/core/src/main/java/org/elasticsearch/index/query/WrapperQueryBuilder.java +++ b/core/src/main/java/org/elasticsearch/index/query/WrapperQueryBuilder.java @@ -29,14 +29,14 @@ import java.io.IOException; * A Query builder which allows building a query given JSON string or binary data provided as input. This is useful when you want * to use the Java Builder API but still have JSON query strings at hand that you want to combine with other * query builders. - * <p/> + * <p> * Example usage in a boolean query : * <pre> - * {@code + * <code> * BoolQueryBuilder bool = new BoolQueryBuilder(); * bool.must(new WrapperQueryBuilder("{\"term\": {\"field\":\"value\"}}"); * bool.must(new TermQueryBuilder("field2","value2"); - * } + * </code> * </pre> */ public class WrapperQueryBuilder extends QueryBuilder { diff --git a/core/src/main/java/org/elasticsearch/index/query/functionscore/DecayFunctionParser.java b/core/src/main/java/org/elasticsearch/index/query/functionscore/DecayFunctionParser.java index bfe988a268..6e74959ab3 100644 --- a/core/src/main/java/org/elasticsearch/index/query/functionscore/DecayFunctionParser.java +++ b/core/src/main/java/org/elasticsearch/index/query/functionscore/DecayFunctionParser.java @@ -60,14 +60,14 @@ import java.util.Locale; * This parser parses this kind of input * * <pre> - * {@code} + * <code> * { * "fieldname1" : { * "origin" = "someValue", * "scale" = "someValue" * } * - * } + * </code> * </pre> * * "origin" here refers to the reference point and "scale" to the level of @@ -106,7 +106,7 @@ public abstract class DecayFunctionParser implements ScoreFunctionParser { * Parses bodies of the kind * * <pre> - * {@code} + * <code> * { * "fieldname1" : { * "origin" = "someValue", @@ -114,6 +114,7 @@ public abstract class DecayFunctionParser implements ScoreFunctionParser { * } * * } + * </code> * </pre> * * */ diff --git a/core/src/main/java/org/elasticsearch/index/query/functionscore/random/RandomScoreFunctionBuilder.java b/core/src/main/java/org/elasticsearch/index/query/functionscore/random/RandomScoreFunctionBuilder.java index ea2293c55a..22285f8cc6 100644 --- a/core/src/main/java/org/elasticsearch/index/query/functionscore/random/RandomScoreFunctionBuilder.java +++ b/core/src/main/java/org/elasticsearch/index/query/functionscore/random/RandomScoreFunctionBuilder.java @@ -51,7 +51,7 @@ public class RandomScoreFunctionBuilder extends ScoreFunctionBuilder { /** * seed variant taking a long value. - * @see {@link #seed(int)} + * @see #seed(int) */ public RandomScoreFunctionBuilder seed(long seed) { this.seed = seed; @@ -60,7 +60,7 @@ public class RandomScoreFunctionBuilder extends ScoreFunctionBuilder { /** * seed variant taking a String value. - * @see {@link #seed(int)} + * @see #seed(int) */ public RandomScoreFunctionBuilder seed(String seed) { this.seed = seed; @@ -78,4 +78,4 @@ public class RandomScoreFunctionBuilder extends ScoreFunctionBuilder { builder.endObject(); } -}
\ No newline at end of file +} diff --git a/core/src/main/java/org/elasticsearch/index/shard/MergePolicyConfig.java b/core/src/main/java/org/elasticsearch/index/shard/MergePolicyConfig.java index 3895bbed2c..c664d3a379 100644 --- a/core/src/main/java/org/elasticsearch/index/shard/MergePolicyConfig.java +++ b/core/src/main/java/org/elasticsearch/index/shard/MergePolicyConfig.java @@ -79,7 +79,7 @@ import org.elasticsearch.index.settings.IndexSettingsService; * * Sets the allowed number of segments per tier. Smaller values mean more * merging but fewer segments. Default is <code>10</code>. Note, this value needs to be - * >= than the <code>max_merge_at_once</code> otherwise you'll force too many merges to + * >= than the <code>max_merge_at_once</code> otherwise you'll force too many merges to * occur. * * <li><code>index.merge.policy.reclaim_deletes_weight</code>: diff --git a/core/src/main/java/org/elasticsearch/index/similarity/BM25SimilarityProvider.java b/core/src/main/java/org/elasticsearch/index/similarity/BM25SimilarityProvider.java index ca24985516..1983c4e8ec 100644 --- a/core/src/main/java/org/elasticsearch/index/similarity/BM25SimilarityProvider.java +++ b/core/src/main/java/org/elasticsearch/index/similarity/BM25SimilarityProvider.java @@ -27,7 +27,7 @@ import org.elasticsearch.common.settings.Settings; /** * {@link SimilarityProvider} for the {@link BM25Similarity}. - * <p/> + * <p> * Configuration options available: * <ul> * <li>k1</li> diff --git a/core/src/main/java/org/elasticsearch/index/similarity/DFRSimilarityProvider.java b/core/src/main/java/org/elasticsearch/index/similarity/DFRSimilarityProvider.java index 6d30e81c09..b5a5cdcfef 100644 --- a/core/src/main/java/org/elasticsearch/index/similarity/DFRSimilarityProvider.java +++ b/core/src/main/java/org/elasticsearch/index/similarity/DFRSimilarityProvider.java @@ -28,7 +28,7 @@ import org.elasticsearch.common.settings.Settings; /** * {@link SimilarityProvider} for {@link DFRSimilarity}. - * <p/> + * <p> * Configuration options available: * <ul> * <li>basic_model</li> diff --git a/core/src/main/java/org/elasticsearch/index/similarity/DefaultSimilarityProvider.java b/core/src/main/java/org/elasticsearch/index/similarity/DefaultSimilarityProvider.java index a6e04434b3..0f9feba952 100644 --- a/core/src/main/java/org/elasticsearch/index/similarity/DefaultSimilarityProvider.java +++ b/core/src/main/java/org/elasticsearch/index/similarity/DefaultSimilarityProvider.java @@ -26,7 +26,7 @@ import org.elasticsearch.common.settings.Settings; /** * {@link SimilarityProvider} for {@link DefaultSimilarity}. - * <p/> + * <p> * Configuration options available: * <ul> * <li>discount_overlaps</li> diff --git a/core/src/main/java/org/elasticsearch/index/similarity/IBSimilarityProvider.java b/core/src/main/java/org/elasticsearch/index/similarity/IBSimilarityProvider.java index 4741247080..161ca9c10e 100644 --- a/core/src/main/java/org/elasticsearch/index/similarity/IBSimilarityProvider.java +++ b/core/src/main/java/org/elasticsearch/index/similarity/IBSimilarityProvider.java @@ -28,7 +28,7 @@ import org.elasticsearch.common.settings.Settings; /** * {@link SimilarityProvider} for {@link IBSimilarity}. - * <p/> + * <p> * Configuration options available: * <ul> * <li>distribution</li> diff --git a/core/src/main/java/org/elasticsearch/index/similarity/LMDirichletSimilarityProvider.java b/core/src/main/java/org/elasticsearch/index/similarity/LMDirichletSimilarityProvider.java index 797ce6417e..efea285639 100644 --- a/core/src/main/java/org/elasticsearch/index/similarity/LMDirichletSimilarityProvider.java +++ b/core/src/main/java/org/elasticsearch/index/similarity/LMDirichletSimilarityProvider.java @@ -27,7 +27,7 @@ import org.elasticsearch.common.settings.Settings; /** * {@link SimilarityProvider} for {@link LMDirichletSimilarity}. - * <p/> + * <p> * Configuration options available: * <ul> * <li>mu</li> diff --git a/core/src/main/java/org/elasticsearch/index/similarity/LMJelinekMercerSimilarityProvider.java b/core/src/main/java/org/elasticsearch/index/similarity/LMJelinekMercerSimilarityProvider.java index 9be02366b6..5d30b300d5 100644 --- a/core/src/main/java/org/elasticsearch/index/similarity/LMJelinekMercerSimilarityProvider.java +++ b/core/src/main/java/org/elasticsearch/index/similarity/LMJelinekMercerSimilarityProvider.java @@ -27,7 +27,7 @@ import org.elasticsearch.common.settings.Settings; /** * {@link SimilarityProvider} for {@link LMJelinekMercerSimilarity}. - * <p/> + * <p> * Configuration options available: * <ul> * <li>lambda</li> diff --git a/core/src/main/java/org/elasticsearch/index/similarity/SimilarityLookupService.java b/core/src/main/java/org/elasticsearch/index/similarity/SimilarityLookupService.java index 49e3df989f..8b8b68812c 100644 --- a/core/src/main/java/org/elasticsearch/index/similarity/SimilarityLookupService.java +++ b/core/src/main/java/org/elasticsearch/index/similarity/SimilarityLookupService.java @@ -31,7 +31,7 @@ import java.util.Map; /** * Service for looking up configured {@link SimilarityProvider} implementations by name. - * <p/> + * <p> * The service instantiates the Providers through their Factories using configuration * values found with the {@link SimilarityModule#SIMILARITY_SETTINGS_PREFIX} prefix. */ diff --git a/core/src/main/java/org/elasticsearch/index/snapshots/IndexShardRepository.java b/core/src/main/java/org/elasticsearch/index/snapshots/IndexShardRepository.java index 7c77884692..8ce487fe14 100644 --- a/core/src/main/java/org/elasticsearch/index/snapshots/IndexShardRepository.java +++ b/core/src/main/java/org/elasticsearch/index/snapshots/IndexShardRepository.java @@ -27,7 +27,7 @@ import org.elasticsearch.indices.recovery.RecoveryState; /** * Shard-level snapshot repository - * <p/> + * <p> * IndexShardRepository is used on data node to create snapshots of individual shards. See {@link org.elasticsearch.repositories.Repository} * for more information. */ @@ -35,10 +35,10 @@ public interface IndexShardRepository { /** * Creates a snapshot of the shard based on the index commit point. - * <p/> + * <p> * The index commit point can be obtained by using {@link org.elasticsearch.index.engine.Engine#snapshotIndex} method. * IndexShardRepository implementations shouldn't release the snapshot index commit point. It is done by the method caller. - * <p/> + * <p> * As snapshot process progresses, implementation of this method should update {@link IndexShardSnapshotStatus} object and check * {@link IndexShardSnapshotStatus#aborted()} to see if the snapshot process should be aborted. * @@ -51,7 +51,7 @@ public interface IndexShardRepository { /** * Restores snapshot of the shard. - * <p/> + * <p> * The index can be renamed on restore, hence different {@code shardId} and {@code snapshotShardId} are supplied. * * @param snapshotId snapshot id diff --git a/core/src/main/java/org/elasticsearch/index/snapshots/blobstore/BlobStoreIndexShardRepository.java b/core/src/main/java/org/elasticsearch/index/snapshots/blobstore/BlobStoreIndexShardRepository.java index 947a36a6c1..912be76fb8 100644 --- a/core/src/main/java/org/elasticsearch/index/snapshots/blobstore/BlobStoreIndexShardRepository.java +++ b/core/src/main/java/org/elasticsearch/index/snapshots/blobstore/BlobStoreIndexShardRepository.java @@ -623,12 +623,11 @@ public class BlobStoreIndexShardRepository extends AbstractComponent implements /** * Snapshot individual file - * <p/> + * <p> * This is asynchronous method. Upon completion of the operation latch is getting counted down and any failures are * added to the {@code failures} list * * @param fileInfo file to be snapshotted - * @throws IOException */ private void snapshotFile(final BlobStoreIndexShardSnapshot.FileInfo fileInfo) throws IOException { final String file = fileInfo.physicalName(); diff --git a/core/src/main/java/org/elasticsearch/index/snapshots/blobstore/BlobStoreIndexShardSnapshot.java b/core/src/main/java/org/elasticsearch/index/snapshots/blobstore/BlobStoreIndexShardSnapshot.java index 808f13ba23..56d9882063 100644 --- a/core/src/main/java/org/elasticsearch/index/snapshots/blobstore/BlobStoreIndexShardSnapshot.java +++ b/core/src/main/java/org/elasticsearch/index/snapshots/blobstore/BlobStoreIndexShardSnapshot.java @@ -228,7 +228,6 @@ public class BlobStoreIndexShardSnapshot implements ToXContent, FromXContentBuil * @param file file info * @param builder XContent builder * @param params parameters - * @throws IOException */ public static void toXContent(FileInfo file, XContentBuilder builder, ToXContent.Params params) throws IOException { builder.startObject(); @@ -257,7 +256,6 @@ public class BlobStoreIndexShardSnapshot implements ToXContent, FromXContentBuil * * @param parser parser * @return file info - * @throws IOException */ public static FileInfo fromXContent(XContentParser parser) throws IOException { XContentParser.Token token = parser.currentToken(); @@ -446,7 +444,6 @@ public class BlobStoreIndexShardSnapshot implements ToXContent, FromXContentBuil * * @param builder XContent builder * @param params parameters - * @throws IOException */ @Override public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException { @@ -469,7 +466,6 @@ public class BlobStoreIndexShardSnapshot implements ToXContent, FromXContentBuil * * @param parser parser * @return shard snapshot metadata - * @throws IOException */ public BlobStoreIndexShardSnapshot fromXContent(XContentParser parser, ParseFieldMatcher parseFieldMatcher) throws IOException { diff --git a/core/src/main/java/org/elasticsearch/index/snapshots/blobstore/BlobStoreIndexShardSnapshots.java b/core/src/main/java/org/elasticsearch/index/snapshots/blobstore/BlobStoreIndexShardSnapshots.java index 268e681e93..bf8c1a83c9 100644 --- a/core/src/main/java/org/elasticsearch/index/snapshots/blobstore/BlobStoreIndexShardSnapshots.java +++ b/core/src/main/java/org/elasticsearch/index/snapshots/blobstore/BlobStoreIndexShardSnapshots.java @@ -40,7 +40,7 @@ import java.util.Map; /** * Contains information about all snapshot for the given shard in repository - * <p/> + * <p> * This class is used to find files that were already snapshoted and clear out files that no longer referenced by any * snapshots */ @@ -160,7 +160,7 @@ public class BlobStoreIndexShardSnapshots implements Iterable<SnapshotFiles>, To /** * Writes index file for the shard in the following format. * <pre> - * {@code + * <code> * { * "files": [{ * "name": "__3", @@ -206,6 +206,7 @@ public class BlobStoreIndexShardSnapshots implements Iterable<SnapshotFiles>, To * } * } * } + * </code> * </pre> */ @Override diff --git a/core/src/main/java/org/elasticsearch/index/store/Store.java b/core/src/main/java/org/elasticsearch/index/store/Store.java index 2b5051b412..09f8ec23ad 100644 --- a/core/src/main/java/org/elasticsearch/index/store/Store.java +++ b/core/src/main/java/org/elasticsearch/index/store/Store.java @@ -70,7 +70,7 @@ import java.util.zip.Checksum; * This class also provides access to metadata information like checksums for committed files. A committed * file is a file that belongs to a segment written by a Lucene commit. Files that have not been committed * ie. created during a merge or a shard refresh / NRT reopen are not considered in the MetadataSnapshot. - * <p/> + * <p> * Note: If you use a store it's reference count should be increased before using it by calling #incRef and a * corresponding #decRef must be called in a try/finally block to release the store again ie.: * <pre> @@ -299,7 +299,7 @@ public class Store extends AbstractIndexShardComponent implements Closeable, Ref * corresponding {@link #decRef}, in a finally clause; otherwise the store may never be closed. Note that * {@link #close} simply calls decRef(), which means that the Store will not really be closed until {@link * #decRef} has been called for all outstanding references. - * <p/> + * <p> * Note: Close can safely be called multiple times. * * @throws AlreadyClosedException iff the reference counter can not be incremented. @@ -318,7 +318,7 @@ public class Store extends AbstractIndexShardComponent implements Closeable, Ref * corresponding {@link #decRef}, in a finally clause; otherwise the store may never be closed. Note that * {@link #close} simply calls decRef(), which means that the Store will not really be closed until {@link * #decRef} has been called for all outstanding references. - * <p/> + * <p> * Note: Close can safely be called multiple times. * * @see #decRef() @@ -413,7 +413,7 @@ public class Store extends AbstractIndexShardComponent implements Closeable, Ref * The returned IndexOutput might validate the files checksum if the file has been written with a newer lucene version * and the metadata holds the necessary information to detect that it was been written by Lucene 4.8 or newer. If it has only * a legacy checksum, returned IndexOutput will not verify the checksum. - * <p/> + * <p> * Note: Checksums are calculated nevertheless since lucene does it by default sicne version 4.8.0. This method only adds the * verification against the checksum in the given metadata and does not add any significant overhead. */ @@ -723,7 +723,7 @@ public class Store extends AbstractIndexShardComponent implements Closeable, Ref * Only files that are part of the last commit are considered in this datastrucutre. * For backwards compatibility the snapshot might include legacy checksums that * are derived from a dedicated checksum file written by older elasticsearch version pre 1.3 - * <p/> + * <p> * Note: This class will ignore the <tt>segments.gen</tt> file since it's optional and might * change concurrently for safety reasons. * @@ -867,13 +867,12 @@ public class Store extends AbstractIndexShardComponent implements Closeable, Ref /** * Reads legacy checksum files found in the directory. - * <p/> + * <p> * Files are expected to start with _checksums- prefix * followed by long file version. Only file with the highest version is read, all other files are ignored. * * @param directory the directory to read checksums from * @return a map of file checksums and the checksum file version - * @throws IOException */ static Tuple<Map<String, String>, Long> readLegacyChecksums(Directory directory) throws IOException { synchronized (directory) { @@ -902,7 +901,6 @@ public class Store extends AbstractIndexShardComponent implements Closeable, Ref * * @param directory the directory to clean * @param newVersion the latest checksum file version - * @throws IOException */ static void cleanLegacyChecksums(Directory directory, long newVersion) throws IOException { synchronized (directory) { @@ -949,7 +947,7 @@ public class Store extends AbstractIndexShardComponent implements Closeable, Ref } /** - * Computes a strong hash value for small files. Note that this method should only be used for files < 1MB + * Computes a strong hash value for small files. Note that this method should only be used for files < 1MB */ public static BytesRef hashFile(Directory directory, String file) throws IOException { final BytesRefBuilder fileHash = new BytesRefBuilder(); @@ -961,7 +959,7 @@ public class Store extends AbstractIndexShardComponent implements Closeable, Ref /** - * Computes a strong hash value for small files. Note that this method should only be used for files < 1MB + * Computes a strong hash value for small files. Note that this method should only be used for files < 1MB */ public static void hashFile(BytesRefBuilder fileHash, InputStream in, long size) throws IOException { final int len = (int) Math.min(1024 * 1024, size); // for safety we limit this to 1MB @@ -1006,10 +1004,10 @@ public class Store extends AbstractIndexShardComponent implements Closeable, Ref * <li>all files in this segment have the same length</li> * <li>the segments <tt>.si</tt> files hashes are byte-identical Note: This is a using a perfect hash function, The metadata transfers the <tt>.si</tt> file content as it's hash</li> * </ul> - * <p/> + * <p> * The <tt>.si</tt> file contains a lot of diagnostics including a timestamp etc. in the future there might be * unique segment identifiers in there hardening this method further. - * <p/> + * <p> * The per-commit files handles very similar. A commit is composed of the <tt>segments_N</tt> files as well as generational files like * deletes (<tt>_x_y.del</tt>) or field-info (<tt>_x_y.fnm</tt>) files. On a per-commit level files for a commit are treated * as identical iff: @@ -1018,7 +1016,7 @@ public class Store extends AbstractIndexShardComponent implements Closeable, Ref * <li>all files belonging to this commit have the same length</li> * <li>the segments file <tt>segments_N</tt> files hashes are byte-identical Note: This is a using a perfect hash function, The metadata transfers the <tt>segments_N</tt> file content as it's hash</li> * </ul> - * <p/> + * <p> * NOTE: this diff will not contain the <tt>segments.gen</tt> file. This file is omitted on recovery. */ public RecoveryDiff recoveryDiff(MetadataSnapshot recoveryTargetSnapshot) { @@ -1314,7 +1312,7 @@ public class Store extends AbstractIndexShardComponent implements Closeable, Ref /** * Index input that calculates checksum as data is read from the input. - * <p/> + * <p> * This class supports random access (it is possible to seek backward and forward) in order to accommodate retry * mechanism that is used in some repository plugins (S3 for example). However, the checksum is only calculated on * the first read. All consecutive reads of the same data are not used to calculate the checksum. diff --git a/core/src/main/java/org/elasticsearch/index/store/StoreFileMetaData.java b/core/src/main/java/org/elasticsearch/index/store/StoreFileMetaData.java index 9aaea73efb..31ad068a58 100644 --- a/core/src/main/java/org/elasticsearch/index/store/StoreFileMetaData.java +++ b/core/src/main/java/org/elasticsearch/index/store/StoreFileMetaData.java @@ -87,7 +87,6 @@ public class StoreFileMetaData implements Streamable { * Returns a string representation of the files checksum. Since Lucene 4.8 this is a CRC32 checksum written * by lucene. Previously we use Adler32 on top of Lucene as the checksum algorithm, if {@link #hasLegacyChecksum()} returns * <code>true</code> this is a Adler32 checksum. - * @return */ @Nullable public String checksum() { diff --git a/core/src/main/java/org/elasticsearch/index/translog/LegacyTranslogReader.java b/core/src/main/java/org/elasticsearch/index/translog/LegacyTranslogReader.java index 7a131f9d0d..d1cd3b1efd 100644 --- a/core/src/main/java/org/elasticsearch/index/translog/LegacyTranslogReader.java +++ b/core/src/main/java/org/elasticsearch/index/translog/LegacyTranslogReader.java @@ -32,9 +32,6 @@ public final class LegacyTranslogReader extends LegacyTranslogReaderBase { /** * Create a snapshot of translog file channel. The length parameter should be consistent with totalOperations and point * at the end of the last operation in this snapshot. - * - * @param generation - * @param channelReference */ LegacyTranslogReader(long generation, ChannelReference channelReference, long fileLength) { super(generation, channelReference, 0, fileLength); diff --git a/core/src/main/java/org/elasticsearch/index/translog/Translog.java b/core/src/main/java/org/elasticsearch/index/translog/Translog.java index 9b1913e585..5084895151 100644 --- a/core/src/main/java/org/elasticsearch/index/translog/Translog.java +++ b/core/src/main/java/org/elasticsearch/index/translog/Translog.java @@ -1764,8 +1764,6 @@ public class Translog extends AbstractIndexShardComponent implements IndexShardC /** * Returns <code>true</code> iff the given generation is the current gbeneration of this translog - * @param generation - * @return */ public boolean isCurrent(TranslogGeneration generation) { try (ReleasableLock lock = writeLock.acquire()) { diff --git a/core/src/main/java/org/elasticsearch/index/translog/TranslogReader.java b/core/src/main/java/org/elasticsearch/index/translog/TranslogReader.java index c7feb8d19c..590bc31905 100644 --- a/core/src/main/java/org/elasticsearch/index/translog/TranslogReader.java +++ b/core/src/main/java/org/elasticsearch/index/translog/TranslogReader.java @@ -170,9 +170,6 @@ public abstract class TranslogReader implements Closeable, Comparable<TranslogRe * optionally-existing header in the file. If the file does not exist, or * has zero length, returns the latest version. If the header does not * exist, assumes Version 0 of the translog file format. - * <p/> - * - * @throws IOException */ public static ImmutableTranslogReader open(ChannelReference channelReference, Checkpoint checkpoint, String translogUUID) throws IOException { final FileChannel channel = channelReference.getChannel(); diff --git a/core/src/main/java/org/elasticsearch/indices/analysis/HunspellService.java b/core/src/main/java/org/elasticsearch/indices/analysis/HunspellService.java index b44a050d2b..1a48c5c3ca 100644 --- a/core/src/main/java/org/elasticsearch/indices/analysis/HunspellService.java +++ b/core/src/main/java/org/elasticsearch/indices/analysis/HunspellService.java @@ -41,23 +41,23 @@ import java.util.function.Function; * the {@code <path.conf>/hunspell} directory, where each locale has its dedicated sub-directory which holds the dictionary * files. For example, the dictionary files for {@code en_US} locale must be placed under {@code <path.conf>/hunspell/en_US} * directory. - * <p/> + * <p> * The following settings can be set for each dictionary: * <ul> * <li>{@code ignore_case} - If true, dictionary matching will be case insensitive (defaults to {@code false})</li> * <li>{@code strict_affix_parsing} - Determines whether errors while reading a affix rules file will cause exception or simple be ignored (defaults to {@code true})</li> * </ul> - * <p/> + * <p> * These settings can either be configured as node level configuration, such as: - * <br/><br/> + * <br><br> * <pre><code> * indices.analysis.hunspell.dictionary.en_US.ignore_case: true * indices.analysis.hunspell.dictionary.en_US.strict_affix_parsing: false * </code></pre> - * <p/> + * <p> * or, as dedicated configuration per dictionary, placed in a {@code settings.yml} file under the dictionary directory. For * example, the following can be the content of the {@code <path.config>/hunspell/en_US/settings.yml} file: - * <br/><br/> + * <br><br> * <pre><code> * ignore_case: true * strict_affix_parsing: false diff --git a/core/src/main/java/org/elasticsearch/indices/breaker/CircuitBreakerService.java b/core/src/main/java/org/elasticsearch/indices/breaker/CircuitBreakerService.java index b08efaf3e5..d8bf8f1069 100644 --- a/core/src/main/java/org/elasticsearch/indices/breaker/CircuitBreakerService.java +++ b/core/src/main/java/org/elasticsearch/indices/breaker/CircuitBreakerService.java @@ -35,8 +35,6 @@ public abstract class CircuitBreakerService extends AbstractLifecycleComponent<C /** * Allows to register of a custom circuit breaker. - * - * @param breakerSettings */ public abstract void registerBreaker(BreakerSettings breakerSettings); diff --git a/core/src/main/java/org/elasticsearch/indices/breaker/HierarchyCircuitBreakerService.java b/core/src/main/java/org/elasticsearch/indices/breaker/HierarchyCircuitBreakerService.java index b6422864fc..12cf8652cc 100644 --- a/core/src/main/java/org/elasticsearch/indices/breaker/HierarchyCircuitBreakerService.java +++ b/core/src/main/java/org/elasticsearch/indices/breaker/HierarchyCircuitBreakerService.java @@ -162,7 +162,6 @@ public class HierarchyCircuitBreakerService extends CircuitBreakerService { /** * Validate that child settings are valid - * @throws IllegalStateException */ public static void validateSettings(BreakerSettings[] childrenSettings) throws IllegalStateException { for (BreakerSettings childSettings : childrenSettings) { @@ -206,8 +205,6 @@ public class HierarchyCircuitBreakerService extends CircuitBreakerService { /** * Checks whether the parent breaker has been tripped - * @param label - * @throws CircuitBreakingException */ public void checkParentLimit(String label) throws CircuitBreakingException { long totalUsed = 0; @@ -228,8 +225,6 @@ public class HierarchyCircuitBreakerService extends CircuitBreakerService { /** * Allows to register a custom circuit breaker. * Warning: Will overwrite any existing custom breaker with the same name. - * - * @param breakerSettings */ @Override public void registerBreaker(BreakerSettings breakerSettings) { diff --git a/core/src/main/java/org/elasticsearch/indices/cache/request/IndicesRequestCache.java b/core/src/main/java/org/elasticsearch/indices/cache/request/IndicesRequestCache.java index d6219946fd..4ab4691c16 100644 --- a/core/src/main/java/org/elasticsearch/indices/cache/request/IndicesRequestCache.java +++ b/core/src/main/java/org/elasticsearch/indices/cache/request/IndicesRequestCache.java @@ -68,10 +68,10 @@ import static org.elasticsearch.common.Strings.hasLength; * with the semantics of NRT (the index reader version is part of the cache key), and relies on size based * eviction to evict old reader associated cache entries as well as scheduler reaper to clean readers that * are no longer used or closed shards. - * <p/> - * Currently, the cache is only enabled for {@link SearchType#COUNT}, and can only be opted in on an index + * <p> + * Currently, the cache is only enabled for count requests, and can only be opted in on an index * level setting that can be dynamically changed and defaults to false. - * <p/> + * <p> * There are still several TODOs left in this class, some easily addressable, some more complex, but the support * is functional. */ diff --git a/core/src/main/java/org/elasticsearch/indices/fielddata/cache/IndicesFieldDataCacheListener.java b/core/src/main/java/org/elasticsearch/indices/fielddata/cache/IndicesFieldDataCacheListener.java index 75cfeb9572..cfc6357548 100644 --- a/core/src/main/java/org/elasticsearch/indices/fielddata/cache/IndicesFieldDataCacheListener.java +++ b/core/src/main/java/org/elasticsearch/indices/fielddata/cache/IndicesFieldDataCacheListener.java @@ -31,7 +31,7 @@ import org.elasticsearch.index.shard.ShardId; import org.elasticsearch.indices.breaker.CircuitBreakerService; /** - * A {@link IndexFieldDataCache.Listener} implementation that updates indices (node) level statistics / service about + * A {@link org.elasticsearch.index.fielddata.IndexFieldDataCache.Listener} implementation that updates indices (node) level statistics / service about * field data entries being loaded and unloaded. * * Currently it only decrements the memory used in the {@link CircuitBreakerService}. diff --git a/core/src/main/java/org/elasticsearch/indices/recovery/RecoveriesCollection.java b/core/src/main/java/org/elasticsearch/indices/recovery/RecoveriesCollection.java index 37c7982247..4cd9d7d6de 100644 --- a/core/src/main/java/org/elasticsearch/indices/recovery/RecoveriesCollection.java +++ b/core/src/main/java/org/elasticsearch/indices/recovery/RecoveriesCollection.java @@ -73,7 +73,7 @@ public class RecoveriesCollection { * gets the {@link RecoveryStatus } for a given id. The RecoveryStatus returned has it's ref count already incremented * to make sure it's safe to use. However, you must call {@link RecoveryStatus#decRef()} when you are done with it, typically * by using this method in a try-with-resources clause. - * <p/> + * <p> * Returns null if recovery is not found */ public StatusRef getStatus(long id) { diff --git a/core/src/main/java/org/elasticsearch/indices/recovery/RecoverySourceHandler.java b/core/src/main/java/org/elasticsearch/indices/recovery/RecoverySourceHandler.java index b987b4a64a..102fa98ced 100644 --- a/core/src/main/java/org/elasticsearch/indices/recovery/RecoverySourceHandler.java +++ b/core/src/main/java/org/elasticsearch/indices/recovery/RecoverySourceHandler.java @@ -154,7 +154,7 @@ public class RecoverySourceHandler { * Perform phase1 of the recovery operations. Once this {@link SnapshotIndexCommit} * snapshot has been performed no commit operations (files being fsync'd) * are effectively allowed on this index until all recovery phases are done - * <p/> + * <p> * Phase1 examines the segment files on the target node and copies over the * segments that are missing. Only segments that have the same size and * checksum can be reused @@ -482,7 +482,7 @@ public class RecoverySourceHandler { /** * Perform phase2 of the recovery process - * <p/> + * <p> * Phase2 takes a snapshot of the current translog *without* acquiring the * write lock (however, the translog snapshot is a point-in-time view of * the translog). It then sends each translog operation to the target node @@ -550,7 +550,7 @@ public class RecoverySourceHandler { /** * Send the given snapshot's operations to this handler's target node. - * <p/> + * <p> * Operations are bulked into a single request depending on an operation * count limit or size-in-bytes limit * diff --git a/core/src/main/java/org/elasticsearch/indices/recovery/RecoveryState.java b/core/src/main/java/org/elasticsearch/indices/recovery/RecoveryState.java index cc58305a49..022c326bf9 100644 --- a/core/src/main/java/org/elasticsearch/indices/recovery/RecoveryState.java +++ b/core/src/main/java/org/elasticsearch/indices/recovery/RecoveryState.java @@ -528,7 +528,7 @@ public class RecoveryState implements ToXContent, Streamable { /** * returns the total number of translog operations needed to be recovered at this moment. * Note that this can change as the number of operations grows during recovery. - * <p/> + * <p> * A value of -1 ({@link RecoveryState.Translog#UNKNOWN} is return if this is unknown (typically a gateway recovery) */ public synchronized int totalOperations() { @@ -543,7 +543,7 @@ public class RecoveryState implements ToXContent, Streamable { /** * returns the total number of translog operations to recovered, on the start of the recovery. Unlike {@link #totalOperations} * this does change during recovery. - * <p/> + * <p> * A value of -1 ({@link RecoveryState.Translog#UNKNOWN} is return if this is unknown (typically a gateway recovery) */ public synchronized int totalOperationsOnStart() { diff --git a/core/src/main/java/org/elasticsearch/indices/recovery/RecoveryStatus.java b/core/src/main/java/org/elasticsearch/indices/recovery/RecoveryStatus.java index cef2454391..6e9505f077 100644 --- a/core/src/main/java/org/elasticsearch/indices/recovery/RecoveryStatus.java +++ b/core/src/main/java/org/elasticsearch/indices/recovery/RecoveryStatus.java @@ -148,7 +148,7 @@ public class RecoveryStatus extends AbstractRefCounted { * cancel the recovery. calling this method will clean temporary files and release the store * unless this object is in use (in which case it will be cleaned once all ongoing users call * {@link #decRef()} - * <p/> + * <p> * if {@link #CancellableThreads()} was used, the threads will be interrupted. */ public void cancel(String reason) { @@ -219,7 +219,7 @@ public class RecoveryStatus extends AbstractRefCounted { /** * Creates an {@link org.apache.lucene.store.IndexOutput} for the given file name. Note that the * IndexOutput actually point at a temporary file. - * <p/> + * <p> * Note: You can use {@link #getOpenIndexOutput(String)} with the same filename to retrieve the same IndexOutput * at a later stage */ diff --git a/core/src/main/java/org/elasticsearch/indices/recovery/RecoveryTarget.java b/core/src/main/java/org/elasticsearch/indices/recovery/RecoveryTarget.java index 86d7157e70..10b1b870a1 100644 --- a/core/src/main/java/org/elasticsearch/indices/recovery/RecoveryTarget.java +++ b/core/src/main/java/org/elasticsearch/indices/recovery/RecoveryTarget.java @@ -63,8 +63,8 @@ import static org.elasticsearch.common.unit.TimeValue.timeValueMillis; /** * The recovery target handles recoveries of peer shards of the shard+node to recover to. - * <p/> - * <p>Note, it can be safely assumed that there will only be a single recovery per shard (index+id) and + * <p> + * Note, it can be safely assumed that there will only be a single recovery per shard (index+id) and * not several of them (since we don't allocate several shard replicas to the same node). */ public class RecoveryTarget extends AbstractComponent { diff --git a/core/src/main/java/org/elasticsearch/indices/recovery/StartRecoveryRequest.java b/core/src/main/java/org/elasticsearch/indices/recovery/StartRecoveryRequest.java index 31280dc221..3a62f4f635 100644 --- a/core/src/main/java/org/elasticsearch/indices/recovery/StartRecoveryRequest.java +++ b/core/src/main/java/org/elasticsearch/indices/recovery/StartRecoveryRequest.java @@ -53,11 +53,8 @@ public class StartRecoveryRequest extends TransportRequest { /** * Start recovery request. * - * @param shardId * @param sourceNode The node to recover from * @param targetNode The node to recover to - * @param markAsRelocated - * @param metadataSnapshot */ public StartRecoveryRequest(ShardId shardId, DiscoveryNode sourceNode, DiscoveryNode targetNode, boolean markAsRelocated, Store.MetadataSnapshot metadataSnapshot, RecoveryState.Type recoveryType, long recoveryId) { this.recoveryId = recoveryId; diff --git a/core/src/main/java/org/elasticsearch/monitor/process/ProcessStats.java b/core/src/main/java/org/elasticsearch/monitor/process/ProcessStats.java index 44ef7c7a81..de447c9874 100644 --- a/core/src/main/java/org/elasticsearch/monitor/process/ProcessStats.java +++ b/core/src/main/java/org/elasticsearch/monitor/process/ProcessStats.java @@ -197,7 +197,7 @@ public class ProcessStats implements Streamable, ToXContent { /** * Get the Process cpu usage. * <p> - * <p>Supported Platforms: All. + * Supported Platforms: All. */ public short getPercent() { return percent; diff --git a/core/src/main/java/org/elasticsearch/node/Node.java b/core/src/main/java/org/elasticsearch/node/Node.java index a6fa59e9bc..6d5ebc045f 100644 --- a/core/src/main/java/org/elasticsearch/node/Node.java +++ b/core/src/main/java/org/elasticsearch/node/Node.java @@ -105,7 +105,6 @@ import static org.elasticsearch.common.settings.Settings.settingsBuilder; /** * A node represent a node within a cluster (<tt>cluster.name</tt>). The {@link #client()} can be used * in order to use a {@link Client} to perform actions/operations against the cluster. - * <p/> * <p>In order to create a node, the {@link NodeBuilder} can be used. When done with it, make sure to * call {@link #close()} on it. */ diff --git a/core/src/main/java/org/elasticsearch/node/NodeBuilder.java b/core/src/main/java/org/elasticsearch/node/NodeBuilder.java index 257d380774..377c409ccb 100644 --- a/core/src/main/java/org/elasticsearch/node/NodeBuilder.java +++ b/core/src/main/java/org/elasticsearch/node/NodeBuilder.java @@ -23,32 +23,30 @@ import org.elasticsearch.common.settings.Settings; /** * A node builder is used to construct a {@link Node} instance. - * <p/> - * <p>Settings will be loaded relative to the ES home (with or without <tt>config/</tt> prefix) and if not found, - * within the classpath (with or without <tt>config/<tt> prefix). The settings file loaded can either be named + * <p> + * Settings will be loaded relative to the ES home (with or without <tt>config/</tt> prefix) and if not found, + * within the classpath (with or without <tt>config/</tt> prefix). The settings file loaded can either be named * <tt>elasticsearch.yml</tt> or <tt>elasticsearch.json</tt>). - * <p/> - * <p>Explicit settings can be passed by using the {@link #settings(org.elasticsearch.common.settings.Settings)} method. - * <p/> - * <p>In any case, settings will be resolved from system properties as well that are either prefixed with <tt>es.</tt> + * <p> + * Explicit settings can be passed by using the {@link #settings(org.elasticsearch.common.settings.Settings)} method. + * <p> + * In any case, settings will be resolved from system properties as well that are either prefixed with <tt>es.</tt> * or <tt>elasticsearch.</tt>. - * <p/> - * <p>An example for creating a simple node with optional settings loaded from the classpath: - * <p/> + * <p> + * An example for creating a simple node with optional settings loaded from the classpath: * <pre> * Node node = NodeBuilder.nodeBuilder().node(); * </pre> - * <p/> - * <p>An example for creating a node with explicit settings (in this case, a node in the cluster that does not hold + * <p> + * An example for creating a node with explicit settings (in this case, a node in the cluster that does not hold * data): - * <p/> * <pre> * Node node = NodeBuilder.nodeBuilder() * .settings(Settings.settingsBuilder().put("node.data", false) * .node(); * </pre> - * <p/> - * <p>When done with the node, make sure you call {@link Node#close()} on it. + * <p> + * When done with the node, make sure you call {@link Node#close()} on it. * * */ diff --git a/core/src/main/java/org/elasticsearch/plugins/Plugin.java b/core/src/main/java/org/elasticsearch/plugins/Plugin.java index 986d397f6b..72077954ea 100644 --- a/core/src/main/java/org/elasticsearch/plugins/Plugin.java +++ b/core/src/main/java/org/elasticsearch/plugins/Plugin.java @@ -29,7 +29,7 @@ import java.util.Collections; /** * An extension point allowing to plug in custom functionality. - * <p/> + * <p> * A plugin can be register custom extensions to builtin behavior by implementing <tt>onModule(AnyModule)</tt>, * and registering the extension with the given module. */ diff --git a/core/src/main/java/org/elasticsearch/repositories/RepositoriesService.java b/core/src/main/java/org/elasticsearch/repositories/RepositoriesService.java index b11f91fa7f..9cea2e90ee 100644 --- a/core/src/main/java/org/elasticsearch/repositories/RepositoriesService.java +++ b/core/src/main/java/org/elasticsearch/repositories/RepositoriesService.java @@ -76,7 +76,7 @@ public class RepositoriesService extends AbstractComponent implements ClusterSta /** * Registers new repository in the cluster - * <p/> + * <p> * This method can be only called on the master node. It tries to create a new repository on the master * and if it was successful it adds new repository to cluster metadata. * @@ -151,7 +151,7 @@ public class RepositoriesService extends AbstractComponent implements ClusterSta } /** * Unregisters repository in the cluster - * <p/> + * <p> * This method can be only called on the master node. It removes repository information from cluster metadata. * * @param request unregister repository request @@ -311,7 +311,7 @@ public class RepositoriesService extends AbstractComponent implements ClusterSta /** * Returns registered repository - * <p/> + * <p> * This method is called only on the master node * * @param repository repository name @@ -328,7 +328,7 @@ public class RepositoriesService extends AbstractComponent implements ClusterSta /** * Returns registered index shard repository - * <p/> + * <p> * This method is called only on data nodes * * @param repository repository name @@ -345,7 +345,7 @@ public class RepositoriesService extends AbstractComponent implements ClusterSta /** * Creates a new repository and adds it to the list of registered repositories. - * <p/> + * <p> * If a repository with the same name but different types or settings already exists, it will be closed and * replaced with the new repository. If a repository with the same name exists but it has the same type and settings * the new repository is ignored. diff --git a/core/src/main/java/org/elasticsearch/repositories/Repository.java b/core/src/main/java/org/elasticsearch/repositories/Repository.java index adde0ed1c8..a766c3a4ff 100644 --- a/core/src/main/java/org/elasticsearch/repositories/Repository.java +++ b/core/src/main/java/org/elasticsearch/repositories/Repository.java @@ -29,11 +29,11 @@ import java.util.List; /** * Snapshot repository interface. - * <p/> + * <p> * Responsible for index and cluster level operations. It's called only on master. * Shard-level operations are performed using {@link org.elasticsearch.index.snapshots.IndexShardRepository} * interface on data nodes. - * <p/> + * <p> * Typical snapshot usage pattern: * <ul> * <li>Master calls {@link #initializeSnapshot(org.elasticsearch.cluster.metadata.SnapshotId, List, org.elasticsearch.cluster.metadata.MetaData)} @@ -55,7 +55,7 @@ public interface Repository extends LifecycleComponent<Repository> { /** * Returns global metadata associate with the snapshot. - * <p/> + * <p> * The returned meta data contains global metadata as well as metadata for all indices listed in the indices parameter. * * @param snapshot snapshot @@ -82,7 +82,7 @@ public interface Repository extends LifecycleComponent<Repository> { /** * Finalizes snapshotting process - * <p/> + * <p> * This method is called on master after all shards are snapshotted. * * @param snapshotId snapshot id @@ -113,7 +113,7 @@ public interface Repository extends LifecycleComponent<Repository> { /** * Verifies repository on the master node and returns the verification token. - * <p/> + * <p> * If the verification token is not null, it's passed to all data nodes for verification. If it's null - no * additional verification is required * @@ -123,7 +123,7 @@ public interface Repository extends LifecycleComponent<Repository> { /** * Called at the end of repository verification process. - * <p/> + * <p> * This method should perform all necessary cleanup of the temporary files created in the repository * * @param verificationToken verification request generated by {@link #startVerification} command diff --git a/core/src/main/java/org/elasticsearch/repositories/blobstore/BlobStoreFormat.java b/core/src/main/java/org/elasticsearch/repositories/blobstore/BlobStoreFormat.java index eadba12f9f..2061c235e6 100644 --- a/core/src/main/java/org/elasticsearch/repositories/blobstore/BlobStoreFormat.java +++ b/core/src/main/java/org/elasticsearch/repositories/blobstore/BlobStoreFormat.java @@ -71,7 +71,6 @@ public abstract class BlobStoreFormat<T extends ToXContent> { * @param blobContainer blob container * @param blobName blob name * @return parsed blob object - * @throws IOException */ public abstract T readBlob(BlobContainer blobContainer, String blobName) throws IOException; @@ -81,7 +80,6 @@ public abstract class BlobStoreFormat<T extends ToXContent> { * @param blobContainer blob container * @param name name to be translated into * @return parsed blob object - * @throws IOException */ public T read(BlobContainer blobContainer, String name) throws IOException { String blobName = blobName(name); diff --git a/core/src/main/java/org/elasticsearch/repositories/blobstore/BlobStoreRepository.java b/core/src/main/java/org/elasticsearch/repositories/blobstore/BlobStoreRepository.java index 456457861d..8c5088e757 100644 --- a/core/src/main/java/org/elasticsearch/repositories/blobstore/BlobStoreRepository.java +++ b/core/src/main/java/org/elasticsearch/repositories/blobstore/BlobStoreRepository.java @@ -75,11 +75,10 @@ import java.util.Map; /** * BlobStore - based implementation of Snapshot Repository - * <p/> + * <p> * This repository works with any {@link BlobStore} implementation. The blobStore should be initialized in the derived * class before {@link #doStart()} is called. - * <p/> - * <p/> + * <p> * BlobStoreRepository maintains the following structure in the blob store * <pre> * {@code @@ -229,7 +228,7 @@ public abstract class BlobStoreRepository extends AbstractLifecycleComponent<Rep /** * Returns initialized and ready to use BlobStore - * <p/> + * <p> * This method is first called in the {@link #doStart()} method. * * @return blob store @@ -252,7 +251,7 @@ public abstract class BlobStoreRepository extends AbstractLifecycleComponent<Rep /** * Returns data file chunk size. - * <p/> + * <p> * This method should return null if no chunking is needed. * * @return chunk size @@ -533,7 +532,6 @@ public abstract class BlobStoreRepository extends AbstractLifecycleComponent<Rep /** * In v2.0.0 we changed the matadata file format - * @param version * @return true if legacy version should be used false otherwise */ public static boolean legacyMetaData(Version version) { @@ -553,7 +551,7 @@ public abstract class BlobStoreRepository extends AbstractLifecycleComponent<Rep /** * Writes snapshot index file - * <p/> + * <p> * This file can be used by read-only repositories that are unable to list files in the repository * * @param snapshots list of snapshot ids @@ -583,7 +581,7 @@ public abstract class BlobStoreRepository extends AbstractLifecycleComponent<Rep /** * Reads snapshot index file - * <p/> + * <p> * This file can be used by read-only repositories that are unable to list files in the repository * * @return list of snapshots in the repository diff --git a/core/src/main/java/org/elasticsearch/repositories/blobstore/ChecksumBlobStoreFormat.java b/core/src/main/java/org/elasticsearch/repositories/blobstore/ChecksumBlobStoreFormat.java index 9109dcd84b..b15da26e3f 100644 --- a/core/src/main/java/org/elasticsearch/repositories/blobstore/ChecksumBlobStoreFormat.java +++ b/core/src/main/java/org/elasticsearch/repositories/blobstore/ChecksumBlobStoreFormat.java @@ -88,8 +88,6 @@ public class ChecksumBlobStoreFormat<T extends ToXContent> extends BlobStoreForm * * @param blobContainer blob container * @param blobName blob name - * @return - * @throws IOException */ public T readBlob(BlobContainer blobContainer, String blobName) throws IOException { try (InputStream inputStream = blobContainer.readBlob(blobName)) { @@ -113,7 +111,7 @@ public class ChecksumBlobStoreFormat<T extends ToXContent> extends BlobStoreForm /** * Writes blob in atomic manner with resolving the blob name using {@link #blobName} and {@link #tempBlobName} methods. - * <p/> + * <p> * The blob will be compressed and checksum will be written if required. * * Atomic move might be very inefficient on some repositories. It also cannot override existing files. @@ -121,7 +119,6 @@ public class ChecksumBlobStoreFormat<T extends ToXContent> extends BlobStoreForm * @param obj object to be serialized * @param blobContainer blob container * @param name blob name - * @throws IOException */ public void writeAtomic(T obj, BlobContainer blobContainer, String name) throws IOException { String blobName = blobName(name); @@ -138,13 +135,12 @@ public class ChecksumBlobStoreFormat<T extends ToXContent> extends BlobStoreForm /** * Writes blob with resolving the blob name using {@link #blobName} method. - * <p/> + * <p> * The blob will be compressed and checksum will be written if required. * * @param obj object to be serialized * @param blobContainer blob container * @param name blob name - * @throws IOException */ public void write(T obj, BlobContainer blobContainer, String name) throws IOException { String blobName = blobName(name); @@ -153,13 +149,12 @@ public class ChecksumBlobStoreFormat<T extends ToXContent> extends BlobStoreForm /** * Writes blob in atomic manner without resolving the blobName using using {@link #blobName} method. - * <p/> + * <p> * The blob will be compressed and checksum will be written if required. * * @param obj object to be serialized * @param blobContainer blob container * @param blobName blob name - * @throws IOException */ protected void writeBlob(T obj, BlobContainer blobContainer, String blobName) throws IOException { BytesReference bytes = write(obj); diff --git a/core/src/main/java/org/elasticsearch/repositories/blobstore/LegacyBlobStoreFormat.java b/core/src/main/java/org/elasticsearch/repositories/blobstore/LegacyBlobStoreFormat.java index a0c956dea4..206371261e 100644 --- a/core/src/main/java/org/elasticsearch/repositories/blobstore/LegacyBlobStoreFormat.java +++ b/core/src/main/java/org/elasticsearch/repositories/blobstore/LegacyBlobStoreFormat.java @@ -49,7 +49,6 @@ public class LegacyBlobStoreFormat<T extends ToXContent> extends BlobStoreFormat * @param blobContainer blob container * @param blobName blob name * @return parsed blob object - * @throws IOException */ public T readBlob(BlobContainer blobContainer, String blobName) throws IOException { try (InputStream inputStream = blobContainer.readBlob(blobName)) { diff --git a/core/src/main/java/org/elasticsearch/repositories/fs/FsRepository.java b/core/src/main/java/org/elasticsearch/repositories/fs/FsRepository.java index 0071cc9500..478158282d 100644 --- a/core/src/main/java/org/elasticsearch/repositories/fs/FsRepository.java +++ b/core/src/main/java/org/elasticsearch/repositories/fs/FsRepository.java @@ -37,14 +37,14 @@ import java.nio.file.Paths; /** * Shared file system implementation of the BlobStoreRepository - * <p/> + * <p> * Shared file system repository supports the following settings * <dl> * <dt>{@code location}</dt><dd>Path to the root of repository. This is mandatory parameter.</dd> * <dt>{@code concurrent_streams}</dt><dd>Number of concurrent read/write stream (per repository on each node). Defaults to 5.</dd> * <dt>{@code chunk_size}</dt><dd>Large file can be divided into chunks. This parameter specifies the chunk size. Defaults to not chucked.</dd> * <dt>{@code compress}</dt><dd>If set to true metadata files will be stored compressed. Defaults to false.</dd> - * </ol> + * </dl> */ public class FsRepository extends BlobStoreRepository { @@ -64,7 +64,6 @@ public class FsRepository extends BlobStoreRepository { * @param name repository name * @param repositorySettings repository settings * @param indexShardRepository index shard repository - * @throws IOException */ @Inject public FsRepository(RepositoryName name, RepositorySettings repositorySettings, IndexShardRepository indexShardRepository, Environment environment) throws IOException { diff --git a/core/src/main/java/org/elasticsearch/repositories/uri/URLRepository.java b/core/src/main/java/org/elasticsearch/repositories/uri/URLRepository.java index 922c487846..4d361683e5 100644 --- a/core/src/main/java/org/elasticsearch/repositories/uri/URLRepository.java +++ b/core/src/main/java/org/elasticsearch/repositories/uri/URLRepository.java @@ -40,12 +40,12 @@ import java.util.List; /** * Read-only URL-based implementation of the BlobStoreRepository - * <p/> + * <p> * This repository supports the following settings * <dl> * <dt>{@code url}</dt><dd>URL to the root of repository. This is mandatory parameter.</dd> * <dt>{@code concurrent_streams}</dt><dd>Number of concurrent read/write stream (per repository on each node). Defaults to 5.</dd> - * </ol> + * </dl> */ public class URLRepository extends BlobStoreRepository { @@ -75,7 +75,6 @@ public class URLRepository extends BlobStoreRepository { * @param name repository name * @param repositorySettings repository settings * @param indexShardRepository shard repository - * @throws IOException */ @Inject public URLRepository(RepositoryName name, RepositorySettings repositorySettings, IndexShardRepository indexShardRepository, Environment environment) throws IOException { diff --git a/core/src/main/java/org/elasticsearch/rest/BaseRestHandler.java b/core/src/main/java/org/elasticsearch/rest/BaseRestHandler.java index 927c41c153..1ae1e57569 100644 --- a/core/src/main/java/org/elasticsearch/rest/BaseRestHandler.java +++ b/core/src/main/java/org/elasticsearch/rest/BaseRestHandler.java @@ -30,8 +30,8 @@ import java.util.Set; /** * Base handler for REST requests. - * <p/> - * This handler makes sure that the headers & context of the handled {@link RestRequest requests} are copied over to + * <p> + * This handler makes sure that the headers & context of the handled {@link RestRequest requests} are copied over to * the transport requests executed by the associated client. While the context is fully copied over, not all the headers * are copied, but a selected few. It is possible to control what headers are copied over by registering them using * {@link org.elasticsearch.rest.RestController#registerRelevantHeaders(String...)} @@ -83,4 +83,4 @@ public abstract class BaseRestHandler extends AbstractComponent implements RestH super.doExecute(action, request, listener); } } -}
\ No newline at end of file +} diff --git a/core/src/main/java/org/elasticsearch/rest/RestController.java b/core/src/main/java/org/elasticsearch/rest/RestController.java index 3e3360337d..cc6c09a20a 100644 --- a/core/src/main/java/org/elasticsearch/rest/RestController.java +++ b/core/src/main/java/org/elasticsearch/rest/RestController.java @@ -179,8 +179,6 @@ public class RestController extends AbstractLifecycleComponent<RestController> { /** * Checks the request parameters against enabled settings for error trace support - * @param request - * @param channel * @return true if the request does not have any parameters that conflict with system settings */ boolean checkRequestParameters(final RestRequest request, final RestChannel channel) { diff --git a/core/src/main/java/org/elasticsearch/rest/RestStatus.java b/core/src/main/java/org/elasticsearch/rest/RestStatus.java index ee0e7ef57a..d78b9c50e0 100644 --- a/core/src/main/java/org/elasticsearch/rest/RestStatus.java +++ b/core/src/main/java/org/elasticsearch/rest/RestStatus.java @@ -59,8 +59,8 @@ public enum RestStatus { * entity format is specified by the media type given in the Content-Type header field. The origin server MUST * create the resource before returning the 201 status code. If the action cannot be carried out immediately, the * server SHOULD respond with 202 (Accepted) response instead. - * <p/> - * <p>A 201 response MAY contain an ETag response header field indicating the current value of the entity tag + * <p> + * A 201 response MAY contain an ETag response header field indicating the current value of the entity tag * for the requested variant just created, see section 14.19. */ CREATED(201), @@ -68,8 +68,8 @@ public enum RestStatus { * The request has been accepted for processing, but the processing has not been completed. The request might * or might not eventually be acted upon, as it might be disallowed when processing actually takes place. There * is no facility for re-sending a status code from an asynchronous operation such as this. - * <p/> - * <p>The 202 response is intentionally non-committal. Its purpose is to allow a server to accept a request for + * <p> + * The 202 response is intentionally non-committal. Its purpose is to allow a server to accept a request for * some other process (perhaps a batch-oriented process that is only run once per day) without requiring that * the user agent's connection to the server persist until the process is completed. The entity returned with * this response SHOULD include an indication of the request's current status and either a pointer to a status @@ -88,13 +88,13 @@ public enum RestStatus { * The server has fulfilled the request but does not need to return an entity-body, and might want to return * updated meta information. The response MAY include new or updated meta information in the form of * entity-headers, which if present SHOULD be associated with the requested variant. - * <p/> - * <p>If the client is a user agent, it SHOULD NOT change its document view from that which caused the request + * <p> + * If the client is a user agent, it SHOULD NOT change its document view from that which caused the request * to be sent. This response is primarily intended to allow input for actions to take place without causing a * change to the user agent's active document view, although any new or updated meta information SHOULD be * applied to the document currently in the user agent's active view. - * <p/> - * <p>The 204 response MUST NOT include a message-body, and thus is always terminated by the first empty + * <p> + * The 204 response MUST NOT include a message-body, and thus is always terminated by the first empty * line after the header fields. */ NO_CONTENT(204), @@ -109,8 +109,8 @@ public enum RestStatus { * The server has fulfilled the partial GET request for the resource. The request MUST have included a Range * header field (section 14.35) indicating the desired range, and MAY have included an If-Range header * field (section 14.27) to make the request conditional. - * <p/> - * <p>The response MUST include the following header fields: + * <p> + * The response MUST include the following header fields: * <ul> * <li>Either a Content-Range header field (section 14.16) indicating the range included with this response, * or a multipart/byteranges Content-Type including Content-Range fields for each part. If a Content-Length @@ -121,34 +121,34 @@ public enum RestStatus { * <li>Expires, Cache-Control, and/or Vary, if the field-value might differ from that sent in any previous * response for the same variant</li> * </ul> - * <p/> - * <p>If the 206 response is the result of an If-Range request that used a strong cache validator + * <p> + * If the 206 response is the result of an If-Range request that used a strong cache validator * (see section 13.3.3), the response SHOULD NOT include other entity-headers. If the response is the result * of an If-Range request that used a weak validator, the response MUST NOT include other entity-headers; * this prevents inconsistencies between cached entity-bodies and updated headers. Otherwise, the response MUST * include all of the entity-headers that would have been returned with a 200 (OK) response to the same request. - * <p/> - * <p>A cache MUST NOT combine a 206 response with other previously cached content if the ETag or Last-Modified + * <p> + * A cache MUST NOT combine a 206 response with other previously cached content if the ETag or Last-Modified * headers do not match exactly, see 13.5.4. - * <p/> - * <p>A cache that does not support the Range and Content-Range headers MUST NOT cache 206 (Partial) responses. + * <p> + * A cache that does not support the Range and Content-Range headers MUST NOT cache 206 (Partial) responses. */ PARTIAL_CONTENT(206), /** * The 207 (Multi-Status) status code provides status for multiple independent operations (see Section 13 for * more information). - * <p/> - * <p>A Multi-Status response conveys information about multiple resources in situations where multiple status + * <p> + * A Multi-Status response conveys information about multiple resources in situations where multiple status * codes might be appropriate. The default Multi-Status response body is a text/xml or application/xml HTTP * entity with a 'multistatus' root element. Further elements contain 200, 300, 400, and 500 series status codes * generated during the method invocation. 100 series status codes SHOULD NOT be recorded in a 'response' * XML element. - * <p/> - * <p>Although '207' is used as the overall response status code, the recipient needs to consult the contents + * <p> + * Although '207' is used as the overall response status code, the recipient needs to consult the contents * of the multistatus response body for further information about the success or failure of the method execution. * The response MAY be used in success, partial success and also in failure situations. - * <p/> - * <p>The 'multistatus' root element holds zero or more 'response' elements in any order, each with + * <p> + * The 'multistatus' root element holds zero or more 'response' elements in any order, each with * information about an individual resource. Each 'response' element MUST have an 'href' element * to identify the resource. */ @@ -157,14 +157,14 @@ public enum RestStatus { * The requested resource corresponds to any one of a set of representations, each with its own specific * location, and agent-driven negotiation information (section 12) is being provided so that the user (or user * agent) can select a preferred representation and redirect its request to that location. - * <p/> - * <p>Unless it was a HEAD request, the response SHOULD include an entity containing a list of resource + * <p> + * Unless it was a HEAD request, the response SHOULD include an entity containing a list of resource * characteristics and location(s) from which the user or user agent can choose the one most appropriate. * The entity format is specified by the media type given in the Content-Type header field. Depending upon the * format and the capabilities of the user agent, selection of the most appropriate choice MAY be performed * automatically. However, this specification does not define any standard for such automatic selection. - * <p/> - * <p>If the server has a preferred choice of representation, it SHOULD include the specific URI for that + * <p> + * If the server has a preferred choice of representation, it SHOULD include the specific URI for that * representation in the Location field; user agents MAY use the Location field value for automatic redirection. * This response is cacheable unless indicated otherwise. */ @@ -174,11 +174,11 @@ public enum RestStatus { * SHOULD use one of the returned URIs. Clients with link editing capabilities ought to automatically re-link * references to the Request-URI to one or more of the new references returned by the server, where possible. * This response is cacheable unless indicated otherwise. - * <p/> - * <p>The new permanent URI SHOULD be given by the Location field in the response. Unless the request method + * <p> + * The new permanent URI SHOULD be given by the Location field in the response. Unless the request method * was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s). - * <p/> - * <p>If the 301 status code is received in response to a request other than GET or HEAD, the user agent + * <p> + * If the 301 status code is received in response to a request other than GET or HEAD, the user agent * MUST NOT automatically redirect the request unless it can be confirmed by the user, since this might change * the conditions under which the request was issued. */ @@ -187,11 +187,11 @@ public enum RestStatus { * The requested resource resides temporarily under a different URI. Since the redirection might be altered on * occasion, the client SHOULD continue to use the Request-URI for future requests. This response is only * cacheable if indicated by a Cache-Control or Expires header field. - * <p/> - * <p>The temporary URI SHOULD be given by the Location field in the response. Unless the request method was + * <p> + * The temporary URI SHOULD be given by the Location field in the response. Unless the request method was * HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s). - * <p/> - * <p>If the 302 status code is received in response to a request other than GET or HEAD, the user agent + * <p> + * If the 302 status code is received in response to a request other than GET or HEAD, the user agent * MUST NOT automatically redirect the request unless it can be confirmed by the user, since this might change * the conditions under which the request was issued. */ @@ -202,8 +202,8 @@ public enum RestStatus { * user agent to a selected resource. The new URI is not a substitute reference for the originally requested * resource. The 303 response MUST NOT be cached, but the response to the second (redirected) request might be * cacheable. - * <p/> - * <p>The different URI SHOULD be given by the Location field in the response. Unless the request method was + * <p> + * The different URI SHOULD be given by the Location field in the response. Unless the request method was * HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s). */ SEE_OTHER(303), @@ -211,8 +211,8 @@ public enum RestStatus { * If the client has performed a conditional GET request and access is allowed, but the document has not been * modified, the server SHOULD respond with this status code. The 304 response MUST NOT contain a message-body, * and thus is always terminated by the first empty line after the header fields. - * <p/> - * <p>The response MUST include the following header fields: + * <p> + * The response MUST include the following header fields: * <ul> * <li>Date, unless its omission is required by section 14.18.1 * If a clockless origin server obeys these rules, and proxies and clients add their own Date to any @@ -223,15 +223,15 @@ public enum RestStatus { * <li>Expires, Cache-Control, and/or Vary, if the field-value might differ from that sent in any previous * response for the same variant</li> * </ul> - * <p/> - * <p>If the conditional GET used a strong cache validator (see section 13.3.3), the response SHOULD NOT include + * <p> + * If the conditional GET used a strong cache validator (see section 13.3.3), the response SHOULD NOT include * other entity-headers. Otherwise (i.e., the conditional GET used a weak validator), the response MUST NOT * include other entity-headers; this prevents inconsistencies between cached entity-bodies and updated headers. - * <p/> - * <p>If a 304 response indicates an entity not currently cached, then the cache MUST disregard the response + * <p> + * If a 304 response indicates an entity not currently cached, then the cache MUST disregard the response * and repeat the request without the conditional. - * <p/> - * <p>If a cache uses a received 304 response to update a cache entry, the cache MUST update the entry to + * <p> + * If a cache uses a received 304 response to update a cache entry, the cache MUST update the entry to * reflect any new field values given in the response. */ NOT_MODIFIED(304), @@ -245,13 +245,13 @@ public enum RestStatus { * The requested resource resides temporarily under a different URI. Since the redirection MAY be altered on * occasion, the client SHOULD continue to use the Request-URI for future requests. This response is only * cacheable if indicated by a Cache-Control or Expires header field. - * <p/> - * <p>The temporary URI SHOULD be given by the Location field in the response. Unless the request method was + * <p> + * The temporary URI SHOULD be given by the Location field in the response. Unless the request method was * HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s) , * since many pre-HTTP/1.1 user agents do not understand the 307 status. Therefore, the note SHOULD contain * the information necessary for a user to repeat the original request on the new URI. - * <p/> - * <p>If the 307 status code is received in response to a request other than GET or HEAD, the user agent MUST NOT + * <p> + * If the 307 status code is received in response to a request other than GET or HEAD, the user agent MUST NOT * automatically redirect the request unless it can be confirmed by the user, since this might change the * conditions under which the request was issued. */ @@ -300,18 +300,18 @@ public enum RestStatus { /** * The resource identified by the request is only capable of generating response entities which have content * characteristics not acceptable according to the accept headers sent in the request. - * <p/> - * <p>Unless it was a HEAD request, the response SHOULD include an entity containing a list of available entity + * <p> + * Unless it was a HEAD request, the response SHOULD include an entity containing a list of available entity * characteristics and location(s) from which the user or user agent can choose the one most appropriate. * The entity format is specified by the media type given in the Content-Type header field. Depending upon the * format and the capabilities of the user agent, selection of the most appropriate choice MAY be performed * automatically. However, this specification does not define any standard for such automatic selection. - * <p/> - * <p>Note: HTTP/1.1 servers are allowed to return responses which are not acceptable according to the accept + * <p> + * Note: HTTP/1.1 servers are allowed to return responses which are not acceptable according to the accept * headers sent in the request. In some cases, this may even be preferable to sending a 406 response. User * agents are encouraged to inspect the headers of an incoming response to determine if it is acceptable. - * <p/> - * <p>If the response could be unacceptable, a user agent SHOULD temporarily stop receipt of more data and query + * <p> + * If the response could be unacceptable, a user agent SHOULD temporarily stop receipt of more data and query * the user for a decision on further actions. */ NOT_ACCEPTABLE(406), @@ -334,8 +334,8 @@ public enum RestStatus { * resubmit the request. The response body SHOULD include enough information for the user to recognize the * source of the conflict. Ideally, the response entity would include enough information for the user or user * agent to fix the problem; however, that might not be possible and is not required. - * <p/> - * <p>Conflicts are most likely to occur in response to a PUT request. For example, if versioning were being + * <p> + * Conflicts are most likely to occur in response to a PUT request. For example, if versioning were being * used and the entity being PUT included changes to a resource which conflict with those made by an earlier * (third-party) request, the server might use the 409 response to indicate that it can't complete the request. * In this case, the response entity would likely contain a list of the differences between the two versions in @@ -348,8 +348,8 @@ public enum RestStatus { * the Request-URI after user approval. If the server does not know, or has no facility to determine, whether or * not the condition is permanent, the status code 404 (Not Found) SHOULD be used instead. This response is * cacheable unless indicated otherwise. - * <p/> - * <p>The 410 response is primarily intended to assist the task of web maintenance by notifying the recipient + * <p> + * The 410 response is primarily intended to assist the task of web maintenance by notifying the recipient * that the resource is intentionally unavailable and that the server owners desire that remote links to that * resource be removed. Such an event is common for limited-time, promotional services and for resources belonging * to individuals no longer working at the server's site. It is not necessary to mark all permanently unavailable @@ -372,8 +372,8 @@ public enum RestStatus { /** * The server is refusing to process a request because the request entity is larger than the server is willing * or able to process. The server MAY close the connection to prevent the client from continuing the request. - * <p/> - * <p>If the condition is temporary, the server SHOULD include a Retry-After header field to indicate that it + * <p> + * If the condition is temporary, the server SHOULD include a Retry-After header field to indicate that it * is temporary and after what time the client MAY try again. */ REQUEST_ENTITY_TOO_LARGE(413), @@ -397,8 +397,8 @@ public enum RestStatus { * selected resource, and the request did not include an If-Range request-header field. (For byte-ranges, this * means that the first-byte-pos of all of the byte-range-spec values were greater than the current length of * the selected resource.) - * <p/> - * <p>When this status code is returned for a byte-range request, the response SHOULD include a Content-Range + * <p> + * When this status code is returned for a byte-range request, the response SHOULD include a Content-Range * entity-header field specifying the current length of the selected resource (see section 14.16). This * response MUST NOT use the multipart/byteranges content-type. */ diff --git a/core/src/main/java/org/elasticsearch/rest/action/cat/RestNodesAction.java b/core/src/main/java/org/elasticsearch/rest/action/cat/RestNodesAction.java index f29b3521ca..8ccf2017a8 100644 --- a/core/src/main/java/org/elasticsearch/rest/action/cat/RestNodesAction.java +++ b/core/src/main/java/org/elasticsearch/rest/action/cat/RestNodesAction.java @@ -362,7 +362,7 @@ public class RestNodesAction extends AbstractCatAction { * Calculate the percentage of {@code used} from the {@code max} number. * @param used The currently used number. * @param max The maximum number. - * @return 0 if {@code max} is <= 0. Otherwise 100 * {@code used} / {@code max}. + * @return 0 if {@code max} is <= 0. Otherwise 100 * {@code used} / {@code max}. */ private short calculatePercentage(long used, long max) { return max <= 0 ? 0 : (short)((100d * used) / max); diff --git a/core/src/main/java/org/elasticsearch/rest/support/RestUtils.java b/core/src/main/java/org/elasticsearch/rest/support/RestUtils.java index 6bb9d9080b..2d8237e4ed 100644 --- a/core/src/main/java/org/elasticsearch/rest/support/RestUtils.java +++ b/core/src/main/java/org/elasticsearch/rest/support/RestUtils.java @@ -104,7 +104,7 @@ public class RestUtils { /** * Decodes a bit of an URL encoded by a browser. - * <p/> + * <p> * This is equivalent to calling {@link #decodeComponent(String, Charset)} * with the UTF-8 charset (recommended to comply with RFC 3986, Section 2). * @@ -120,13 +120,13 @@ public class RestUtils { /** * Decodes a bit of an URL encoded by a browser. - * <p/> + * <p> * The string is expected to be encoded as per RFC 3986, Section 2. * This is the encoding used by JavaScript functions {@code encodeURI} * and {@code encodeURIComponent}, but not {@code escape}. For example * in this encoding, é (in Unicode {@code U+00E9} or in UTF-8 * {@code 0xC3 0xA9}) is encoded as {@code %C3%A9} or {@code %c3%a9}. - * <p/> + * <p> * This is essentially equivalent to calling * <code>{@link java.net.URLDecoder URLDecoder}.{@link * java.net.URLDecoder#decode(String, String)}</code> diff --git a/core/src/main/java/org/elasticsearch/script/AbstractSearchScript.java b/core/src/main/java/org/elasticsearch/script/AbstractSearchScript.java index 7da1a31070..658131202a 100644 --- a/core/src/main/java/org/elasticsearch/script/AbstractSearchScript.java +++ b/core/src/main/java/org/elasticsearch/script/AbstractSearchScript.java @@ -28,12 +28,12 @@ import java.util.Map; /** * A base class for any script type that is used during the search process (custom score, aggs, and so on). - * <p/> - * <p>If the script returns a specific numeric type, consider overriding the type specific base classes + * <p> + * If the script returns a specific numeric type, consider overriding the type specific base classes * such as {@link AbstractDoubleSearchScript}, {@link AbstractFloatSearchScript} and {@link AbstractLongSearchScript} * for better performance. - * <p/> - * <p>The use is required to implement the {@link #run()} method. + * <p> + * The use is required to implement the {@link #run()} method. */ public abstract class AbstractSearchScript extends AbstractExecutableScript implements LeafSearchScript { @@ -130,4 +130,4 @@ public abstract class AbstractSearchScript extends AbstractExecutableScript impl public double runAsDouble() { return ((Number) run()).doubleValue(); } -}
\ No newline at end of file +} diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/AggregationBuilders.java b/core/src/main/java/org/elasticsearch/search/aggregations/AggregationBuilders.java index 1cc0f71bf2..13a162df7f 100644 --- a/core/src/main/java/org/elasticsearch/search/aggregations/AggregationBuilders.java +++ b/core/src/main/java/org/elasticsearch/search/aggregations/AggregationBuilders.java @@ -218,7 +218,7 @@ public class AggregationBuilders { } /** - * Create a new {@link DateHistogram} aggregation with the given name. + * Create a new {@link DateHistogramBuilder} aggregation with the given name. */ public static DateHistogramBuilder dateHistogram(String name) { return new DateHistogramBuilder(name); @@ -232,14 +232,14 @@ public class AggregationBuilders { } /** - * Create a new {@link DateRange} aggregation with the given name. + * Create a new {@link DateRangeBuilder} aggregation with the given name. */ public static DateRangeBuilder dateRange(String name) { return new DateRangeBuilder(name); } /** - * Create a new {@link IPv4Range} aggregation with the given name. + * Create a new {@link IPv4RangeBuilder} aggregation with the given name. */ public static IPv4RangeBuilder ipRange(String name) { return new IPv4RangeBuilder(name); diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/Aggregator.java b/core/src/main/java/org/elasticsearch/search/aggregations/Aggregator.java index 33244f36f0..8ee4d1f73b 100644 --- a/core/src/main/java/org/elasticsearch/search/aggregations/Aggregator.java +++ b/core/src/main/java/org/elasticsearch/search/aggregations/Aggregator.java @@ -40,7 +40,7 @@ public abstract class Aggregator extends BucketCollector implements Releasable { /** * Parses the aggregation request and creates the appropriate aggregator factory for it. * - * @see {@link AggregatorFactory} + * @see AggregatorFactory */ public interface Parser { diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/bucket/BestDocsDeferringCollector.java b/core/src/main/java/org/elasticsearch/search/aggregations/bucket/BestDocsDeferringCollector.java index 68ef8aa7c0..22ff6df81f 100644 --- a/core/src/main/java/org/elasticsearch/search/aggregations/bucket/BestDocsDeferringCollector.java +++ b/core/src/main/java/org/elasticsearch/search/aggregations/bucket/BestDocsDeferringCollector.java @@ -63,7 +63,6 @@ public class BestDocsDeferringCollector extends DeferringBucketCollector impleme * * @param shardSize * The number of top-scoring docs to collect for each bucket - * @param bigArrays */ public BestDocsDeferringCollector(int shardSize, BigArrays bigArrays) { this.shardSize = shardSize; diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/bucket/BucketsAggregator.java b/core/src/main/java/org/elasticsearch/search/aggregations/bucket/BucketsAggregator.java index e0b27bb291..a7f01e4414 100644 --- a/core/src/main/java/org/elasticsearch/search/aggregations/bucket/BucketsAggregator.java +++ b/core/src/main/java/org/elasticsearch/search/aggregations/bucket/BucketsAggregator.java @@ -73,7 +73,7 @@ public abstract class BucketsAggregator extends AggregatorBase { } /** - * Same as {@link #collectBucket(int, long)}, but doesn't check if the docCounts needs to be re-sized. + * Same as {@link #collectBucket(LeafBucketCollector, int, long)}, but doesn't check if the docCounts needs to be re-sized. */ public final void collectExistingBucket(LeafBucketCollector subCollector, int doc, long bucketOrd) throws IOException { docCounts.increment(bucketOrd, 1); diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/bucket/filters/FiltersAggregationBuilder.java b/core/src/main/java/org/elasticsearch/search/aggregations/bucket/filters/FiltersAggregationBuilder.java index c66e3f90ca..6f61a89164 100644 --- a/core/src/main/java/org/elasticsearch/search/aggregations/bucket/filters/FiltersAggregationBuilder.java +++ b/core/src/main/java/org/elasticsearch/search/aggregations/bucket/filters/FiltersAggregationBuilder.java @@ -50,7 +50,7 @@ public class FiltersAggregationBuilder extends AggregationBuilder<FiltersAggrega /** * Add a new filter with the given key. * NOTE: if a filter was already defined for this key, then this filter will replace it. - * NOTE: the same {@link FiltersBuilder} cannot have both keyed and non-keyed filters + * NOTE: the same {@link FiltersAggregationBuilder} cannot have both keyed and non-keyed filters */ public FiltersAggregationBuilder filter(String key, QueryBuilder filter) { if (keyedFilters == null) { @@ -62,7 +62,7 @@ public class FiltersAggregationBuilder extends AggregationBuilder<FiltersAggrega /** * Add a new filter with no key. - * NOTE: the same {@link FiltersBuilder} cannot have both keyed and non-keyed filters. + * NOTE: the same {@link FiltersAggregationBuilder} cannot have both keyed and non-keyed filters. */ public FiltersAggregationBuilder filter(QueryBuilder filter) { if (nonKeyedFilters == null) { diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/bucket/histogram/DateHistogramBuilder.java b/core/src/main/java/org/elasticsearch/search/aggregations/bucket/histogram/DateHistogramBuilder.java index 6b7305db9e..67caf37b66 100644 --- a/core/src/main/java/org/elasticsearch/search/aggregations/bucket/histogram/DateHistogramBuilder.java +++ b/core/src/main/java/org/elasticsearch/search/aggregations/bucket/histogram/DateHistogramBuilder.java @@ -28,7 +28,7 @@ import org.joda.time.DateTime; import java.io.IOException; /** - * Builder for the {@link DateHistogram} aggregation. + * Builder for the {@code DateHistogram} aggregation. */ public class DateHistogramBuilder extends ValuesSourceAggregationBuilder<DateHistogramBuilder> { diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/bucket/range/RangeBuilder.java b/core/src/main/java/org/elasticsearch/search/aggregations/bucket/range/RangeBuilder.java index bcd31758fb..acb55f68ea 100644 --- a/core/src/main/java/org/elasticsearch/search/aggregations/bucket/range/RangeBuilder.java +++ b/core/src/main/java/org/elasticsearch/search/aggregations/bucket/range/RangeBuilder.java @@ -23,7 +23,7 @@ import org.elasticsearch.common.xcontent.XContentBuilder; import java.io.IOException; /** - * Builder for the {@link Range} aggregation. + * Builder for the {@link org.elasticsearch.search.aggregations.bucket.range.AbstractRangeBuilder.Range} aggregation. */ public class RangeBuilder extends AbstractRangeBuilder<RangeBuilder> { diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/bucket/range/date/DateRangeBuilder.java b/core/src/main/java/org/elasticsearch/search/aggregations/bucket/range/date/DateRangeBuilder.java index aad1f21185..35c8a3011d 100644 --- a/core/src/main/java/org/elasticsearch/search/aggregations/bucket/range/date/DateRangeBuilder.java +++ b/core/src/main/java/org/elasticsearch/search/aggregations/bucket/range/date/DateRangeBuilder.java @@ -24,7 +24,7 @@ import org.elasticsearch.search.aggregations.bucket.range.AbstractRangeBuilder; import java.io.IOException; /** - * Builder for the {@link DateRange} aggregation. + * Builder for the {@code DateRange} aggregation. */ public class DateRangeBuilder extends AbstractRangeBuilder<DateRangeBuilder> { @@ -50,7 +50,7 @@ public class DateRangeBuilder extends AbstractRangeBuilder<DateRangeBuilder> { } /** - * Same as {@link #addRange(String, double, double)} but the key will be + * Same as {@link #addRange(String, Object, Object)} but the key will be * automatically generated based on <code>from</code> and <code>to</code>. */ public DateRangeBuilder addRange(Object from, Object to) { @@ -69,7 +69,7 @@ public class DateRangeBuilder extends AbstractRangeBuilder<DateRangeBuilder> { } /** - * Same as {@link #addUnboundedTo(String, double)} but the key will be + * Same as {@link #addUnboundedTo(String, Object)} but the key will be * computed automatically. */ public DateRangeBuilder addUnboundedTo(Object to) { @@ -88,7 +88,7 @@ public class DateRangeBuilder extends AbstractRangeBuilder<DateRangeBuilder> { } /** - * Same as {@link #addUnboundedFrom(String, double)} but the key will be + * Same as {@link #addUnboundedFrom(String, Object)} but the key will be * computed automatically. */ public DateRangeBuilder addUnboundedFrom(Object from) { diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/bucket/range/ipv4/IPv4RangeBuilder.java b/core/src/main/java/org/elasticsearch/search/aggregations/bucket/range/ipv4/IPv4RangeBuilder.java index 6d17bee576..218f0dcbc9 100644 --- a/core/src/main/java/org/elasticsearch/search/aggregations/bucket/range/ipv4/IPv4RangeBuilder.java +++ b/core/src/main/java/org/elasticsearch/search/aggregations/bucket/range/ipv4/IPv4RangeBuilder.java @@ -25,7 +25,7 @@ import org.elasticsearch.search.builder.SearchSourceBuilderException; import java.util.regex.Pattern; /** - * Builder for the {@link IPv4Range} aggregation. + * Builder for the {@code IPv4Range} aggregation. */ public class IPv4RangeBuilder extends AbstractRangeBuilder<IPv4RangeBuilder> { @@ -110,7 +110,7 @@ public class IPv4RangeBuilder extends AbstractRangeBuilder<IPv4RangeBuilder> { } /** - * Computes the min & max ip addresses (represented as long values - same way as stored in index) represented by the given CIDR mask + * Computes the min & max ip addresses (represented as long values - same way as stored in index) represented by the given CIDR mask * expression. The returned array has the length of 2, where the first entry represents the {@code min} address and the second the {@code max}. * A {@code -1} value for either the {@code min} or the {@code max}, represents an unbounded end. In other words: * @@ -123,9 +123,6 @@ public class IPv4RangeBuilder extends AbstractRangeBuilder<IPv4RangeBuilder> { * <p> * {@code max == -1 == "255.255.255.255" } * </p> - * - * @param cidr - * @return */ static long[] cidrMaskToMinMax(String cidr) { String[] parts = MASK_PATTERN.split(cidr); diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/bucket/significant/SignificantTermsBuilder.java b/core/src/main/java/org/elasticsearch/search/aggregations/bucket/significant/SignificantTermsBuilder.java index 046b1c55a4..b67ce2a1f9 100644 --- a/core/src/main/java/org/elasticsearch/search/aggregations/bucket/significant/SignificantTermsBuilder.java +++ b/core/src/main/java/org/elasticsearch/search/aggregations/bucket/significant/SignificantTermsBuilder.java @@ -31,7 +31,7 @@ import java.io.IOException; /** * Creates an aggregation that finds interesting or unusual occurrences of terms in a result set. - * <p/> + * <p> * This feature is marked as experimental, and may be subject to change in the future. If you * use this feature, please let us know your experience with it! */ diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/bucket/terms/TermsBuilder.java b/core/src/main/java/org/elasticsearch/search/aggregations/bucket/terms/TermsBuilder.java index 1125abdc82..9bc1f7a9a6 100644 --- a/core/src/main/java/org/elasticsearch/search/aggregations/bucket/terms/TermsBuilder.java +++ b/core/src/main/java/org/elasticsearch/search/aggregations/bucket/terms/TermsBuilder.java @@ -88,7 +88,7 @@ public class TermsBuilder extends ValuesSourceAggregationBuilder<TermsBuilder> { * Define a regular expression that will determine what terms should be aggregated. The regular expression is based * on the {@link RegExp} class. * - * @see {@link RegExp#RegExp(String)} + * @see RegExp#RegExp(String) */ public TermsBuilder include(String regex) { if (includeTerms != null) { @@ -152,7 +152,7 @@ public class TermsBuilder extends ValuesSourceAggregationBuilder<TermsBuilder> { * Define a regular expression that will filter out terms that should be excluded from the aggregation. The regular * expression is based on the {@link RegExp} class. * - * @see {@link RegExp#RegExp(String)} + * @see RegExp#RegExp(String) */ public TermsBuilder exclude(String regex) { if (excludeTerms != null) { diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/bucket/terms/support/IncludeExclude.java b/core/src/main/java/org/elasticsearch/search/aggregations/bucket/terms/support/IncludeExclude.java index 1eff5885b1..98abe2b464 100644 --- a/core/src/main/java/org/elasticsearch/search/aggregations/bucket/terms/support/IncludeExclude.java +++ b/core/src/main/java/org/elasticsearch/search/aggregations/bucket/terms/support/IncludeExclude.java @@ -94,7 +94,7 @@ public class IncludeExclude { } /** - * Returns whether the given value is accepted based on the {@code include} & {@code exclude} patterns. + * Returns whether the given value is accepted based on the {@code include} & {@code exclude} patterns. */ @Override public boolean accept(BytesRef value) { @@ -114,7 +114,7 @@ public class IncludeExclude { /** * Returns whether the given value is accepted based on the - * {@code include} & {@code exclude} sets. + * {@code include} & {@code exclude} sets. */ @Override public boolean accept(BytesRef value) { diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/BucketHelpers.java b/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/BucketHelpers.java index 10d095603e..881a8e4169 100644 --- a/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/BucketHelpers.java +++ b/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/BucketHelpers.java @@ -102,9 +102,7 @@ public class BucketHelpers { /** * Deserialize the GapPolicy from the input stream * - * @param in * @return GapPolicy Enum - * @throws IOException */ public static GapPolicy readFrom(StreamInput in) throws IOException { byte id = in.readByte(); diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/PipelineAggregator.java b/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/PipelineAggregator.java index bd6ad020c6..b2ee037e1e 100644 --- a/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/PipelineAggregator.java +++ b/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/PipelineAggregator.java @@ -39,7 +39,7 @@ public abstract class PipelineAggregator implements Streamable { * Parses the pipeline aggregation request and creates the appropriate * pipeline aggregator factory for it. * - * @see {@link PipelineAggregatorFactory} + * @see PipelineAggregatorFactory */ public static interface Parser { diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/PipelineAggregatorFactory.java b/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/PipelineAggregatorFactory.java index 26b38ee67d..6fc0185101 100644 --- a/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/PipelineAggregatorFactory.java +++ b/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/PipelineAggregatorFactory.java @@ -56,10 +56,6 @@ public abstract class PipelineAggregatorFactory { /** * Validates the state of this factory (makes sure the factory is properly * configured) - * - * @param pipelineAggregatorFactories - * @param factories - * @param parent */ public final void validate(AggregatorFactory parent, AggregatorFactory[] factories, List<PipelineAggregatorFactory> pipelineAggregatorFactories) { @@ -71,17 +67,6 @@ public abstract class PipelineAggregatorFactory { /** * Creates the pipeline aggregator * - * @param context - * The aggregation context - * @param parent - * The parent aggregator (if this is a top level factory, the - * parent will be {@code null}) - * @param collectsFromSingleBucket - * If true then the created aggregator will only be collected - * with <tt>0</tt> as a bucket ordinal. Some factories can take - * advantage of this in order to return more optimized - * implementations. - * * @return The created aggregator */ public final PipelineAggregator create() throws IOException { diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/bucketmetrics/BucketMetricsPipelineAggregator.java b/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/bucketmetrics/BucketMetricsPipelineAggregator.java index 93ccf2dee8..89955ef027 100644 --- a/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/bucketmetrics/BucketMetricsPipelineAggregator.java +++ b/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/bucketmetrics/BucketMetricsPipelineAggregator.java @@ -96,7 +96,6 @@ public abstract class BucketMetricsPipelineAggregator extends SiblingPipelineAgg * the pipeline aggregators to add to the resulting aggregation * @param metadata * the metadata to add to the resulting aggregation - * @return */ protected abstract InternalAggregation buildAggregation(List<PipelineAggregator> pipelineAggregators, Map<String, Object> metadata); diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/movavg/MovAvgBuilder.java b/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/movavg/MovAvgBuilder.java index b3aca612fc..b2dc718d47 100644 --- a/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/movavg/MovAvgBuilder.java +++ b/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/movavg/MovAvgBuilder.java @@ -112,9 +112,6 @@ public class MovAvgBuilder extends PipelineAggregatorBuilder<MovAvgBuilder> { /** * The hash of settings that should be provided to the model when it is * instantiated - * - * @param settings - * @return */ public MovAvgBuilder settings(Map<String, Object> settings) { this.settings = settings; diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/movavg/models/HoltWintersModel.java b/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/movavg/models/HoltWintersModel.java index 8be63e165b..176d4b06f3 100644 --- a/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/movavg/models/HoltWintersModel.java +++ b/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/movavg/models/HoltWintersModel.java @@ -134,7 +134,6 @@ public class HoltWintersModel extends MovAvgModel { * * @param in the input stream * @return SeasonalityType Enum - * @throws IOException */ public static SeasonalityType readFrom(StreamInput in) throws IOException { byte id = in.readByte(); diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/movavg/models/MovAvgModel.java b/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/movavg/models/MovAvgModel.java index 3de4fceab4..f175513207 100644 --- a/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/movavg/models/MovAvgModel.java +++ b/core/src/main/java/org/elasticsearch/search/aggregations/pipeline/movavg/models/MovAvgModel.java @@ -34,8 +34,6 @@ public abstract class MovAvgModel { /** * Should this model be fit to the data via a cost minimizing algorithm by default? - * - * @return */ public boolean minimizeByDefault() { return false; @@ -44,16 +42,12 @@ public abstract class MovAvgModel { /** * Returns if the model can be cost minimized. Not all models have parameters * which can be tuned / optimized. - * - * @return */ public abstract boolean canBeMinimized(); /** * Generates a "neighboring" model, where one of the tunable parameters has been * randomly mutated within the allowed range. Used for minimization - * - * @return */ public abstract MovAvgModel neighboringModel(); @@ -111,7 +105,6 @@ public abstract class MovAvgModel { /** * Returns an empty set of predictions, filled with NaNs * @param numPredictions Number of empty predictions to generate - * @return */ protected double[] emptyPredictions(int numPredictions) { double[] predictions = new double[numPredictions]; @@ -123,14 +116,11 @@ public abstract class MovAvgModel { * Write the model to the output stream * * @param out Output stream - * @throws IOException */ public abstract void writeTo(StreamOutput out) throws IOException; /** * Clone the model, returning an exact copy - * - * @return */ public abstract MovAvgModel clone(); @@ -165,9 +155,6 @@ public abstract class MovAvgModel { * @param settings Map of settings provided to this model * @param name Name of parameter we are attempting to extract * @param defaultValue Default value to be used if value does not exist in map - * - * @throws ParseException - * * @return Double value extracted from settings map */ protected double parseDoubleParam(@Nullable Map<String, Object> settings, String name, double defaultValue) throws ParseException { @@ -199,9 +186,6 @@ public abstract class MovAvgModel { * @param settings Map of settings provided to this model * @param name Name of parameter we are attempting to extract * @param defaultValue Default value to be used if value does not exist in map - * - * @throws ParseException - * * @return Integer value extracted from settings map */ protected int parseIntegerParam(@Nullable Map<String, Object> settings, String name, int defaultValue) throws ParseException { @@ -227,9 +211,6 @@ public abstract class MovAvgModel { * @param settings Map of settings provided to this model * @param name Name of parameter we are attempting to extract * @param defaultValue Default value to be used if value does not exist in map - * - * @throws SearchParseException - * * @return Boolean value extracted from settings map */ protected boolean parseBoolParam(@Nullable Map<String, Object> settings, String name, boolean defaultValue) throws ParseException { diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/support/AggregationPath.java b/core/src/main/java/org/elasticsearch/search/aggregations/support/AggregationPath.java index 85af60a148..84fd26a74f 100644 --- a/core/src/main/java/org/elasticsearch/search/aggregations/support/AggregationPath.java +++ b/core/src/main/java/org/elasticsearch/search/aggregations/support/AggregationPath.java @@ -33,18 +33,16 @@ import java.util.ArrayList; import java.util.List; /** - * A path that can be used to sort/order buckets (in some multi-bucket aggregations, eg terms & histogram) based on + * A path that can be used to sort/order buckets (in some multi-bucket aggregations, eg terms & histogram) based on * sub-aggregations. The path may point to either a single-bucket aggregation or a metrics aggregation. If the path * points to a single-bucket aggregation, the sort will be applied based on the {@code doc_count} of the bucket. If this * path points to a metrics aggregation, if it's a single-value metrics (eg. avg, max, min, etc..) the sort will be * applied on that single value. If it points to a multi-value metrics, the path should point out what metric should be * the sort-by value. - * <p/> + * <p> * The path has the following form: - * <p/> * <center>{@code <aggregation_name>['>'<aggregation_name>*]['.'<metric_name>]}</center> - * <p/> - * <p/> + * <p> * Examples: * * <ul> diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/support/values/ScriptDoubleValues.java b/core/src/main/java/org/elasticsearch/search/aggregations/support/values/ScriptDoubleValues.java index 337b2982a1..ee9e1272e8 100644 --- a/core/src/main/java/org/elasticsearch/search/aggregations/support/values/ScriptDoubleValues.java +++ b/core/src/main/java/org/elasticsearch/search/aggregations/support/values/ScriptDoubleValues.java @@ -29,7 +29,7 @@ import java.util.Collection; import java.util.Iterator; /** - * {@link DoubleValues} implementation which is based on a script + * {@link SortingNumericDoubleValues} implementation which is based on a script */ public class ScriptDoubleValues extends SortingNumericDoubleValues implements ScorerAware { diff --git a/core/src/main/java/org/elasticsearch/search/fetch/fielddata/FieldDataFieldsParseElement.java b/core/src/main/java/org/elasticsearch/search/fetch/fielddata/FieldDataFieldsParseElement.java index cd5cb7d323..3d1a2498f2 100644 --- a/core/src/main/java/org/elasticsearch/search/fetch/fielddata/FieldDataFieldsParseElement.java +++ b/core/src/main/java/org/elasticsearch/search/fetch/fielddata/FieldDataFieldsParseElement.java @@ -28,7 +28,6 @@ import org.elasticsearch.search.internal.SearchContext; /** * Parses field name values from the {@code fielddata_fields} parameter in a * search request. - * <p/> * <pre> * { * "query": {...}, diff --git a/core/src/main/java/org/elasticsearch/search/highlight/HighlightBuilder.java b/core/src/main/java/org/elasticsearch/search/highlight/HighlightBuilder.java index c082859a0e..695598e4fe 100644 --- a/core/src/main/java/org/elasticsearch/search/highlight/HighlightBuilder.java +++ b/core/src/main/java/org/elasticsearch/search/highlight/HighlightBuilder.java @@ -603,7 +603,7 @@ public class HighlightBuilder implements ToXContent { /** * Allows to set custom options for custom highlighters. - * This overrides global settings set by {@link HighlightBuilder#options(Map<String, Object>)}. + * This overrides global settings set by {@link HighlightBuilder#options(Map)}. */ public Field options(Map<String, Object> options) { this.options = options; diff --git a/core/src/main/java/org/elasticsearch/search/internal/ShardSearchLocalRequest.java b/core/src/main/java/org/elasticsearch/search/internal/ShardSearchLocalRequest.java index a0392509d2..ca8c074627 100644 --- a/core/src/main/java/org/elasticsearch/search/internal/ShardSearchLocalRequest.java +++ b/core/src/main/java/org/elasticsearch/search/internal/ShardSearchLocalRequest.java @@ -41,7 +41,6 @@ import static org.elasticsearch.search.Scroll.readScroll; * Used by warmers and by api that need to create a search context within their execution. * * Source structure: - * <p/> * <pre> * { * from : 0, size : 20, (optional, can be set on the request) diff --git a/core/src/main/java/org/elasticsearch/search/lookup/IndexLookup.java b/core/src/main/java/org/elasticsearch/search/lookup/IndexLookup.java index 3d2f011776..0150ef7e0b 100644 --- a/core/src/main/java/org/elasticsearch/search/lookup/IndexLookup.java +++ b/core/src/main/java/org/elasticsearch/search/lookup/IndexLookup.java @@ -25,32 +25,32 @@ import org.apache.lucene.index.LeafReaderContext; public class IndexLookup { /** - * Flag to pass to {@link IndexField#get(String, flags)} if you require + * Flag to pass to {@link IndexField#get(Object, int)} if you require * offsets in the returned {@link IndexFieldTerm}. */ public static final int FLAG_OFFSETS = 2; /** - * Flag to pass to {@link IndexField#get(String, flags)} if you require + * Flag to pass to {@link IndexField#get(Object, int)} if you require * payloads in the returned {@link IndexFieldTerm}. */ public static final int FLAG_PAYLOADS = 4; /** - * Flag to pass to {@link IndexField#get(String, flags)} if you require + * Flag to pass to {@link IndexField#get(Object, int)} if you require * frequencies in the returned {@link IndexFieldTerm}. Frequencies might be * returned anyway for some lucene codecs even if this flag is no set. */ public static final int FLAG_FREQUENCIES = 8; /** - * Flag to pass to {@link IndexField#get(String, flags)} if you require + * Flag to pass to {@link IndexField#get(Object, int)} if you require * positions in the returned {@link IndexFieldTerm}. */ public static final int FLAG_POSITIONS = 16; /** - * Flag to pass to {@link IndexField#get(String, flags)} if you require + * Flag to pass to {@link IndexField#get(Object, int)} if you require * positions in the returned {@link IndexFieldTerm}. */ public static final int FLAG_CACHE = 32; diff --git a/core/src/main/java/org/elasticsearch/search/rescore/QueryRescorer.java b/core/src/main/java/org/elasticsearch/search/rescore/QueryRescorer.java index f83a6030e7..fce6ad6a07 100644 --- a/core/src/main/java/org/elasticsearch/search/rescore/QueryRescorer.java +++ b/core/src/main/java/org/elasticsearch/search/rescore/QueryRescorer.java @@ -227,7 +227,7 @@ public final class QueryRescorer implements Rescorer { } }; - /** Returns a new {@link TopDocs} with the topN from the incoming one, or the same TopDocs if the number of hits is already <= + /** Returns a new {@link TopDocs} with the topN from the incoming one, or the same TopDocs if the number of hits is already <= * topN. */ private TopDocs topN(TopDocs in, int topN) { if (in.totalHits < topN) { diff --git a/core/src/main/java/org/elasticsearch/search/sort/FieldSortBuilder.java b/core/src/main/java/org/elasticsearch/search/sort/FieldSortBuilder.java index 1a95c96d54..c415fd5a70 100644 --- a/core/src/main/java/org/elasticsearch/search/sort/FieldSortBuilder.java +++ b/core/src/main/java/org/elasticsearch/search/sort/FieldSortBuilder.java @@ -102,7 +102,7 @@ public class FieldSortBuilder extends SortBuilder { /** * Defines what values to pick in the case a document contains multiple values for the targeted sort field. * Possible values: min, max, sum and avg - * <p/> + * <p> * The last two values are only applicable for number based fields. */ public FieldSortBuilder sortMode(String sortMode) { diff --git a/core/src/main/java/org/elasticsearch/search/suggest/SuggestBuilder.java b/core/src/main/java/org/elasticsearch/search/suggest/SuggestBuilder.java index 57d18c3cdd..ea45c1033e 100644 --- a/core/src/main/java/org/elasticsearch/search/suggest/SuggestBuilder.java +++ b/core/src/main/java/org/elasticsearch/search/suggest/SuggestBuilder.java @@ -31,7 +31,7 @@ import java.util.List; /** * Defines how to perform suggesting. This builders allows a number of global options to be specified and * an arbitrary number of {@link org.elasticsearch.search.suggest.term.TermSuggestionBuilder} instances. - * <p/> + * <p> * Suggesting works by suggesting terms that appear in the suggest text that are similar compared to the terms in * provided text. These spelling suggestions are based on several options described in this class. */ @@ -53,7 +53,7 @@ public class SuggestBuilder extends ToXContentToBytes { /** * Sets the text to provide suggestions for. The suggest text is a required option that needs * to be set either via this setter or via the {@link org.elasticsearch.search.suggest.SuggestBuilder.SuggestionBuilder#setText(String)} method. - * <p/> + * <p> * The suggest text gets analyzed by the suggest analyzer or the suggest field search analyzer. * For each analyzed token, suggested terms are suggested if possible. */ @@ -268,7 +268,7 @@ public class SuggestBuilder extends ToXContentToBytes { * individual shard. During the reduce phase the only the top N suggestions * are returned based on the <code>size</code> option. Defaults to the * <code>size</code> option. - * <p/> + * <p> * Setting this to a value higher than the `size` can be useful in order to * get a more accurate document frequency for suggested terms. Due to the * fact that terms are partitioned amongst shards, the shard level document diff --git a/core/src/main/java/org/elasticsearch/search/suggest/context/CategoryContextMapping.java b/core/src/main/java/org/elasticsearch/search/suggest/context/CategoryContextMapping.java index ce807d824b..118d95e22d 100644 --- a/core/src/main/java/org/elasticsearch/search/suggest/context/CategoryContextMapping.java +++ b/core/src/main/java/org/elasticsearch/search/suggest/context/CategoryContextMapping.java @@ -110,7 +110,7 @@ public class CategoryContextMapping extends ContextMapping { /** * Load the specification of a {@link CategoryContextMapping} * - * @param field + * @param name * name of the field to use. If <code>null</code> default field * will be used * @return new {@link CategoryContextMapping} diff --git a/core/src/main/java/org/elasticsearch/search/suggest/context/ContextBuilder.java b/core/src/main/java/org/elasticsearch/search/suggest/context/ContextBuilder.java index 58fb91b7b5..8b554d957d 100644 --- a/core/src/main/java/org/elasticsearch/search/suggest/context/ContextBuilder.java +++ b/core/src/main/java/org/elasticsearch/search/suggest/context/ContextBuilder.java @@ -57,14 +57,14 @@ public abstract class ContextBuilder<E extends ContextMapping> { } /** - * Create a new {@link CategoryMapping} + * Create a new {@link CategoryContextMapping.Builder} */ public static CategoryContextMapping.Builder category(String name) { return new CategoryContextMapping.Builder(name, null); } /** - * Create a new {@link CategoryMapping} with default category + * Create a new {@link CategoryContextMapping.Builder} with default category * * @param defaultCategory category to use, if it is not provided */ diff --git a/core/src/main/java/org/elasticsearch/search/suggest/context/ContextMapping.java b/core/src/main/java/org/elasticsearch/search/suggest/context/ContextMapping.java index 65232cad39..bbdb614c94 100644 --- a/core/src/main/java/org/elasticsearch/search/suggest/context/ContextMapping.java +++ b/core/src/main/java/org/elasticsearch/search/suggest/context/ContextMapping.java @@ -107,9 +107,6 @@ public abstract class ContextMapping implements ToXContent { * @param parseContext context of parsing phase * @param parser {@link XContentParser} used to read and setup the configuration * @return A {@link ContextConfig} related to <b>this</b> mapping - * - * @throws IOException - * @throws ElasticsearchParseException */ public abstract ContextConfig parseContext(ParseContext parseContext, XContentParser parser) throws IOException, ElasticsearchParseException; @@ -122,9 +119,6 @@ public abstract class ContextMapping implements ToXContent { * @param parser {@link XContentParser} providing the data of the query * * @return {@link ContextQuery} according to this mapping - * - * @throws IOException - * @throws ElasticsearchParseException */ public abstract ContextQuery parseQuery(String name, XContentParser parser) throws IOException, ElasticsearchParseException; @@ -136,8 +130,6 @@ public abstract class ContextMapping implements ToXContent { * @param params parameters passed to the builder * * @return the builder used - * - * @throws IOException */ protected abstract XContentBuilder toInnerXContent(XContentBuilder builder, Params params) throws IOException; diff --git a/core/src/main/java/org/elasticsearch/search/suggest/phrase/PhraseSuggestionBuilder.java b/core/src/main/java/org/elasticsearch/search/suggest/phrase/PhraseSuggestionBuilder.java index d5e942b52e..1055fbe83f 100644 --- a/core/src/main/java/org/elasticsearch/search/suggest/phrase/PhraseSuggestionBuilder.java +++ b/core/src/main/java/org/elasticsearch/search/suggest/phrase/PhraseSuggestionBuilder.java @@ -148,7 +148,7 @@ public final class PhraseSuggestionBuilder extends SuggestionBuilder<PhraseSugge /** * Sets an explicit smoothing model used for this suggester. The default is - * {@link PhraseSuggester#StupidBackoff}. + * {@link PhraseSuggestionBuilder.StupidBackoff}. */ public PhraseSuggestionBuilder smoothingModel(SmoothingModel model) { this.model = model; @@ -318,8 +318,6 @@ public final class PhraseSuggestionBuilder extends SuggestionBuilder<PhraseSugge /** * Creates a Laplace smoothing model. * - * @param discount - * the discount given to lower order ngrams if the higher order ngram doesn't exits */ public Laplace(double alpha) { super("laplace"); @@ -430,10 +428,7 @@ public final class PhraseSuggestionBuilder extends SuggestionBuilder<PhraseSugge private Float minDocFreq; /** - * Sets from what field to fetch the candidate suggestions from. This is - * an required option and needs to be set via this setter or - * {@link org.elasticsearch.search.suggest.SuggestBuilder.TermSuggestionBuilder#setField(String)} - * method + * @param field Sets from what field to fetch the candidate suggestions from. */ public DirectCandidateGenerator(String field) { super("direct_generator"); @@ -463,7 +458,7 @@ public final class PhraseSuggestionBuilder extends SuggestionBuilder<PhraseSugge * the original suggest text tokens. A value between 0 and 1 can be * specified. This value will be compared to the string distance result * of each candidate spelling correction. - * <p/> + * <p> * Default is <tt>0.5</tt> */ public DirectCandidateGenerator accuracy(float accuracy) { @@ -491,7 +486,7 @@ public final class PhraseSuggestionBuilder extends SuggestionBuilder<PhraseSugge * <li><code>frequency</code> - Sort should first be based on document * frequency, then scotr and then the term itself. * </ol> - * <p/> + * <p> * What the score is depends on the suggester being used. */ public DirectCandidateGenerator sort(String sort) { @@ -548,7 +543,7 @@ public final class PhraseSuggestionBuilder extends SuggestionBuilder<PhraseSugge * number (e.g 0.4) or an absolute number to represent document * frequencies. If an value higher than 1 is specified then fractional * can not be specified. Defaults to <tt>0.01</tt>. - * <p/> + * <p> * This can be used to exclude high frequency terms from being * suggested. High frequency terms are usually spelled correctly on top * of this this also improves the suggest performance. diff --git a/core/src/main/java/org/elasticsearch/search/suggest/term/TermSuggestionBuilder.java b/core/src/main/java/org/elasticsearch/search/suggest/term/TermSuggestionBuilder.java index 0fd5ae1289..03eb388f00 100644 --- a/core/src/main/java/org/elasticsearch/search/suggest/term/TermSuggestionBuilder.java +++ b/core/src/main/java/org/elasticsearch/search/suggest/term/TermSuggestionBuilder.java @@ -71,7 +71,7 @@ public class TermSuggestionBuilder extends SuggestionBuilder<TermSuggestionBuild * original suggest text tokens. A value between 0 and 1 can be specified. * This value will be compared to the string distance result of each * candidate spelling correction. - * <p/> + * <p> * Default is <tt>0.5</tt> */ public TermSuggestionBuilder setAccuracy(float accuracy) { @@ -88,7 +88,7 @@ public class TermSuggestionBuilder extends SuggestionBuilder<TermSuggestionBuild * <li><code>frequency</code> - Sort should first be based on document * frequency, then scotr and then the term itself. * </ol> - * <p/> + * <p> * What the score is depends on the suggester being used. */ public TermSuggestionBuilder sort(String sort) { @@ -145,7 +145,7 @@ public class TermSuggestionBuilder extends SuggestionBuilder<TermSuggestionBuild * 0.4) or an absolute number to represent document frequencies. If an value * higher than 1 is specified then fractional can not be specified. Defaults * to <tt>0.01</tt>. - * <p/> + * <p> * This can be used to exclude high frequency terms from being suggested. * High frequency terms are usually spelled correctly on top of this this * also improves the suggest performance. diff --git a/core/src/main/java/org/elasticsearch/snapshots/RestoreInfo.java b/core/src/main/java/org/elasticsearch/snapshots/RestoreInfo.java index cc9eeb0413..866cd38d9d 100644 --- a/core/src/main/java/org/elasticsearch/snapshots/RestoreInfo.java +++ b/core/src/main/java/org/elasticsearch/snapshots/RestoreInfo.java @@ -33,7 +33,7 @@ import java.util.List; /** * Information about successfully completed restore operation. - * <p/> + * <p> * Returned as part of {@link org.elasticsearch.action.admin.cluster.snapshots.restore.RestoreSnapshotResponse} */ public class RestoreInfo implements ToXContent, Streamable { @@ -176,7 +176,6 @@ public class RestoreInfo implements ToXContent, Streamable { * * @param in stream input * @return restore info - * @throws IOException */ public static RestoreInfo readRestoreInfo(StreamInput in) throws IOException { RestoreInfo snapshotInfo = new RestoreInfo(); @@ -189,7 +188,6 @@ public class RestoreInfo implements ToXContent, Streamable { * * @param in stream input * @return restore info - * @throws IOException */ public static RestoreInfo readOptionalRestoreInfo(StreamInput in) throws IOException { return in.readOptionalStreamable(new RestoreInfo()); diff --git a/core/src/main/java/org/elasticsearch/snapshots/RestoreService.java b/core/src/main/java/org/elasticsearch/snapshots/RestoreService.java index 39c3c5b9a7..5692100728 100644 --- a/core/src/main/java/org/elasticsearch/snapshots/RestoreService.java +++ b/core/src/main/java/org/elasticsearch/snapshots/RestoreService.java @@ -104,22 +104,22 @@ import static org.elasticsearch.cluster.metadata.MetaDataIndexStateService.INDEX /** * Service responsible for restoring snapshots - * <p/> + * <p> * Restore operation is performed in several stages. - * <p/> - * First {@link #restoreSnapshot(RestoreRequest, org.elasticsearch.action.ActionListener))} + * <p> + * First {@link #restoreSnapshot(RestoreRequest, org.elasticsearch.action.ActionListener)} * method reads information about snapshot and metadata from repository. In update cluster state task it checks restore * preconditions, restores global state if needed, creates {@link RestoreInProgress} record with list of shards that needs - * to be restored and adds this shard to the routing table using {@link RoutingTable.Builder#addAsRestore(IndexMetaData, RestoreSource)} + * to be restored and adds this shard to the routing table using {@link org.elasticsearch.cluster.routing.RoutingTable.Builder#addAsRestore(IndexMetaData, RestoreSource)} * method. - * <p/> + * <p> * Individual shards are getting restored as part of normal recovery process in * {@link StoreRecoveryService#recover(IndexShard, boolean, StoreRecoveryService.RecoveryListener)} * method, which detects that shard should be restored from snapshot rather than recovered from gateway by looking * at the {@link org.elasticsearch.cluster.routing.ShardRouting#restoreSource()} property. If this property is not null * {@code recover} method uses {@link StoreRecoveryService#restore} * method to start shard restore process. - * <p/> + * <p> * At the end of the successful restore process {@code IndexShardSnapshotAndRestoreService} calls {@link #indexShardRestoreCompleted(SnapshotId, ShardId)}, * which updates {@link RestoreInProgress} in cluster state or removes it when all shards are completed. In case of * restore failure a normal recovery fail-over process kicks in. @@ -782,7 +782,7 @@ public class RestoreService extends AbstractComponent implements ClusterStateLis /** * Adds restore completion listener - * <p/> + * <p> * This listener is called for each snapshot that finishes restore operation in the cluster. It's responsibility of * the listener to decide if it's called for the appropriate snapshot or not. * @@ -794,7 +794,7 @@ public class RestoreService extends AbstractComponent implements ClusterStateLis /** * Removes restore completion listener - * <p/> + * <p> * This listener is called for each snapshot that finishes restore operation in the cluster. * * @param listener restore completion listener diff --git a/core/src/main/java/org/elasticsearch/snapshots/Snapshot.java b/core/src/main/java/org/elasticsearch/snapshots/Snapshot.java index 75abc40af6..d7e0a06404 100644 --- a/core/src/main/java/org/elasticsearch/snapshots/Snapshot.java +++ b/core/src/main/java/org/elasticsearch/snapshots/Snapshot.java @@ -164,7 +164,7 @@ public class Snapshot implements Comparable<Snapshot>, ToXContent, FromXContentB /** * Returns time when snapshot ended - * <p/> + * <p> * Can be 0L if snapshot is still running * * @return snapshot end time diff --git a/core/src/main/java/org/elasticsearch/snapshots/SnapshotInfo.java b/core/src/main/java/org/elasticsearch/snapshots/SnapshotInfo.java index e7b6ce13f1..57b974ce7a 100644 --- a/core/src/main/java/org/elasticsearch/snapshots/SnapshotInfo.java +++ b/core/src/main/java/org/elasticsearch/snapshots/SnapshotInfo.java @@ -131,7 +131,7 @@ public class SnapshotInfo implements ToXContent, Streamable { /** * Returns time when snapshot ended - * <p/> + * <p> * Can be 0L if snapshot is still running * * @return snapshot end time @@ -310,7 +310,6 @@ public class SnapshotInfo implements ToXContent, Streamable { * * @param in stream input * @return deserialized snapshot info - * @throws IOException */ public static SnapshotInfo readSnapshotInfo(StreamInput in) throws IOException { SnapshotInfo snapshotInfo = new SnapshotInfo(); @@ -323,7 +322,6 @@ public class SnapshotInfo implements ToXContent, Streamable { * * @param in stream input * @return deserialized snapshot info or null - * @throws IOException */ public static SnapshotInfo readOptionalSnapshotInfo(StreamInput in) throws IOException { return in.readOptionalStreamable(new SnapshotInfo()); diff --git a/core/src/main/java/org/elasticsearch/snapshots/SnapshotShardFailure.java b/core/src/main/java/org/elasticsearch/snapshots/SnapshotShardFailure.java index 216052ee57..60bd25542c 100644 --- a/core/src/main/java/org/elasticsearch/snapshots/SnapshotShardFailure.java +++ b/core/src/main/java/org/elasticsearch/snapshots/SnapshotShardFailure.java @@ -128,7 +128,6 @@ public class SnapshotShardFailure implements ShardOperationFailedException { * * @param in stream input * @return shard failure information - * @throws IOException */ public static SnapshotShardFailure readSnapshotShardFailure(StreamInput in) throws IOException { SnapshotShardFailure exp = new SnapshotShardFailure(); @@ -165,7 +164,6 @@ public class SnapshotShardFailure implements ShardOperationFailedException { * @param snapshotShardFailure snapshot failure information * @param builder XContent builder * @param params additional parameters - * @throws IOException */ public static void toXContent(SnapshotShardFailure snapshotShardFailure, XContentBuilder builder, ToXContent.Params params) throws IOException { builder.startObject(); @@ -178,7 +176,6 @@ public class SnapshotShardFailure implements ShardOperationFailedException { * * @param parser JSON parser * @return snapshot failure information - * @throws IOException */ public static SnapshotShardFailure fromXContent(XContentParser parser) throws IOException { SnapshotShardFailure snapshotShardFailure = new SnapshotShardFailure(); diff --git a/core/src/main/java/org/elasticsearch/snapshots/SnapshotShardsService.java b/core/src/main/java/org/elasticsearch/snapshots/SnapshotShardsService.java index 301ceededc..58a98c30d7 100644 --- a/core/src/main/java/org/elasticsearch/snapshots/SnapshotShardsService.java +++ b/core/src/main/java/org/elasticsearch/snapshots/SnapshotShardsService.java @@ -358,7 +358,6 @@ public class SnapshotShardsService extends AbstractLifecycleComponent<SnapshotSh /** * Checks if any shards were processed that the new master doesn't know about - * @param event */ private void syncShardStatsOnNewMaster(ClusterChangedEvent event) { SnapshotsInProgress snapshotsInProgress = event.state().custom(SnapshotsInProgress.TYPE); @@ -583,4 +582,4 @@ public class SnapshotShardsService extends AbstractLifecycleComponent<SnapshotSh } } -}
\ No newline at end of file +} diff --git a/core/src/main/java/org/elasticsearch/snapshots/SnapshotsService.java b/core/src/main/java/org/elasticsearch/snapshots/SnapshotsService.java index 76485a0c4c..3cb02a4c8f 100644 --- a/core/src/main/java/org/elasticsearch/snapshots/SnapshotsService.java +++ b/core/src/main/java/org/elasticsearch/snapshots/SnapshotsService.java @@ -75,7 +75,7 @@ import static org.elasticsearch.cluster.SnapshotsInProgress.completed; /** * Service responsible for creating snapshots - * <p/> + * <p> * A typical snapshot creating process looks like this: * <ul> * <li>On the master node the {@link #createSnapshot(SnapshotRequest, CreateSnapshotListener)} is called and makes sure that no snapshots is currently running @@ -172,7 +172,7 @@ public class SnapshotsService extends AbstractLifecycleComponent<SnapshotsServic /** * Initializes the snapshotting process. - * <p/> + * <p> * This method is used by clients to start snapshot. It makes sure that there is no snapshots are currently running and * creates a snapshot record in cluster state metadata. * @@ -236,7 +236,6 @@ public class SnapshotsService extends AbstractLifecycleComponent<SnapshotsServic * * @param request snapshot request * @param state current cluster state - * @throws org.elasticsearch.ElasticsearchException */ private void validate(SnapshotRequest request, ClusterState state) { RepositoriesMetaData repositoriesMetaData = state.getMetaData().custom(RepositoriesMetaData.TYPE); @@ -273,7 +272,7 @@ public class SnapshotsService extends AbstractLifecycleComponent<SnapshotsServic /** * Starts snapshot. - * <p/> + * <p> * Creates snapshot in repository and updates snapshot metadata record with list of shards that needs to be processed. * * @param clusterState cluster state @@ -752,7 +751,7 @@ public class SnapshotsService extends AbstractLifecycleComponent<SnapshotsServic /** * Finalizes the shard in repository and then removes it from cluster state - * <p/> + * <p> * This is non-blocking method that runs on a thread from SNAPSHOT thread pool * * @param entry snapshot @@ -764,7 +763,7 @@ public class SnapshotsService extends AbstractLifecycleComponent<SnapshotsServic /** * Finalizes the shard in repository and then removes it from cluster state - * <p/> + * <p> * This is non-blocking method that runs on a thread from SNAPSHOT thread pool * * @param entry snapshot @@ -853,7 +852,7 @@ public class SnapshotsService extends AbstractLifecycleComponent<SnapshotsServic /** * Deletes snapshot from repository. - * <p/> + * <p> * If the snapshot is still running cancels the snapshot first and then deletes it from the repository. * * @param snapshotId snapshot id diff --git a/core/src/main/java/org/elasticsearch/transport/TransportServiceAdapter.java b/core/src/main/java/org/elasticsearch/transport/TransportServiceAdapter.java index e396b0381c..382a4192d1 100644 --- a/core/src/main/java/org/elasticsearch/transport/TransportServiceAdapter.java +++ b/core/src/main/java/org/elasticsearch/transport/TransportServiceAdapter.java @@ -33,21 +33,21 @@ public interface TransportServiceAdapter { /** called by the {@link Transport} implementation once a request has been sent */ void onRequestSent(DiscoveryNode node, long requestId, String action, TransportRequest request, TransportRequestOptions options); - /** called by the {@link Transport) implementation once a response was sent to calling node */ + /** called by the {@link Transport} implementation once a response was sent to calling node */ void onResponseSent(long requestId, String action, TransportResponse response, TransportResponseOptions options); - /** called by the {@link Transport) implementation after an exception was sent as a response to an incoming request */ + /** called by the {@link Transport} implementation after an exception was sent as a response to an incoming request */ void onResponseSent(long requestId, String action, Throwable t); /** - * called by the {@link Transport) implementation when a response or an exception has been recieved for a previously + * called by the {@link Transport} implementation when a response or an exception has been received for a previously * sent request (before any processing or deserialization was done). Returns the appropriate response handler or null if not * found. */ TransportResponseHandler onResponseReceived(long requestId); /** - * called by the {@link Transport) implementation when an incoming request arrives but before + * called by the {@link Transport} implementation when an incoming request arrives but before * any parsing of it has happened (with the exception of the requestId and action) */ void onRequestReceived(long requestId, String action); diff --git a/core/src/main/java/org/elasticsearch/tribe/TribeService.java b/core/src/main/java/org/elasticsearch/tribe/TribeService.java index 0dbe207851..35617ddfa7 100644 --- a/core/src/main/java/org/elasticsearch/tribe/TribeService.java +++ b/core/src/main/java/org/elasticsearch/tribe/TribeService.java @@ -60,15 +60,15 @@ import java.util.concurrent.CopyOnWriteArrayList; /** * The tribe service holds a list of node clients connected to a list of tribe members, and uses their * cluster state events to update this local node cluster state with the merged view of it. - * <p/> + * <p> * The {@link #processSettings(org.elasticsearch.common.settings.Settings)} method should be called before * starting the node, so it will make sure to configure this current node properly with the relevant tribe node * settings. - * <p/> + * <p> * The tribe node settings make sure the discovery used is "local", but with no master elected. This means no * write level master node operations will work ({@link org.elasticsearch.discovery.MasterNotDiscoveredException} * will be thrown), and state level metadata operations with automatically use the local flag. - * <p/> + * <p> * The state merged from different clusters include the list of nodes, metadata, and routing table. Each node merged * will have in its tribe which tribe member it came from. Each index merged will have in its settings which tribe * member it came from. In case an index has already been merged from one cluster, and the same name index is discovered diff --git a/core/src/main/java/org/elasticsearch/watcher/AbstractResourceWatcher.java b/core/src/main/java/org/elasticsearch/watcher/AbstractResourceWatcher.java index 24ab69a238..5e367610df 100644 --- a/core/src/main/java/org/elasticsearch/watcher/AbstractResourceWatcher.java +++ b/core/src/main/java/org/elasticsearch/watcher/AbstractResourceWatcher.java @@ -72,7 +72,7 @@ public abstract class AbstractResourceWatcher<Listener> implements ResourceWatch /** * Will be called periodically - * <p/> + * <p> * Implementing watcher should check resource and notify all {@link #listeners()}. */ protected abstract void doCheckAndNotify() throws IOException; diff --git a/core/src/main/java/org/elasticsearch/watcher/ResourceWatcher.java b/core/src/main/java/org/elasticsearch/watcher/ResourceWatcher.java index 0d4bef17b1..4356c87f0f 100644 --- a/core/src/main/java/org/elasticsearch/watcher/ResourceWatcher.java +++ b/core/src/main/java/org/elasticsearch/watcher/ResourceWatcher.java @@ -22,7 +22,7 @@ import java.io.IOException; /** * Abstract resource watcher interface. - * <p/> + * <p> * Different resource watchers can be registered with {@link ResourceWatcherService} to be called * periodically in order to check for changes in different external resources. */ diff --git a/core/src/main/java/org/joda/time/base/BaseDateTime.java b/core/src/main/java/org/joda/time/base/BaseDateTime.java index c2aa9ec847..4cf6ff6b50 100644 --- a/core/src/main/java/org/joda/time/base/BaseDateTime.java +++ b/core/src/main/java/org/joda/time/base/BaseDateTime.java @@ -29,11 +29,11 @@ import java.io.Serializable; /** * BaseDateTime is an abstract implementation of ReadableDateTime that stores * data in <code>long</code> and <code>Chronology</code> fields. - * <p/> + * <p> * This class should generally not be used directly by API users. * The {@link ReadableDateTime} interface should be used when different * kinds of date/time objects are to be referenced. - * <p/> + * <p> * BaseDateTime subclasses may be mutable and not thread-safe. * * @author Stephen Colebourne @@ -73,7 +73,7 @@ public abstract class BaseDateTime /** * Constructs an instance set to the current system millisecond time * using <code>ISOChronology</code> in the specified time zone. - * <p/> + * <p> * If the specified time zone is null, the default zone is used. * * @param zone the time zone, null means default zone @@ -85,7 +85,7 @@ public abstract class BaseDateTime /** * Constructs an instance set to the current system millisecond time * using the specified chronology. - * <p/> + * <p> * If the chronology is null, <code>ISOChronology</code> * in the default time zone is used. * @@ -110,7 +110,7 @@ public abstract class BaseDateTime /** * Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z * using <code>ISOChronology</code> in the specified time zone. - * <p/> + * <p> * If the specified time zone is null, the default zone is used. * * @param instant the milliseconds from 1970-01-01T00:00:00Z @@ -123,7 +123,7 @@ public abstract class BaseDateTime /** * Constructs an instance set to the milliseconds from 1970-01-01T00:00:00Z * using the specified chronology. - * <p/> + * <p> * If the chronology is null, <code>ISOChronology</code> * in the default time zone is used. * @@ -145,10 +145,10 @@ public abstract class BaseDateTime /** * Constructs an instance from an Object that represents a datetime, * forcing the time zone to that specified. - * <p/> + * <p> * If the object contains no chronology, <code>ISOChronology</code> is used. * If the specified time zone is null, the default zone is used. - * <p/> + * <p> * The recognised object types are defined in * {@link org.joda.time.convert.ConverterManager ConverterManager} and * include ReadableInstant, String, Calendar and Date. @@ -168,9 +168,9 @@ public abstract class BaseDateTime /** * Constructs an instance from an Object that represents a datetime, * using the specified chronology. - * <p/> + * <p> * If the chronology is null, ISO in the default time zone is used. - * <p/> + * <p> * The recognised object types are defined in * {@link org.joda.time.convert.ConverterManager ConverterManager} and * include ReadableInstant, String, Calendar and Date. @@ -215,7 +215,7 @@ public abstract class BaseDateTime /** * Constructs an instance from datetime field values * using <code>ISOChronology</code> in the specified time zone. - * <p/> + * <p> * If the specified time zone is null, the default zone is used. * * @param year the year @@ -243,7 +243,7 @@ public abstract class BaseDateTime /** * Constructs an instance from datetime field values * using the specified chronology. - * <p/> + * <p> * If the chronology is null, <code>ISOChronology</code> * in the default time zone is used. * @@ -277,7 +277,7 @@ public abstract class BaseDateTime /** * Checks the specified chronology before storing it, potentially altering it. * This method must not access any instance variables. - * <p/> + * <p> * This implementation converts nulls to ISOChronology in the default zone. * * @param chronology the chronology to use, may be null @@ -290,7 +290,7 @@ public abstract class BaseDateTime /** * Checks the specified instant before storing it, potentially altering it. * This method must not access any instance variables. - * <p/> + * <p> * This implementation simply returns the instant. * * @param instant the milliseconds from 1970-01-01T00:00:00Z to round @@ -328,7 +328,7 @@ public abstract class BaseDateTime /** * Sets the milliseconds of the datetime. - * <p/> + * <p> * All changes to the millisecond field occurs via this method. * Override and block this method to make a subclass immutable. * @@ -340,7 +340,7 @@ public abstract class BaseDateTime /** * Sets the chronology of the datetime. - * <p/> + * <p> * All changes to the chronology field occurs via this method. * Override and block this method to make a subclass immutable. * diff --git a/core/src/test/java/org/elasticsearch/bwcompat/BasicBackwardsCompatibilityIT.java b/core/src/test/java/org/elasticsearch/bwcompat/BasicBackwardsCompatibilityIT.java index 76a31bcf20..5d65bf4556 100644 --- a/core/src/test/java/org/elasticsearch/bwcompat/BasicBackwardsCompatibilityIT.java +++ b/core/src/test/java/org/elasticsearch/bwcompat/BasicBackwardsCompatibilityIT.java @@ -77,7 +77,7 @@ import static org.hamcrest.Matchers.*; public class BasicBackwardsCompatibilityIT extends ESBackcompatTestCase { /** - * Basic test using Index & Realtime Get with external versioning. This test ensures routing works correctly across versions. + * Basic test using Index & Realtime Get with external versioning. This test ensures routing works correctly across versions. */ @Test public void testExternalVersion() throws Exception { @@ -101,7 +101,7 @@ public class BasicBackwardsCompatibilityIT extends ESBackcompatTestCase { } /** - * Basic test using Index & Realtime Get with internal versioning. This test ensures routing works correctly across versions. + * Basic test using Index & Realtime Get with internal versioning. This test ensures routing works correctly across versions. */ @Test public void testInternalVersion() throws Exception { diff --git a/core/src/test/java/org/elasticsearch/common/geo/GeoJSONShapeParserTests.java b/core/src/test/java/org/elasticsearch/common/geo/GeoJSONShapeParserTests.java index 53463e5605..94666d8c25 100644 --- a/core/src/test/java/org/elasticsearch/common/geo/GeoJSONShapeParserTests.java +++ b/core/src/test/java/org/elasticsearch/common/geo/GeoJSONShapeParserTests.java @@ -44,7 +44,7 @@ import static org.elasticsearch.common.geo.builders.ShapeBuilder.SPATIAL_CONTEXT /** - * Tests for {@link GeoJSONShapeParser} + * Tests for {@code GeoJSONShapeParser} */ public class GeoJSONShapeParserTests extends ESTestCase { diff --git a/core/src/test/java/org/elasticsearch/common/inject/ModuleTestCase.java b/core/src/test/java/org/elasticsearch/common/inject/ModuleTestCase.java index 3d4eaf9281..eeac5463db 100644 --- a/core/src/test/java/org/elasticsearch/common/inject/ModuleTestCase.java +++ b/core/src/test/java/org/elasticsearch/common/inject/ModuleTestCase.java @@ -80,7 +80,7 @@ public abstract class ModuleTestCase extends ESTestCase { } /** - * Configures the module and checks a Map<String, Class> of the "to" class + * Configures the module and checks a Map<String, Class> of the "to" class * is bound to "theClass". */ public void assertMapMultiBinding(Module module, Class to, Class theClass) { diff --git a/core/src/test/java/org/elasticsearch/common/rounding/RoundingTests.java b/core/src/test/java/org/elasticsearch/common/rounding/RoundingTests.java index b3a2cea212..53998c5cad 100644 --- a/core/src/test/java/org/elasticsearch/common/rounding/RoundingTests.java +++ b/core/src/test/java/org/elasticsearch/common/rounding/RoundingTests.java @@ -62,8 +62,8 @@ public class RoundingTests extends ESTestCase { /** * Simple test case to illustrate how Rounding.Offset works on readable input. - * offset shifts input value back before rounding (so here 6 - 7 -> -1) - * then shifts rounded Value back (here -10 -> -3) + * offset shifts input value back before rounding (so here 6 - 7 -> -1) + * then shifts rounded Value back (here -10 -> -3) */ @Test public void testOffsetRounding() { diff --git a/core/src/test/java/org/elasticsearch/common/rounding/TimeZoneRoundingTests.java b/core/src/test/java/org/elasticsearch/common/rounding/TimeZoneRoundingTests.java index 4e42c68aad..cc6f9cb1c1 100644 --- a/core/src/test/java/org/elasticsearch/common/rounding/TimeZoneRoundingTests.java +++ b/core/src/test/java/org/elasticsearch/common/rounding/TimeZoneRoundingTests.java @@ -72,7 +72,7 @@ public class TimeZoneRoundingTests extends ESTestCase { } /** - * test TimeIntervalTimeZoneRounding, (interval < 12h) with time zone shift + * test TimeIntervalTimeZoneRounding, (interval < 12h) with time zone shift */ @Test public void testTimeIntervalTimeZoneRounding() { @@ -88,7 +88,7 @@ public class TimeZoneRoundingTests extends ESTestCase { } /** - * test DayIntervalTimeZoneRounding, (interval >= 12h) with time zone shift + * test DayIntervalTimeZoneRounding, (interval >= 12h) with time zone shift */ @Test public void testDayIntervalTimeZoneRounding() { diff --git a/core/src/test/java/org/elasticsearch/discovery/DiscoveryWithServiceDisruptionsIT.java b/core/src/test/java/org/elasticsearch/discovery/DiscoveryWithServiceDisruptionsIT.java index e5de3be078..633070c664 100644 --- a/core/src/test/java/org/elasticsearch/discovery/DiscoveryWithServiceDisruptionsIT.java +++ b/core/src/test/java/org/elasticsearch/discovery/DiscoveryWithServiceDisruptionsIT.java @@ -179,8 +179,6 @@ public class DiscoveryWithServiceDisruptionsIT extends ESIntegTestCase { /** * Test that no split brain occurs under partial network partition. See https://github.com/elasticsearch/elasticsearch/issues/2488 - * - * @throws Exception */ @Test public void failWithMinimumMasterNodesConfigured() throws Exception { @@ -402,8 +400,8 @@ public class DiscoveryWithServiceDisruptionsIT extends ESIntegTestCase { /** * Test that we do not loose document whose indexing request was successful, under a randomly selected disruption scheme - * We also collect & report the type of indexing failures that occur. - * <p/> + * We also collect & report the type of indexing failures that occur. + * <p> * This test is a superset of tests run in the Jepsen test suite, with the exception of versioned updates */ @Test @@ -693,8 +691,6 @@ public class DiscoveryWithServiceDisruptionsIT extends ESIntegTestCase { /** * Test that a document which is indexed on the majority side of a partition, is available from the minority side, * once the partition is healed - * - * @throws Exception */ @Test @TestLogging(value = "cluster.service:TRACE") diff --git a/core/src/test/java/org/elasticsearch/index/IndexWithShadowReplicasIT.java b/core/src/test/java/org/elasticsearch/index/IndexWithShadowReplicasIT.java index 159576d6c5..0cbcaf9c2d 100644 --- a/core/src/test/java/org/elasticsearch/index/IndexWithShadowReplicasIT.java +++ b/core/src/test/java/org/elasticsearch/index/IndexWithShadowReplicasIT.java @@ -556,7 +556,6 @@ public class IndexWithShadowReplicasIT extends ESIntegTestCase { /** * Tests that shadow replicas can be "naturally" rebalanced and relocated * around the cluster. By "naturally" I mean without using the reroute API - * @throws Exception */ @Test public void testShadowReplicaNaturalRelocation() throws Exception { diff --git a/core/src/test/java/org/elasticsearch/index/mapper/geo/GeoShapeFieldMapperTests.java b/core/src/test/java/org/elasticsearch/index/mapper/geo/GeoShapeFieldMapperTests.java index 2fe5978639..26f7129e0a 100644 --- a/core/src/test/java/org/elasticsearch/index/mapper/geo/GeoShapeFieldMapperTests.java +++ b/core/src/test/java/org/elasticsearch/index/mapper/geo/GeoShapeFieldMapperTests.java @@ -65,7 +65,6 @@ public class GeoShapeFieldMapperTests extends ESSingleNodeTestCase { /** * Test that orientation parameter correctly parses - * @throws IOException */ public void testOrientationParsing() throws IOException { String mapping = XContentFactory.jsonBuilder().startObject().startObject("type1") @@ -104,7 +103,6 @@ public class GeoShapeFieldMapperTests extends ESSingleNodeTestCase { /** * Test that orientation parameter correctly parses - * @throws IOException */ public void testCoerceParsing() throws IOException { String mapping = XContentFactory.jsonBuilder().startObject().startObject("type1") diff --git a/core/src/test/java/org/elasticsearch/search/aggregations/bucket/DateHistogramIT.java b/core/src/test/java/org/elasticsearch/search/aggregations/bucket/DateHistogramIT.java index d5834c9265..37fff46f5d 100644 --- a/core/src/test/java/org/elasticsearch/search/aggregations/bucket/DateHistogramIT.java +++ b/core/src/test/java/org/elasticsearch/search/aggregations/bucket/DateHistogramIT.java @@ -645,7 +645,7 @@ public class DateHistogramIT extends ESIntegTestCase { /** * The script will change to document date values to the following: - * <p/> + * <p> * doc 1: [ Feb 2, Mar 3] * doc 2: [ Mar 2, Apr 3] * doc 3: [ Mar 15, Apr 16] @@ -700,7 +700,7 @@ public class DateHistogramIT extends ESIntegTestCase { /** * The script will change to document date values to the following: - * <p/> + * <p> * doc 1: [ Feb 2, Mar 3] * doc 2: [ Mar 2, Apr 3] * doc 3: [ Mar 15, Apr 16] diff --git a/core/src/test/java/org/elasticsearch/search/aggregations/bucket/DateHistogramOffsetIT.java b/core/src/test/java/org/elasticsearch/search/aggregations/bucket/DateHistogramOffsetIT.java index d0d91b8d66..08e07677fa 100644 --- a/core/src/test/java/org/elasticsearch/search/aggregations/bucket/DateHistogramOffsetIT.java +++ b/core/src/test/java/org/elasticsearch/search/aggregations/bucket/DateHistogramOffsetIT.java @@ -132,7 +132,6 @@ public class DateHistogramOffsetIT extends ESIntegTestCase { /** * Set offset so day buckets start at 6am. Index first 12 hours for two days, with one day gap. - * @throws Exception */ @Test public void singleValue_WithOffset_MinDocCount() throws Exception { diff --git a/core/src/test/java/org/elasticsearch/search/aggregations/pipeline/PipelineAggregationHelperTests.java b/core/src/test/java/org/elasticsearch/search/aggregations/pipeline/PipelineAggregationHelperTests.java index c26ac8db81..e962e90830 100644 --- a/core/src/test/java/org/elasticsearch/search/aggregations/pipeline/PipelineAggregationHelperTests.java +++ b/core/src/test/java/org/elasticsearch/search/aggregations/pipeline/PipelineAggregationHelperTests.java @@ -44,7 +44,6 @@ public class PipelineAggregationHelperTests extends ESTestCase { * @param size Size of mock histogram to generate (in buckets) * @param gapProbability Probability of generating an empty bucket. 0.0-1.0 inclusive * @param runProbability Probability of extending a gap once one has been created. 0.0-1.0 inclusive - * @return */ public static ArrayList<MockBucket> generateHistogram(int interval, int size, double gapProbability, double runProbability) { ArrayList<MockBucket> values = new ArrayList<>(size); @@ -109,7 +108,6 @@ public class PipelineAggregationHelperTests extends ESTestCase { * * @param values Array of values to compute metric for * @param metric A metric builder which defines what kind of metric should be returned for the values - * @return */ public static double calculateMetric(double[] values, ValuesSourceMetricsAggregationBuilder metric) { diff --git a/core/src/test/java/org/elasticsearch/search/aggregations/pipeline/moving/avg/MovAvgIT.java b/core/src/test/java/org/elasticsearch/search/aggregations/pipeline/moving/avg/MovAvgIT.java index d139e38a78..fe942dc9a5 100644 --- a/core/src/test/java/org/elasticsearch/search/aggregations/pipeline/moving/avg/MovAvgIT.java +++ b/core/src/test/java/org/elasticsearch/search/aggregations/pipeline/moving/avg/MovAvgIT.java @@ -235,7 +235,6 @@ public class MovAvgIT extends ESIntegTestCase { * Simple, unweighted moving average * * @param window Window of values to compute movavg for - * @return */ private double simple(Collection<Double> window) { double movAvg = 0; @@ -250,7 +249,6 @@ public class MovAvgIT extends ESIntegTestCase { * Linearly weighted moving avg * * @param window Window of values to compute movavg for - * @return */ private double linear(Collection<Double> window) { double avg = 0; @@ -269,7 +267,6 @@ public class MovAvgIT extends ESIntegTestCase { * Exponentionally weighted (EWMA, Single exponential) moving avg * * @param window Window of values to compute movavg for - * @return */ private double ewma(Collection<Double> window) { double avg = 0; @@ -289,7 +286,6 @@ public class MovAvgIT extends ESIntegTestCase { /** * Holt-Linear (Double exponential) moving avg * @param window Window of values to compute movavg for - * @return */ private double holt(Collection<Double> window) { double s = 0; @@ -323,7 +319,6 @@ public class MovAvgIT extends ESIntegTestCase { /** * Holt winters (triple exponential) moving avg * @param window Window of values to compute movavg for - * @return */ private double holtWinters(Collection<Double> window) { // Smoothed value @@ -1346,11 +1341,6 @@ public class MovAvgIT extends ESIntegTestCase { * Better floating point comparisons courtesy of https://github.com/brazzy/floating-point-gui.de * * Snippet adapted to use doubles instead of floats - * - * @param a - * @param b - * @param epsilon - * @return */ private static boolean nearlyEqual(double a, double b, double epsilon) { final double absA = Math.abs(a); diff --git a/core/src/test/java/org/elasticsearch/search/geo/GeoShapeIntegrationIT.java b/core/src/test/java/org/elasticsearch/search/geo/GeoShapeIntegrationIT.java index 5607266398..feb3322d7e 100644 --- a/core/src/test/java/org/elasticsearch/search/geo/GeoShapeIntegrationIT.java +++ b/core/src/test/java/org/elasticsearch/search/geo/GeoShapeIntegrationIT.java @@ -420,7 +420,6 @@ public class GeoShapeIntegrationIT extends ESIntegTestCase { /** * Test that orientation parameter correctly persists across cluster restart - * @throws IOException */ public void testOrientationPersistence() throws Exception { String idxName = "orientation"; diff --git a/core/src/test/java/org/elasticsearch/search/suggest/SuggestSearchIT.java b/core/src/test/java/org/elasticsearch/search/suggest/SuggestSearchIT.java index 1359f97ef8..e55a736a1d 100644 --- a/core/src/test/java/org/elasticsearch/search/suggest/SuggestSearchIT.java +++ b/core/src/test/java/org/elasticsearch/search/suggest/SuggestSearchIT.java @@ -869,7 +869,7 @@ public class SuggestSearchIT extends ESIntegTestCase { } /** - * Searching for a rare phrase shouldn't provide any suggestions if confidence > 1. This was possible before we rechecked the cutoff + * Searching for a rare phrase shouldn't provide any suggestions if confidence > 1. This was possible before we rechecked the cutoff * score during the reduce phase. Failures don't occur every time - maybe two out of five tries but we don't repeat it to save time. */ @Test @@ -937,7 +937,7 @@ public class SuggestSearchIT extends ESIntegTestCase { } /** - * If the suggester finds tons of options then picking the right one is slow without <<<INSERT SOLUTION HERE>>>. + * If the suggester finds tons of options then picking the right one is slow without <<<INSERT SOLUTION HERE>>>. */ @Test @Nightly diff --git a/core/src/test/java/org/elasticsearch/test/ESIntegTestCase.java b/core/src/test/java/org/elasticsearch/test/ESIntegTestCase.java index 4d14f49cb7..40b902589c 100644 --- a/core/src/test/java/org/elasticsearch/test/ESIntegTestCase.java +++ b/core/src/test/java/org/elasticsearch/test/ESIntegTestCase.java @@ -160,9 +160,9 @@ import static org.hamcrest.Matchers.*; * <li>{@link Scope#TEST} - uses a new cluster for each individual test method.</li> * <li>{@link Scope#SUITE} - uses a cluster shared across all test methods in the same suite</li> * </ul> - * <p/> + * <p> * The most common test scope is {@link Scope#SUITE} which shares a cluster per test suite. - * <p/> + * <p> * If the test methods need specific node settings or change persistent and/or transient cluster settings {@link Scope#TEST} * should be used. To configure a scope for the test cluster the {@link ClusterScope} annotation * should be used, here is an example: @@ -172,25 +172,23 @@ import static org.hamcrest.Matchers.*; * @Test public void testMethod() {} * } * </pre> - * <p/> + * <p> * If no {@link ClusterScope} annotation is present on an integration test the default scope is {@link Scope#SUITE} - * <p/> + * <p> * A test cluster creates a set of nodes in the background before the test starts. The number of nodes in the cluster is * determined at random and can change across tests. The {@link ClusterScope} allows configuring the initial number of nodes * that are created before the tests start. - * <p/> * <pre> * @ClusterScope(scope=Scope.SUITE, numDataNodes=3) * public class SomeIT extends ESIntegTestCase { * @Test public void testMethod() {} * } * </pre> - * <p/> + * <p> * Note, the {@link ESIntegTestCase} uses randomized settings on a cluster and index level. For instance * each test might use different directory implementation for each test or will return a random client to one of the * nodes in the cluster for each call to {@link #client()}. Test failures might only be reproducible if the correct * system properties are passed to the test execution environment. - * <p/> * <p> * This class supports the following system properties (passed with -Dkey=value to the application) * <ul> @@ -199,7 +197,6 @@ import static org.hamcrest.Matchers.*; * useful to test the system without asserting modules that to make sure they don't hide any bugs in production.</li> * <li> - a random seed used to initialize the index random context. * </ul> - * </p> */ @LuceneTestCase.SuppressFileSystems("ExtrasFS") // doesn't work with potential multi data path from test cluster yet public abstract class ESIntegTestCase extends ESTestCase { @@ -211,7 +208,7 @@ public abstract class ESIntegTestCase extends ESTestCase { /** * Annotation for third-party integration tests. - * <p/> + * <p> * These are tests the require a third-party service in order to run. They * may require the user to manually configure an external process (such as rabbitmq), * or may additionally require some external configuration (e.g. AWS credentials) @@ -964,7 +961,6 @@ public abstract class ESIntegTestCase extends ESTestCase { * * @param numDocs number of documents to wait for. * @return the actual number of docs seen. - * @throws InterruptedException */ public long waitForDocs(final long numDocs) throws InterruptedException { return waitForDocs(numDocs, null); @@ -977,7 +973,6 @@ public abstract class ESIntegTestCase extends ESTestCase { * @param indexer a {@link org.elasticsearch.test.BackgroundIndexer}. If supplied it will be first checked for documents indexed. * This saves on unneeded searches. * @return the actual number of docs seen. - * @throws InterruptedException */ public long waitForDocs(final long numDocs, final @Nullable BackgroundIndexer indexer) throws InterruptedException { // indexing threads can wait for up to ~1m before retrying when they first try to index into a shard which is not STARTED. @@ -993,7 +988,6 @@ public abstract class ESIntegTestCase extends ESTestCase { * @param indexer a {@link org.elasticsearch.test.BackgroundIndexer}. If supplied it will be first checked for documents indexed. * This saves on unneeded searches. * @return the actual number of docs seen. - * @throws InterruptedException */ public long waitForDocs(final long numDocs, int maxWaitTime, TimeUnit maxWaitTimeUnit, final @Nullable BackgroundIndexer indexer) throws InterruptedException { @@ -1219,11 +1213,10 @@ public abstract class ESIntegTestCase extends ESTestCase { /** * Syntactic sugar for: - * <p/> * <pre> * return client().prepareIndex(index, type, id).setSource(source).execute().actionGet(); * </pre> - * <p/> + * <p> * where source is a String. */ protected final IndexResponse index(String index, String type, String id, String source) { diff --git a/core/src/test/java/org/elasticsearch/test/ESTestCase.java b/core/src/test/java/org/elasticsearch/test/ESTestCase.java index dd60e96072..a1c511dc2a 100644 --- a/core/src/test/java/org/elasticsearch/test/ESTestCase.java +++ b/core/src/test/java/org/elasticsearch/test/ESTestCase.java @@ -241,7 +241,7 @@ public abstract class ESTestCase extends LuceneTestCase { /** * Returns a "scaled" random number between min and max (inclusive). * - * @see RandomizedTest#scaledRandomIntBetween(int, int); + * @see RandomizedTest#scaledRandomIntBetween(int, int) */ public static int scaledRandomIntBetween(int min, int max) { return RandomizedTest.scaledRandomIntBetween(min, max); diff --git a/core/src/test/java/org/elasticsearch/test/rest/section/GreaterThanAssertion.java b/core/src/test/java/org/elasticsearch/test/rest/section/GreaterThanAssertion.java index a136056685..ade7fbd59c 100644 --- a/core/src/test/java/org/elasticsearch/test/rest/section/GreaterThanAssertion.java +++ b/core/src/test/java/org/elasticsearch/test/rest/section/GreaterThanAssertion.java @@ -28,7 +28,7 @@ import static org.junit.Assert.fail; /** * Represents a gt assert section: - * <p/> + * <p> * - gt: { fields._ttl: 0} */ public class GreaterThanAssertion extends Assertion { diff --git a/core/src/test/java/org/elasticsearch/test/rest/section/LengthAssertion.java b/core/src/test/java/org/elasticsearch/test/rest/section/LengthAssertion.java index 4e81618c76..265487a038 100644 --- a/core/src/test/java/org/elasticsearch/test/rest/section/LengthAssertion.java +++ b/core/src/test/java/org/elasticsearch/test/rest/section/LengthAssertion.java @@ -30,7 +30,7 @@ import static org.junit.Assert.assertThat; /** * Represents a length assert section: - * <p/> + * <p> * - length: { hits.hits: 1 } */ public class LengthAssertion extends Assertion { |