* The main method will wait indefinitely on the parent process (Gradle) by * reading from stdin. When Gradle shuts down, whether normally or abruptly, the * pipe will be broken and read will return. - * + *
* The reaper will then iterate over the files in the configured directory, * and execute the given commands. If any commands fail, a failure message is * written to stderr. Otherwise, the input file will be deleted. If no inputs diff --git a/buildSrc/src/main/java/org/opensearch/gradle/BwcVersions.java b/buildSrc/src/main/java/org/opensearch/gradle/BwcVersions.java index cddd03ccc2019..4d45640b75e3d 100644 --- a/buildSrc/src/main/java/org/opensearch/gradle/BwcVersions.java +++ b/buildSrc/src/main/java/org/opensearch/gradle/BwcVersions.java @@ -52,15 +52,15 @@ /** * A container for opensearch supported version information used in BWC testing. - * + *
* Parse the Java source file containing the versions declarations and use the known rules to figure out which are all * the version the current one is wire and index compatible with. * On top of this, figure out which of these are unreleased and provide the branch they can be built from. - * + *
* Note that in this context, currentVersion is the unreleased version this build operates on. * At any point in time there will surely be four such unreleased versions being worked on, * thus currentVersion will be one of these. - * + *
* Considering: *
* Each branch has a current version, and expected compatible versions are parsed from the server code's Version` class. * We can reliably figure out which the unreleased versions are due to the convention of always adding the next unreleased * version number to server in all branches when a version is released. diff --git a/buildSrc/src/main/java/org/opensearch/gradle/LoggingOutputStream.java b/buildSrc/src/main/java/org/opensearch/gradle/LoggingOutputStream.java index 5ae7ad1595e2f..5259700b3a63d 100644 --- a/buildSrc/src/main/java/org/opensearch/gradle/LoggingOutputStream.java +++ b/buildSrc/src/main/java/org/opensearch/gradle/LoggingOutputStream.java @@ -38,7 +38,7 @@ /** * Writes data passed to this stream as log messages. - * + *
* The stream will be flushed whenever a newline is detected. * Allows setting an optional prefix before each line of output. */ diff --git a/buildSrc/src/main/java/org/opensearch/gradle/precommit/TestingConventionRule.java b/buildSrc/src/main/java/org/opensearch/gradle/precommit/TestingConventionRule.java index aa81ef75701fa..db46d2e3edc55 100644 --- a/buildSrc/src/main/java/org/opensearch/gradle/precommit/TestingConventionRule.java +++ b/buildSrc/src/main/java/org/opensearch/gradle/precommit/TestingConventionRule.java @@ -40,7 +40,7 @@ /** * Represent rules for tests enforced by the @{link {@link TestingConventionsTasks}} - * + *
* Rules are identified by name, tests must have this name as a suffix and implement one of the base classes * and be part of all the specified tasks. */ diff --git a/buildSrc/src/main/java/org/opensearch/gradle/tar/SymbolicLinkPreservingTar.java b/buildSrc/src/main/java/org/opensearch/gradle/tar/SymbolicLinkPreservingTar.java index 1423b52c443d9..e82d8ed73ced2 100644 --- a/buildSrc/src/main/java/org/opensearch/gradle/tar/SymbolicLinkPreservingTar.java +++ b/buildSrc/src/main/java/org/opensearch/gradle/tar/SymbolicLinkPreservingTar.java @@ -61,7 +61,7 @@ /** * A custom archive task that assembles a tar archive that preserves symbolic links. - * + *
* This task is necessary because the built-in task {@link org.gradle.api.tasks.bundling.Tar} does not preserve symbolic links.
*/
public class SymbolicLinkPreservingTar extends Tar {
diff --git a/buildSrc/src/main/java/org/opensearch/gradle/test/rest/RestResourcesPlugin.java b/buildSrc/src/main/java/org/opensearch/gradle/test/rest/RestResourcesPlugin.java
index 728e36ce98bff..fcadf35593ce6 100644
--- a/buildSrc/src/main/java/org/opensearch/gradle/test/rest/RestResourcesPlugin.java
+++ b/buildSrc/src/main/java/org/opensearch/gradle/test/rest/RestResourcesPlugin.java
@@ -65,7 +65,7 @@
* Rest YAML tests :
* When the {@link RestResourcesPlugin} has been applied the {@link CopyRestTestsTask} will copy the Rest YAML tests if explicitly
* configured with `includeCore` through the `restResources.restTests` extension.
- *
+ *
* Additionally you can specify which sourceSetName resources should be copied to. The default is the yamlRestTest source set. * @see CopyRestApiTask * @see CopyRestTestsTask diff --git a/buildSrc/src/main/java/org/opensearch/gradle/vagrant/VagrantMachine.java b/buildSrc/src/main/java/org/opensearch/gradle/vagrant/VagrantMachine.java index 2d71b9361963b..7abf9bf5fbef6 100644 --- a/buildSrc/src/main/java/org/opensearch/gradle/vagrant/VagrantMachine.java +++ b/buildSrc/src/main/java/org/opensearch/gradle/vagrant/VagrantMachine.java @@ -53,7 +53,7 @@ /** * An helper to manage a vagrant box. - * + *
* This is created alongside a {@link VagrantExtension} for a project to manage starting and * stopping a single vagrant box. */ @@ -185,7 +185,7 @@ public void setArgs(String... args) { /** * A function to translate output from the vagrant command execution to the progress line. - * + *
* The function takes the current line of output from vagrant, and returns a new * progress line, or {@code null} if there is no update. */ diff --git a/buildSrc/src/main/java/org/opensearch/gradle/vagrant/VagrantShellTask.java b/buildSrc/src/main/java/org/opensearch/gradle/vagrant/VagrantShellTask.java index 85d3e340c50e7..ca1b95183505f 100644 --- a/buildSrc/src/main/java/org/opensearch/gradle/vagrant/VagrantShellTask.java +++ b/buildSrc/src/main/java/org/opensearch/gradle/vagrant/VagrantShellTask.java @@ -47,7 +47,7 @@ /** * A shell script to run within a vagrant VM. - * + *
* The script is run as root within the VM. */ public abstract class VagrantShellTask extends DefaultTask { diff --git a/buildSrc/src/test/java/org/opensearch/gradle/pluginzip/PublishTests.java b/buildSrc/src/test/java/org/opensearch/gradle/pluginzip/PublishTests.java index c0e7320ba7615..8e246ff9ecd11 100644 --- a/buildSrc/src/test/java/org/opensearch/gradle/pluginzip/PublishTests.java +++ b/buildSrc/src/test/java/org/opensearch/gradle/pluginzip/PublishTests.java @@ -58,7 +58,7 @@ public void tearDown() { * This test is used to verify that adding the 'opensearch.pluginzip' to the project * adds some other transitive plugins and tasks under the hood. This is basically * a behavioral test of the {@link Publish#apply(Project)} method. - * + *
* This is equivalent of having a build.gradle script with just the following section: *
* plugins {
@@ -202,7 +202,7 @@ public void useDefaultValues() throws IOException, URISyntaxException, XmlPullPa
GradleRunner runner = prepareGradleRunnerFromTemplate("useDefaultValues.gradle", "build", ZIP_PUBLISH_TASK);
BuildResult result = runner.build();
- /** Check if build and {@value ZIP_PUBLISH_TASK} tasks have run well */
+ /* Check if build and ZIP_PUBLISH_TASK tasks have run well */
assertEquals(SUCCESS, result.task(":" + "build").getOutcome());
assertEquals(SUCCESS, result.task(":" + ZIP_PUBLISH_TASK).getOutcome());
@@ -277,7 +277,7 @@ public void allProjectsGroup() throws IOException, URISyntaxException, XmlPullPa
GradleRunner runner = prepareGradleRunnerFromTemplate("allProjectsGroup.gradle", "build", ZIP_PUBLISH_TASK);
BuildResult result = runner.build();
- /** Check if build and {@value ZIP_PUBLISH_TASK} tasks have run well */
+ /* Check if build and {@value ZIP_PUBLISH_TASK} tasks have run well */
assertEquals(SUCCESS, result.task(":" + "build").getOutcome());
assertEquals(SUCCESS, result.task(":" + ZIP_PUBLISH_TASK).getOutcome());
@@ -312,7 +312,7 @@ public void groupPriorityLevel() throws IOException, URISyntaxException, XmlPull
GradleRunner runner = prepareGradleRunnerFromTemplate("groupPriorityLevel.gradle", "build", ZIP_PUBLISH_TASK);
BuildResult result = runner.build();
- /** Check if build and {@value ZIP_PUBLISH_TASK} tasks have run well */
+ /* Check if build and {@value ZIP_PUBLISH_TASK} tasks have run well */
assertEquals(SUCCESS, result.task(":" + "build").getOutcome());
assertEquals(SUCCESS, result.task(":" + ZIP_PUBLISH_TASK).getOutcome());
@@ -348,7 +348,7 @@ public void missingPOMEntity() throws IOException, URISyntaxException, XmlPullPa
GradleRunner runner = prepareGradleRunnerFromTemplate("missingPOMEntity.gradle", "build", ZIP_PUBLISH_TASK);
BuildResult result = runner.build();
- /** Check if build and {@value ZIP_PUBLISH_TASK} tasks have run well */
+ /* Check if build and {@value ZIP_PUBLISH_TASK} tasks have run well */
assertEquals(SUCCESS, result.task(":" + "build").getOutcome());
assertEquals(SUCCESS, result.task(":" + ZIP_PUBLISH_TASK).getOutcome());
@@ -395,7 +395,7 @@ public void customizedGroupValue() throws IOException, URISyntaxException, XmlPu
GradleRunner runner = prepareGradleRunnerFromTemplate("customizedGroupValue.gradle", "build", ZIP_PUBLISH_TASK);
BuildResult result = runner.build();
- /** Check if build and {@value ZIP_PUBLISH_TASK} tasks have run well */
+ /* Check if build and {@value ZIP_PUBLISH_TASK} tasks have run well */
assertEquals(SUCCESS, result.task(":" + "build").getOutcome());
assertEquals(SUCCESS, result.task(":" + ZIP_PUBLISH_TASK).getOutcome());
diff --git a/buildSrc/src/testFixtures/java/org/opensearch/gradle/test/GradleThreadsFilter.java b/buildSrc/src/testFixtures/java/org/opensearch/gradle/test/GradleThreadsFilter.java
index b64c719440733..def5248c1f255 100644
--- a/buildSrc/src/testFixtures/java/org/opensearch/gradle/test/GradleThreadsFilter.java
+++ b/buildSrc/src/testFixtures/java/org/opensearch/gradle/test/GradleThreadsFilter.java
@@ -36,7 +36,7 @@
/**
* Filter out threads controlled by gradle that may be created during unit tests.
- *
+ *
* Currently this includes pooled threads for Exec as well as file system event watcher threads.
*/
public class GradleThreadsFilter implements ThreadFilter {
diff --git a/buildSrc/src/testFixtures/java/org/opensearch/gradle/test/JUnit3MethodProvider.java b/buildSrc/src/testFixtures/java/org/opensearch/gradle/test/JUnit3MethodProvider.java
index 163a903d31832..1a2e36aa78e9f 100644
--- a/buildSrc/src/testFixtures/java/org/opensearch/gradle/test/JUnit3MethodProvider.java
+++ b/buildSrc/src/testFixtures/java/org/opensearch/gradle/test/JUnit3MethodProvider.java
@@ -43,7 +43,7 @@
/**
* Backwards compatible test* method provider (public, non-static).
- *
+ *
* copy of org.apache.lucene.util.LuceneJUnit3MethodProvider to avoid a dependency between build and test fw.
*/
public final class JUnit3MethodProvider implements TestMethodProvider {
diff --git a/client/benchmark/src/main/java/org/opensearch/client/benchmark/metrics/SampleRecorder.java b/client/benchmark/src/main/java/org/opensearch/client/benchmark/metrics/SampleRecorder.java
index e53e4f1ad692d..9cd12f5e78bd0 100644
--- a/client/benchmark/src/main/java/org/opensearch/client/benchmark/metrics/SampleRecorder.java
+++ b/client/benchmark/src/main/java/org/opensearch/client/benchmark/metrics/SampleRecorder.java
@@ -37,7 +37,7 @@
/**
* Stores measurement samples.
- *
+ *
* This class is NOT threadsafe.
*/
public final class SampleRecorder {
diff --git a/client/rest-high-level/src/main/java/org/opensearch/client/ClusterClient.java b/client/rest-high-level/src/main/java/org/opensearch/client/ClusterClient.java
index 5bd5a5d0e308e..eb0a8b0e8f40a 100644
--- a/client/rest-high-level/src/main/java/org/opensearch/client/ClusterClient.java
+++ b/client/rest-high-level/src/main/java/org/opensearch/client/ClusterClient.java
@@ -170,8 +170,8 @@ public ClusterHealthResponse health(ClusterHealthRequest healthRequest, RequestO
/**
* Asynchronously get cluster health using the Cluster Health API.
- *
* If timeout occurred, {@link ClusterHealthResponse} will have isTimedOut() == true and status() == RestStatus.REQUEST_TIMEOUT
+ *
* @param healthRequest the request
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
* @param listener the listener to be notified upon request completion
diff --git a/client/rest-high-level/src/main/java/org/opensearch/client/RequestConverters.java b/client/rest-high-level/src/main/java/org/opensearch/client/RequestConverters.java
index 61a202d25167f..35d9929a649ff 100644
--- a/client/rest-high-level/src/main/java/org/opensearch/client/RequestConverters.java
+++ b/client/rest-high-level/src/main/java/org/opensearch/client/RequestConverters.java
@@ -451,9 +451,9 @@ static void addSearchRequestParams(Params params, SearchRequest searchRequest) {
params.withIndicesOptions(searchRequest.indicesOptions());
}
params.withSearchType(searchRequest.searchType().name().toLowerCase(Locale.ROOT));
- /**
- * Merging search responses as part of CCS flow to reduce roundtrips is not supported for point in time -
- * refer to org.opensearch.action.search.SearchResponseMerger
+ /*
+ Merging search responses as part of CCS flow to reduce roundtrips is not supported for point in time -
+ refer to org.opensearch.action.search.SearchResponseMerger
*/
if (searchRequest.pointInTimeBuilder() != null) {
params.putParam("ccs_minimize_roundtrips", "false");
diff --git a/client/rest-high-level/src/main/java/org/opensearch/client/TimedRequest.java b/client/rest-high-level/src/main/java/org/opensearch/client/TimedRequest.java
index dad5b6a3679ec..d40445b2daa81 100644
--- a/client/rest-high-level/src/main/java/org/opensearch/client/TimedRequest.java
+++ b/client/rest-high-level/src/main/java/org/opensearch/client/TimedRequest.java
@@ -37,7 +37,7 @@
/**
* A base request for any requests that supply timeouts.
- *
+ *
* Please note, any requests that use a ackTimeout should set timeout as they
* represent the same backing field on the server.
*/
diff --git a/client/rest-high-level/src/main/java/org/opensearch/client/indices/CreateIndexRequest.java b/client/rest-high-level/src/main/java/org/opensearch/client/indices/CreateIndexRequest.java
index 7805a7853b003..62c5b54c0e75e 100644
--- a/client/rest-high-level/src/main/java/org/opensearch/client/indices/CreateIndexRequest.java
+++ b/client/rest-high-level/src/main/java/org/opensearch/client/indices/CreateIndexRequest.java
@@ -156,7 +156,7 @@ public MediaType mappingsMediaType() {
/**
* Adds mapping that will be added when the index gets created.
- *
+ *
* Note that the definition should *not* be nested under a type name.
*
* @param source The mapping source
@@ -168,7 +168,7 @@ public CreateIndexRequest mapping(String source, MediaType mediaType) {
/**
* Adds mapping that will be added when the index gets created.
- *
+ *
* Note that the definition should *not* be nested under a type name.
*
* @param source The mapping source
@@ -179,7 +179,7 @@ public CreateIndexRequest mapping(XContentBuilder source) {
/**
* Adds mapping that will be added when the index gets created.
- *
+ *
* Note that the definition should *not* be nested under a type name.
*
* @param source The mapping source
@@ -196,7 +196,7 @@ public CreateIndexRequest mapping(Map source) {
/**
* Adds mapping that will be added when the index gets created.
- *
+ *
* Note that the definition should *not* be nested under a type name.
*
* @param source The mapping source
@@ -282,7 +282,7 @@ public CreateIndexRequest aliases(Collection aliases) {
/**
* Sets the settings and mappings as a single source.
- *
+ *
* Note that the mapping definition should *not* be nested under a type name.
*/
public CreateIndexRequest source(String source, MediaType mediaType) {
@@ -291,7 +291,7 @@ public CreateIndexRequest source(String source, MediaType mediaType) {
/**
* Sets the settings and mappings as a single source.
- *
+ *
* Note that the mapping definition should *not* be nested under a type name.
*/
public CreateIndexRequest source(XContentBuilder source) {
@@ -300,7 +300,7 @@ public CreateIndexRequest source(XContentBuilder source) {
/**
* Sets the settings and mappings as a single source.
- *
+ *
* Note that the mapping definition should *not* be nested under a type name.
*/
public CreateIndexRequest source(BytesReference source, MediaType mediaType) {
@@ -311,7 +311,7 @@ public CreateIndexRequest source(BytesReference source, MediaType mediaType) {
/**
* Sets the settings and mappings as a single source.
- *
+ *
* Note that the mapping definition should *not* be nested under a type name.
*/
@SuppressWarnings("unchecked")
diff --git a/client/rest-high-level/src/main/java/org/opensearch/client/indices/PutMappingRequest.java b/client/rest-high-level/src/main/java/org/opensearch/client/indices/PutMappingRequest.java
index 6d7e95d191ba6..a63393bd2341b 100644
--- a/client/rest-high-level/src/main/java/org/opensearch/client/indices/PutMappingRequest.java
+++ b/client/rest-high-level/src/main/java/org/opensearch/client/indices/PutMappingRequest.java
@@ -105,7 +105,7 @@ public MediaType mediaType() {
/**
* The mapping source definition.
- *
+ *
* Note that the definition should *not* be nested under a type name.
*/
public PutMappingRequest source(Map mappingSource) {
@@ -120,7 +120,7 @@ public PutMappingRequest source(Map mappingSource) {
/**
* The mapping source definition.
- *
+ *
* Note that the definition should *not* be nested under a type name.
*/
public PutMappingRequest source(String mappingSource, MediaType mediaType) {
@@ -131,7 +131,7 @@ public PutMappingRequest source(String mappingSource, MediaType mediaType) {
/**
* The mapping source definition.
- *
+ *
* Note that the definition should *not* be nested under a type name.
*/
public PutMappingRequest source(XContentBuilder builder) {
@@ -142,7 +142,7 @@ public PutMappingRequest source(XContentBuilder builder) {
/**
* The mapping source definition.
- *
+ *
* Note that the definition should *not* be nested under a type name.
*/
public PutMappingRequest source(BytesReference source, MediaType mediaType) {
diff --git a/client/rest-high-level/src/main/java/org/opensearch/client/tasks/TaskGroup.java b/client/rest-high-level/src/main/java/org/opensearch/client/tasks/TaskGroup.java
index c419884700587..9129de717459f 100644
--- a/client/rest-high-level/src/main/java/org/opensearch/client/tasks/TaskGroup.java
+++ b/client/rest-high-level/src/main/java/org/opensearch/client/tasks/TaskGroup.java
@@ -38,7 +38,6 @@
/**
* Client side counterpart of server side version.
- *
* {@link org.opensearch.action.admin.cluster.node.tasks.list.TaskGroup}
*/
public class TaskGroup {
diff --git a/client/rest-high-level/src/test/java/org/opensearch/client/AbstractRequestTestCase.java b/client/rest-high-level/src/test/java/org/opensearch/client/AbstractRequestTestCase.java
index 49bcb61b2dc3d..c464ee9ece74a 100644
--- a/client/rest-high-level/src/test/java/org/opensearch/client/AbstractRequestTestCase.java
+++ b/client/rest-high-level/src/test/java/org/opensearch/client/AbstractRequestTestCase.java
@@ -44,7 +44,7 @@
/**
* Base class for HLRC request parsing tests.
- *
+ *
* This case class facilitates generating client side request test instances and
* verifies that they are correctly parsed into server side request instances.
*
diff --git a/client/rest-high-level/src/test/java/org/opensearch/client/AbstractResponseTestCase.java b/client/rest-high-level/src/test/java/org/opensearch/client/AbstractResponseTestCase.java
index 27704b01560c4..7d2d6b87b85c6 100644
--- a/client/rest-high-level/src/test/java/org/opensearch/client/AbstractResponseTestCase.java
+++ b/client/rest-high-level/src/test/java/org/opensearch/client/AbstractResponseTestCase.java
@@ -44,7 +44,7 @@
/**
* Base class for HLRC response parsing tests.
- *
+ *
* This case class facilitates generating server side response test instances and
* verifies that they are correctly parsed into HLRC response instances.
*
diff --git a/client/rest-high-level/src/test/java/org/opensearch/client/BulkProcessorRetryIT.java b/client/rest-high-level/src/test/java/org/opensearch/client/BulkProcessorRetryIT.java
index b7f6328b3c88e..3678cc042ba47 100644
--- a/client/rest-high-level/src/test/java/org/opensearch/client/BulkProcessorRetryIT.java
+++ b/client/rest-high-level/src/test/java/org/opensearch/client/BulkProcessorRetryIT.java
@@ -180,7 +180,7 @@ private static MultiGetRequest indexDocs(BulkProcessor processor, int numDocs) {
/**
* Internal helper class to correlate backoff states with bulk responses. This is needed to check whether we maxed out the number
* of retries but still got rejected (which is perfectly fine and can also happen from time to time under heavy load).
- *
+ *
* This implementation relies on an implementation detail in Retry, namely that the bulk listener is notified on the same thread
* as the last call to the backoff policy's iterator. The advantage is that this is non-invasive to the rest of the production code.
*/
diff --git a/client/rest-high-level/src/test/java/org/opensearch/client/documentation/IndicesClientDocumentationIT.java b/client/rest-high-level/src/test/java/org/opensearch/client/documentation/IndicesClientDocumentationIT.java
index abb2d75aea751..ce080b45273b4 100644
--- a/client/rest-high-level/src/test/java/org/opensearch/client/documentation/IndicesClientDocumentationIT.java
+++ b/client/rest-high-level/src/test/java/org/opensearch/client/documentation/IndicesClientDocumentationIT.java
@@ -137,15 +137,15 @@
* You need to wrap your code between two tags like:
* // tag::example
* // end::example
- *
+ *
* Where example is your tag name.
- *
+ *
* Then in the documentation, you can extract what is between tag and end tags with
* ["source","java",subs="attributes,callouts,macros"]
* --------------------------------------------------
* include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[example]
* --------------------------------------------------
- *
+ *
* The column width of the code block is 84. If the code contains a line longer
* than 84, the line will be cut and a horizontal scroll bar will be displayed.
* (the code indentation of the tag is not included in the width)
diff --git a/client/rest-high-level/src/test/java/org/opensearch/client/documentation/IngestClientDocumentationIT.java b/client/rest-high-level/src/test/java/org/opensearch/client/documentation/IngestClientDocumentationIT.java
index d14759065b5eb..28909cf58541a 100644
--- a/client/rest-high-level/src/test/java/org/opensearch/client/documentation/IngestClientDocumentationIT.java
+++ b/client/rest-high-level/src/test/java/org/opensearch/client/documentation/IngestClientDocumentationIT.java
@@ -65,15 +65,15 @@
* You need to wrap your code between two tags like:
* // tag::example
* // end::example
- *
+ *
* Where example is your tag name.
- *
+ *
* Then in the documentation, you can extract what is between tag and end tags with
* ["source","java",subs="attributes,callouts,macros"]
* --------------------------------------------------
* include-tagged::{doc-tests}/IngestClientDocumentationIT.java[example]
* --------------------------------------------------
- *
+ *
* The column width of the code block is 84. If the code contains a line longer
* than 84, the line will be cut and a horizontal scroll bar will be displayed.
* (the code indentation of the tag is not included in the width)
diff --git a/client/rest-high-level/src/test/java/org/opensearch/client/documentation/SnapshotClientDocumentationIT.java b/client/rest-high-level/src/test/java/org/opensearch/client/documentation/SnapshotClientDocumentationIT.java
index 50bcf79642eac..d0015db044843 100644
--- a/client/rest-high-level/src/test/java/org/opensearch/client/documentation/SnapshotClientDocumentationIT.java
+++ b/client/rest-high-level/src/test/java/org/opensearch/client/documentation/SnapshotClientDocumentationIT.java
@@ -90,15 +90,15 @@
* You need to wrap your code between two tags like:
* // tag::example
* // end::example
- *
+ *
* Where example is your tag name.
- *
+ *
* Then in the documentation, you can extract what is between tag and end tags with
* ["source","java",subs="attributes,callouts,macros"]
* --------------------------------------------------
* include-tagged::{doc-tests}/SnapshotClientDocumentationIT.java[example]
* --------------------------------------------------
- *
+ *
* The column width of the code block is 84. If the code contains a line longer
* than 84, the line will be cut and a horizontal scroll bar will be displayed.
* (the code indentation of the tag is not included in the width)
diff --git a/client/rest-high-level/src/test/java/org/opensearch/client/documentation/StoredScriptsDocumentationIT.java b/client/rest-high-level/src/test/java/org/opensearch/client/documentation/StoredScriptsDocumentationIT.java
index 6916ae11556e2..2e2d15df5392a 100644
--- a/client/rest-high-level/src/test/java/org/opensearch/client/documentation/StoredScriptsDocumentationIT.java
+++ b/client/rest-high-level/src/test/java/org/opensearch/client/documentation/StoredScriptsDocumentationIT.java
@@ -66,15 +66,15 @@
* You need to wrap your code between two tags like:
* // tag::example
* // end::example
- *
+ *
* Where example is your tag name.
- *
+ *
* Then in the documentation, you can extract what is between tag and end tags with
* ["source","java",subs="attributes,callouts,macros"]
* --------------------------------------------------
* include-tagged::{doc-tests}/StoredScriptsDocumentationIT.java[example]
* --------------------------------------------------
- *
+ *
* The column width of the code block is 84. If the code contains a line longer
* than 84, the line will be cut and a horizontal scroll bar will be displayed.
* (the code indentation of the tag is not included in the width)
diff --git a/client/rest-high-level/src/test/java/org/opensearch/client/documentation/TasksClientDocumentationIT.java b/client/rest-high-level/src/test/java/org/opensearch/client/documentation/TasksClientDocumentationIT.java
index 03e267aafd1b7..cbac0b8c97d9c 100644
--- a/client/rest-high-level/src/test/java/org/opensearch/client/documentation/TasksClientDocumentationIT.java
+++ b/client/rest-high-level/src/test/java/org/opensearch/client/documentation/TasksClientDocumentationIT.java
@@ -66,15 +66,15 @@
* You need to wrap your code between two tags like:
* // tag::example
* // end::example
- *
+ *
* Where example is your tag name.
- *
+ *
* Then in the documentation, you can extract what is between tag and end tags with
* ["source","java",subs="attributes,callouts,macros"]
* --------------------------------------------------
* include-tagged::{doc-tests}/{@link TasksClientDocumentationIT}.java[example]
* --------------------------------------------------
- *
+ *
* The column width of the code block is 84. If the code contains a line longer
* than 84, the line will be cut and a horizontal scroll bar will be displayed.
* (the code indentation of the tag is not included in the width)
diff --git a/client/rest-high-level/src/test/java/org/opensearch/client/indices/RandomCreateIndexGenerator.java b/client/rest-high-level/src/test/java/org/opensearch/client/indices/RandomCreateIndexGenerator.java
index 1f747dc139d15..edb4d16c6d992 100644
--- a/client/rest-high-level/src/test/java/org/opensearch/client/indices/RandomCreateIndexGenerator.java
+++ b/client/rest-high-level/src/test/java/org/opensearch/client/indices/RandomCreateIndexGenerator.java
@@ -44,7 +44,7 @@ public class RandomCreateIndexGenerator {
/**
* Returns a random {@link CreateIndexRequest}.
- *
+ *
* Randomizes the index name, the aliases, mappings and settings associated with the
* index. When present, the mappings make no mention of types.
*/
diff --git a/client/rest/src/main/java/org/opensearch/client/RestClient.java b/client/rest/src/main/java/org/opensearch/client/RestClient.java
index e819fa27a8939..7691c01daefea 100644
--- a/client/rest/src/main/java/org/opensearch/client/RestClient.java
+++ b/client/rest/src/main/java/org/opensearch/client/RestClient.java
@@ -310,7 +310,7 @@ public boolean isRunning() {
* they will be retried). In case of failures all of the alive nodes (or
* dead nodes that deserve a retry) are retried until one responds or none
* of them does, in which case an {@link IOException} will be thrown.
- *
+ *
* This method works by performing an asynchronous call and waiting
* for the result. If the asynchronous call throws an exception we wrap
* it and rethrow it so that the stack trace attached to the exception
diff --git a/client/rest/src/test/java/org/opensearch/client/documentation/RestClientDocumentation.java b/client/rest/src/test/java/org/opensearch/client/documentation/RestClientDocumentation.java
index b2807d35d230e..42c31864e0578 100644
--- a/client/rest/src/test/java/org/opensearch/client/documentation/RestClientDocumentation.java
+++ b/client/rest/src/test/java/org/opensearch/client/documentation/RestClientDocumentation.java
@@ -89,15 +89,15 @@
* You need to wrap your code between two tags like:
* // tag::example[]
* // end::example[]
- *
+ *
* Where example is your tag name.
- *
+ *
* Then in the documentation, you can extract what is between tag and end tags with
* ["source","java",subs="attributes,callouts,macros"]
* --------------------------------------------------
* include-tagged::{doc-tests}/RestClientDocumentation.java[example]
* --------------------------------------------------
- *
+ *
* Note that this is not a test class as we are only interested in testing that docs snippets compile. We don't want
* to send requests to a node and we don't even have the tools to do it.
*/
diff --git a/client/sniffer/src/test/java/org/opensearch/client/sniff/documentation/SnifferDocumentation.java b/client/sniffer/src/test/java/org/opensearch/client/sniff/documentation/SnifferDocumentation.java
index 440e9a2ea5cd1..8a4ca1fb0a136 100644
--- a/client/sniffer/src/test/java/org/opensearch/client/sniff/documentation/SnifferDocumentation.java
+++ b/client/sniffer/src/test/java/org/opensearch/client/sniff/documentation/SnifferDocumentation.java
@@ -49,15 +49,15 @@
* You need to wrap your code between two tags like:
* // tag::example[]
* // end::example[]
- *
+ *
* Where example is your tag name.
- *
+ *
* Then in the documentation, you can extract what is between tag and end tags with
* ["source","java",subs="attributes,callouts,macros"]
* --------------------------------------------------
* include-tagged::{doc-tests}/SnifferDocumentation.java[example]
* --------------------------------------------------
- *
+ *
* Note that this is not a test class as we are only interested in testing that docs snippets compile. We don't want
* to send requests to a node and we don't even have the tools to do it.
*/
diff --git a/distribution/tools/launchers/src/main/java/org/opensearch/tools/launchers/SystemJvmOptions.java b/distribution/tools/launchers/src/main/java/org/opensearch/tools/launchers/SystemJvmOptions.java
index aa3dfbe39ee96..726c381db09f6 100644
--- a/distribution/tools/launchers/src/main/java/org/opensearch/tools/launchers/SystemJvmOptions.java
+++ b/distribution/tools/launchers/src/main/java/org/opensearch/tools/launchers/SystemJvmOptions.java
@@ -101,15 +101,15 @@ private static String maybeShowCodeDetailsInExceptionMessages() {
}
private static String javaLocaleProviders() {
- /**
- * SPI setting is used to allow loading custom CalendarDataProvider
- * in jdk8 it has to be loaded from jre/lib/ext,
- * in jdk9+ it is already within ES project and on a classpath
- *
- * Due to internationalization enhancements in JDK 9 OpenSearch need to set the provider to COMPAT otherwise time/date
- * parsing will break in an incompatible way for some date patterns and locales.
- * //TODO COMPAT will be deprecated in at some point, see please https://bugs.openjdk.java.net/browse/JDK-8232906
- * See also: documentation in server/org.opensearch.common.time.IsoCalendarDataProvider
+ /*
+ SPI setting is used to allow loading custom CalendarDataProvider
+ in jdk8 it has to be loaded from jre/lib/ext,
+ in jdk9+ it is already within ES project and on a classpath
+
+ Due to internationalization enhancements in JDK 9 OpenSearch need to set the provider to COMPAT otherwise time/date
+ parsing will break in an incompatible way for some date patterns and locales.
+ //TODO COMPAT will be deprecated in at some point, see please https://bugs.openjdk.java.net/browse/JDK-8232906
+ See also: documentation in server/org.opensearch.common.time.IsoCalendarDataProvider
*/
return "-Djava.locale.providers=SPI,COMPAT";
}
diff --git a/distribution/tools/plugin-cli/src/main/java/org/opensearch/plugins/InstallPluginCommand.java b/distribution/tools/plugin-cli/src/main/java/org/opensearch/plugins/InstallPluginCommand.java
index 66f43b1e30d28..838d6e22a37bd 100644
--- a/distribution/tools/plugin-cli/src/main/java/org/opensearch/plugins/InstallPluginCommand.java
+++ b/distribution/tools/plugin-cli/src/main/java/org/opensearch/plugins/InstallPluginCommand.java
@@ -107,7 +107,7 @@
/**
* A command for the plugin cli to install a plugin into opensearch.
- *
+ *
* The install command takes a plugin id, which may be any of the following:
*
* - An official opensearch plugin name
@@ -411,7 +411,7 @@ private String getMavenUrl(Terminal terminal, String[] coordinates, String platf
/**
* Returns {@code true} if the given url exists, and {@code false} otherwise.
- *
+ *
* The given url must be {@code https} and existing means a {@code HEAD} request returns 200.
*/
// pkg private for tests to manipulate
@@ -698,7 +698,6 @@ InputStream getPublicKey() {
/**
* Creates a URL and opens a connection.
- *
* If the URL returns a 404, {@code null} is returned, otherwise the open URL opject is returned.
*/
// pkg private for tests
diff --git a/distribution/tools/plugin-cli/src/main/java/org/opensearch/plugins/ProgressInputStream.java b/distribution/tools/plugin-cli/src/main/java/org/opensearch/plugins/ProgressInputStream.java
index 579f676631a5a..02be3dbc82a44 100644
--- a/distribution/tools/plugin-cli/src/main/java/org/opensearch/plugins/ProgressInputStream.java
+++ b/distribution/tools/plugin-cli/src/main/java/org/opensearch/plugins/ProgressInputStream.java
@@ -41,7 +41,7 @@
* The listener is triggered whenever a full percent is increased
* The listener is never triggered twice on the same percentage
* The listener will always return 99 percent, if the expectedTotalSize is exceeded, until it is finished
- *
+ *
* Only used by the InstallPluginCommand, thus package private here
*/
abstract class ProgressInputStream extends FilterInputStream {
diff --git a/distribution/tools/upgrade-cli/src/main/java/org/opensearch/upgrade/UpgradeTask.java b/distribution/tools/upgrade-cli/src/main/java/org/opensearch/upgrade/UpgradeTask.java
index b7dcbd50cf781..708f644bcdeb6 100644
--- a/distribution/tools/upgrade-cli/src/main/java/org/opensearch/upgrade/UpgradeTask.java
+++ b/distribution/tools/upgrade-cli/src/main/java/org/opensearch/upgrade/UpgradeTask.java
@@ -17,7 +17,7 @@
* An interface for an upgrade task, which in this instance is an unit of
* operation that is part of the overall upgrade process. This extends the
* {@link java.util.function.Consumer} interface.
- *
+ *
* The implementing tasks consume and instance of a tuple of {@link TaskInput}
* and {@link Terminal} and operate via side effects.
*
diff --git a/doc-tools/missing-doclet/src/main/java/org/opensearch/missingdoclet/MissingDoclet.java b/doc-tools/missing-doclet/src/main/java/org/opensearch/missingdoclet/MissingDoclet.java
index e6122e7baf91a..e1ad55fe4b60b 100644
--- a/doc-tools/missing-doclet/src/main/java/org/opensearch/missingdoclet/MissingDoclet.java
+++ b/doc-tools/missing-doclet/src/main/java/org/opensearch/missingdoclet/MissingDoclet.java
@@ -45,7 +45,7 @@
* It isn't recursive, just ignores exactly the elements you tell it.
* Has option --missing-method to apply "method" level to selected packages (fix one at a time).
* Matches package names exactly: so you'll need to list subpackages separately.
- *
+ *
* Note: This by default ignores javadoc validation on overridden methods.
*/
// Original version of this class is ported from MissingDoclet code in Lucene,
diff --git a/libs/cli/src/main/java/org/opensearch/cli/Command.java b/libs/cli/src/main/java/org/opensearch/cli/Command.java
index eed5c4ba4ee6f..cc9230bdb2282 100644
--- a/libs/cli/src/main/java/org/opensearch/cli/Command.java
+++ b/libs/cli/src/main/java/org/opensearch/cli/Command.java
@@ -162,7 +162,7 @@ protected static void exit(int status) {
/**
* Executes this command.
- *
+ *
* Any runtime user errors (like an input file that does not exist), should throw a {@link UserException}. */
protected abstract void execute(Terminal terminal, OptionSet options) throws Exception;
diff --git a/libs/cli/src/main/java/org/opensearch/cli/Terminal.java b/libs/cli/src/main/java/org/opensearch/cli/Terminal.java
index be030c18507ad..fb1097178e5a3 100644
--- a/libs/cli/src/main/java/org/opensearch/cli/Terminal.java
+++ b/libs/cli/src/main/java/org/opensearch/cli/Terminal.java
@@ -44,7 +44,7 @@
/**
* A Terminal wraps access to reading input and writing output for a cli.
- *
+ *
* The available methods are similar to those of {@link Console}, with the ability
* to read either normal text or a password, and the ability to print a line
* of text. Printing is also gated by the {@link Verbosity} of the terminal,
diff --git a/libs/common/src/main/java/org/opensearch/bootstrap/JarHell.java b/libs/common/src/main/java/org/opensearch/bootstrap/JarHell.java
index c4ba778e7db86..fc5e364241d12 100644
--- a/libs/common/src/main/java/org/opensearch/bootstrap/JarHell.java
+++ b/libs/common/src/main/java/org/opensearch/bootstrap/JarHell.java
@@ -104,7 +104,7 @@ public static void checkJarHell(Consumer output) throws IOException, URI
/**
* Parses the classpath into an array of URLs
- * @return array of URLs
+ * @return collection of URLs
* @throws IllegalStateException if the classpath contains empty elements
*/
public static Set parseClassPath() {
@@ -114,7 +114,7 @@ public static Set parseClassPath() {
/**
* Parses the classpath into a set of URLs. For testing.
* @param classPath classpath to parse (typically the system property {@code java.class.path})
- * @return array of URLs
+ * @return collection of URLs
* @throws IllegalStateException if the classpath contains empty elements
*/
@SuppressForbidden(reason = "resolves against CWD because that is how classpaths work")
diff --git a/libs/common/src/main/java/org/opensearch/common/Explicit.java b/libs/common/src/main/java/org/opensearch/common/Explicit.java
index 66e079c461e75..e060baf6f187e 100644
--- a/libs/common/src/main/java/org/opensearch/common/Explicit.java
+++ b/libs/common/src/main/java/org/opensearch/common/Explicit.java
@@ -38,7 +38,7 @@
* Holds a value that is either:
* a) set implicitly e.g. through some default value
* b) set explicitly e.g. from a user selection
- *
+ *
* When merging conflicting configuration settings such as
* field mapping settings it is preferable to preserve an explicit
* choice rather than a choice made only made implicitly by defaults.
diff --git a/libs/common/src/main/java/org/opensearch/common/LocalTimeOffset.java b/libs/common/src/main/java/org/opensearch/common/LocalTimeOffset.java
index 7e89641927ed5..eb7b331c9aa24 100644
--- a/libs/common/src/main/java/org/opensearch/common/LocalTimeOffset.java
+++ b/libs/common/src/main/java/org/opensearch/common/LocalTimeOffset.java
@@ -514,7 +514,7 @@ public boolean anyMoveBackToPreviousDay() {
* Builds an array that can be {@link Arrays#binarySearch(long[], long)}ed
* for the daylight savings time transitions.
*
- * @openearch.internal
+ * @opensearch.internal
*/
private static class TransitionArrayLookup extends AbstractManyTransitionsLookup {
private final LocalTimeOffset[] offsets;
diff --git a/libs/common/src/main/java/org/opensearch/common/SetOnce.java b/libs/common/src/main/java/org/opensearch/common/SetOnce.java
index a596b5fcdb61d..778926ce108b7 100644
--- a/libs/common/src/main/java/org/opensearch/common/SetOnce.java
+++ b/libs/common/src/main/java/org/opensearch/common/SetOnce.java
@@ -35,7 +35,7 @@
* A convenient class which offers a semi-immutable object wrapper implementation which allows one
* to set the value of an object exactly once, and retrieve it many times. If {@link #set(Object)}
* is called more than once, {@link AlreadySetException} is thrown and the operation will fail.
- *
+ *
* This is borrowed from lucene's experimental API. It is not reused to eliminate the dependency
* on lucene core for such a simple (standalone) utility class that may change beyond OpenSearch needs.
*
diff --git a/libs/common/src/main/java/org/opensearch/common/collect/Tuple.java b/libs/common/src/main/java/org/opensearch/common/collect/Tuple.java
index d0b94536b0729..5c0e3f2de7708 100644
--- a/libs/common/src/main/java/org/opensearch/common/collect/Tuple.java
+++ b/libs/common/src/main/java/org/opensearch/common/collect/Tuple.java
@@ -34,7 +34,6 @@
/**
* Java 9 Tuple
- *
* todo: deprecate and remove w/ min jdk upgrade to 11?
*
* @opensearch.internal
diff --git a/libs/common/src/main/java/org/opensearch/common/io/PathUtils.java b/libs/common/src/main/java/org/opensearch/common/io/PathUtils.java
index b3526859933ec..ed8d50892b74a 100644
--- a/libs/common/src/main/java/org/opensearch/common/io/PathUtils.java
+++ b/libs/common/src/main/java/org/opensearch/common/io/PathUtils.java
@@ -93,7 +93,7 @@ public static Path get(URI uri) {
/**
* Tries to resolve the given path against the list of available roots.
- *
+ *
* If path starts with one of the listed roots, it returned back by this method, otherwise null is returned.
*/
public static Path get(Path[] roots, String path) {
@@ -109,7 +109,7 @@ public static Path get(Path[] roots, String path) {
/**
* Tries to resolve the given file uri against the list of available roots.
- *
+ *
* If uri starts with one of the listed roots, it returned back by this method, otherwise null is returned.
*/
public static Path get(Path[] roots, URI uri) {
diff --git a/libs/common/src/main/java/org/opensearch/common/network/InetAddresses.java b/libs/common/src/main/java/org/opensearch/common/network/InetAddresses.java
index a4fbc6cb65b0d..0f289c09bbae2 100644
--- a/libs/common/src/main/java/org/opensearch/common/network/InetAddresses.java
+++ b/libs/common/src/main/java/org/opensearch/common/network/InetAddresses.java
@@ -368,7 +368,7 @@ public static InetAddress forString(String ipString) {
/**
* Convert a byte array into an InetAddress.
- *
+ *
* {@link InetAddress#getByAddress} is documented as throwing a checked
* exception "if IP address is of illegal length." We replace it with
* an unchecked exception, for use by callers who already know that addr
@@ -423,7 +423,7 @@ public static Tuple parseCidr(String maskedAddress) {
/**
* Given an address and prefix length, returns the string representation of the range in CIDR notation.
- *
+ *
* See {@link #toAddrString} for details on how the address is represented.
*/
public static String toCidrString(InetAddress address, int prefixLength) {
diff --git a/libs/common/src/main/java/org/opensearch/common/unit/TimeValue.java b/libs/common/src/main/java/org/opensearch/common/unit/TimeValue.java
index a3fcffb1d6a4c..30ed5bf63a748 100644
--- a/libs/common/src/main/java/org/opensearch/common/unit/TimeValue.java
+++ b/libs/common/src/main/java/org/opensearch/common/unit/TimeValue.java
@@ -224,10 +224,10 @@ public double getDaysFrac() {
/**
* Returns a {@link String} representation of the current {@link TimeValue}.
- *
+ *
* Note that this method might produce fractional time values (ex 1.6m) which cannot be
* parsed by method like {@link TimeValue#parse(String, String, String, String)}.
- *
+ *
* Also note that the maximum string value that will be generated is
* {@code 106751.9d} due to the way that values are internally converted
* to nanoseconds (106751.9 days is Long.MAX_VALUE nanoseconds)
@@ -239,12 +239,12 @@ public String toString() {
/**
* Returns a {@link String} representation of the current {@link TimeValue}.
- *
+ *
* Note that this method might produce fractional time values (ex 1.6m) which cannot be
* parsed by method like {@link TimeValue#parse(String, String, String, String)}. The number of
* fractional decimals (up to 10 maximum) are truncated to the number of fraction pieces
* specified.
- *
+ *
* Also note that the maximum string value that will be generated is
* {@code 106751.9d} due to the way that values are internally converted
* to nanoseconds (106751.9 days is Long.MAX_VALUE nanoseconds)
diff --git a/libs/common/src/main/java/org/opensearch/common/util/BitMixer.java b/libs/common/src/main/java/org/opensearch/common/util/BitMixer.java
index 8762217916c7a..d6ea4fa359df3 100644
--- a/libs/common/src/main/java/org/opensearch/common/util/BitMixer.java
+++ b/libs/common/src/main/java/org/opensearch/common/util/BitMixer.java
@@ -25,9 +25,9 @@
/**
* Bit mixing utilities from carrotsearch.hppc.
- *
+ *
* Licensed under ALv2. This is pulled in directly to avoid a full hppc dependency.
- *
+ *
* The purpose of these methods is to evenly distribute key space over int32
* range.
*/
@@ -111,7 +111,7 @@ public static int mix32(int k) {
/**
* Computes David Stafford variant 9 of 64bit mix function (MH3 finalization step,
* with different shifts and constants).
- *
+ *
* Variant 9 is picked because it contains two 32-bit shifts which could be possibly
* optimized into better machine code.
*
diff --git a/libs/core/src/main/java/org/opensearch/Build.java b/libs/core/src/main/java/org/opensearch/Build.java
index 67a50a8a31a0e..b5d67f5501725 100644
--- a/libs/core/src/main/java/org/opensearch/Build.java
+++ b/libs/core/src/main/java/org/opensearch/Build.java
@@ -216,7 +216,7 @@ public String getDistribution() {
/**
* Get the version as considered at build time
- *
+ *
* Offers a way to get the fully qualified version as configured by the build.
* This will be the same as {@link Version} for production releases, but may include on of the qualifier ( e.x alpha1 )
* or -SNAPSHOT for others.
diff --git a/libs/core/src/main/java/org/opensearch/LegacyESVersion.java b/libs/core/src/main/java/org/opensearch/LegacyESVersion.java
index 32eae654cf975..5d8e067a8fd8b 100644
--- a/libs/core/src/main/java/org/opensearch/LegacyESVersion.java
+++ b/libs/core/src/main/java/org/opensearch/LegacyESVersion.java
@@ -40,7 +40,7 @@
/**
* The Contents of this file were originally moved from {@link Version}.
- *
+ *
* This class keeps all the supported OpenSearch predecessor versions for
* backward compatibility purpose.
*
diff --git a/libs/core/src/main/java/org/opensearch/OpenSearchException.java b/libs/core/src/main/java/org/opensearch/OpenSearchException.java
index 5bad711a15032..cce86b452f698 100644
--- a/libs/core/src/main/java/org/opensearch/OpenSearchException.java
+++ b/libs/core/src/main/java/org/opensearch/OpenSearchException.java
@@ -168,7 +168,7 @@ public OpenSearchException(Throwable cause) {
/**
* Construct a OpenSearchException with the specified detail message.
- *
+ *
* The message can be parameterized using {} as placeholders for the given
* arguments
*
@@ -182,7 +182,7 @@ public OpenSearchException(String msg, Object... args) {
/**
* Construct a OpenSearchException with the specified detail message
* and nested exception.
- *
+ *
* The message can be parameterized using {} as placeholders for the given
* arguments
*
@@ -587,7 +587,7 @@ public static OpenSearchException innerFromXContent(XContentParser parser, boole
* Static toXContent helper method that renders {@link OpenSearchException} or {@link Throwable} instances
* as XContent, delegating the rendering to {@link OpenSearchException#toXContent(XContentBuilder, ToXContent.Params)}
* or {@link #innerToXContent(XContentBuilder, ToXContent.Params, Throwable, String, String, Map, Map, Throwable)}.
- *
+ *
* This method is usually used when the {@link Throwable} is rendered as a part of another XContent object, and its result can
* be parsed back using the {@code OpenSearchException.fromXContent(XContentParser)} method.
*/
@@ -606,7 +606,7 @@ public static void generateThrowableXContent(XContentBuilder builder, ToXContent
* depends on the value of the "detailed" parameter: when it's false only a simple message based on the type and message of the
* exception is rendered. When it's true all detail are provided including guesses root causes, cause and potentially stack
* trace.
- *
+ *
* This method is usually used when the {@link Exception} is rendered as a full XContent object, and its output can be parsed
* by the {@code #OpenSearchException.failureFromXContent(XContentParser)} method.
*/
diff --git a/libs/core/src/main/java/org/opensearch/core/action/ActionListener.java b/libs/core/src/main/java/org/opensearch/core/action/ActionListener.java
index 119e56cfe0bf2..4fd55898a2cb5 100644
--- a/libs/core/src/main/java/org/opensearch/core/action/ActionListener.java
+++ b/libs/core/src/main/java/org/opensearch/core/action/ActionListener.java
@@ -154,9 +154,9 @@ static ActionListener wrap(Runnable runnable) {
/**
* Creates a listener that wraps another listener, mapping response values via the given mapping function and passing along
* exceptions to the delegate.
- *
+ *
* Notice that it is considered a bug if the listener's onResponse or onFailure fails. onResponse failures will not call onFailure.
- *
+ *
* If the function fails, the listener's onFailure handler will be called. The principle is that the mapped listener will handle
* exceptions from the mapping function {@code fn} but it is the responsibility of {@code delegate} to handle its own exceptions
* inside `onResponse` and `onFailure`.
@@ -334,7 +334,7 @@ protected void innerOnFailure(Exception e) {
/**
* Completes the given listener with the result from the provided supplier accordingly.
* This method is mainly used to complete a listener with a block of synchronous code.
- *
+ *
* If the supplier fails, the listener's onFailure handler will be called.
* It is the responsibility of {@code delegate} to handle its own exceptions inside `onResponse` and `onFailure`.
*/
diff --git a/libs/core/src/main/java/org/opensearch/core/common/Strings.java b/libs/core/src/main/java/org/opensearch/core/common/Strings.java
index 6227716af9cc9..8fdec670bd9f2 100644
--- a/libs/core/src/main/java/org/opensearch/core/common/Strings.java
+++ b/libs/core/src/main/java/org/opensearch/core/common/Strings.java
@@ -38,7 +38,7 @@
/**
* String utility class.
- *
+ *
* TODO replace Strings in :server
*
* @opensearch.internal
diff --git a/libs/core/src/main/java/org/opensearch/core/common/bytes/CompositeBytesReference.java b/libs/core/src/main/java/org/opensearch/core/common/bytes/CompositeBytesReference.java
index 53915a3da824c..1a48abee2dbf8 100644
--- a/libs/core/src/main/java/org/opensearch/core/common/bytes/CompositeBytesReference.java
+++ b/libs/core/src/main/java/org/opensearch/core/common/bytes/CompositeBytesReference.java
@@ -45,7 +45,7 @@
/**
* A composite {@link BytesReference} that allows joining multiple bytes references
* into one without copying.
- *
+ *
* Note, {@link #toBytesRef()} will materialize all pages in this BytesReference.
*
* @opensearch.internal
diff --git a/libs/core/src/main/java/org/opensearch/core/common/io/stream/BytesStreamInput.java b/libs/core/src/main/java/org/opensearch/core/common/io/stream/BytesStreamInput.java
index a50d1c165ed72..30c84708728ef 100644
--- a/libs/core/src/main/java/org/opensearch/core/common/io/stream/BytesStreamInput.java
+++ b/libs/core/src/main/java/org/opensearch/core/common/io/stream/BytesStreamInput.java
@@ -17,7 +17,7 @@
* {@link StreamInput} version of Lucene's {@link org.apache.lucene.store.ByteArrayDataInput}
* This is used as a replacement of Lucene ByteArrayDataInput for abstracting byte order changes
* in Lucene's API
- *
+ *
* Attribution given to apache lucene project under ALv2:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
diff --git a/libs/core/src/main/java/org/opensearch/core/common/io/stream/NamedWriteableRegistry.java b/libs/core/src/main/java/org/opensearch/core/common/io/stream/NamedWriteableRegistry.java
index abac76c8b6c27..123b52eb92876 100644
--- a/libs/core/src/main/java/org/opensearch/core/common/io/stream/NamedWriteableRegistry.java
+++ b/libs/core/src/main/java/org/opensearch/core/common/io/stream/NamedWriteableRegistry.java
@@ -43,7 +43,7 @@
/**
* A registry for {@link Writeable.Reader} readers of {@link NamedWriteable}.
- *
+ *
* The registration is keyed by the combination of the category class of {@link NamedWriteable}, and a name unique
* to that category.
*
diff --git a/libs/core/src/main/java/org/opensearch/core/common/io/stream/StreamInput.java b/libs/core/src/main/java/org/opensearch/core/common/io/stream/StreamInput.java
index ece2012302919..3e996bdee83a2 100644
--- a/libs/core/src/main/java/org/opensearch/core/common/io/stream/StreamInput.java
+++ b/libs/core/src/main/java/org/opensearch/core/common/io/stream/StreamInput.java
@@ -96,7 +96,7 @@
/**
* A stream from this node to another node. Technically, it can also be streamed to a byte array but that is mostly for testing.
- *
+ *
* This class's methods are optimized so you can put the methods that read and write a class next to each other and you can scan them
* visually for differences. That means that most variables should be read and written in a single line so even large objects fit both
* reading and writing on the screen. It also means that the methods on this class are named very similarly to {@link StreamOutput}. Finally
@@ -1128,7 +1128,7 @@ public C readNamedWriteable(@SuppressWarnings("unused
* the corresponding entry in the registry by name, so that the proper object can be read and returned.
* Default implementation throws {@link UnsupportedOperationException} as StreamInput doesn't hold a registry.
* Use {@link FilterInputStream} instead which wraps a stream and supports a {@link NamedWriteableRegistry} too.
- *
+ *
* Prefer {@link StreamInput#readNamedWriteable(Class)} and {@link StreamOutput#writeNamedWriteable(NamedWriteable)} unless you
* have a compelling reason to use this method instead.
*/
diff --git a/libs/core/src/main/java/org/opensearch/core/common/io/stream/StreamOutput.java b/libs/core/src/main/java/org/opensearch/core/common/io/stream/StreamOutput.java
index 94b813246bc7e..2d69e1c686df3 100644
--- a/libs/core/src/main/java/org/opensearch/core/common/io/stream/StreamOutput.java
+++ b/libs/core/src/main/java/org/opensearch/core/common/io/stream/StreamOutput.java
@@ -88,7 +88,7 @@
/**
* A stream from another node to this node. Technically, it can also be streamed from a byte array but that is mostly for testing.
- *
+ *
* This class's methods are optimized so you can put the methods that read and write a class next to each other and you can scan them
* visually for differences. That means that most variables should be read and written in a single line so even large objects fit both
* reading and writing on the screen. It also means that the methods on this class are named very similarly to {@link StreamInput}. Finally
diff --git a/libs/core/src/main/java/org/opensearch/core/common/settings/SecureString.java b/libs/core/src/main/java/org/opensearch/core/common/settings/SecureString.java
index 322300a554284..45ee72f558724 100644
--- a/libs/core/src/main/java/org/opensearch/core/common/settings/SecureString.java
+++ b/libs/core/src/main/java/org/opensearch/core/common/settings/SecureString.java
@@ -50,7 +50,7 @@ public final class SecureString implements CharSequence, Closeable {
/**
* Constructs a new SecureString which controls the passed in char array.
- *
+ *
* Note: When this instance is closed, the array will be zeroed out.
*/
public SecureString(char[] chars) {
@@ -59,7 +59,7 @@ public SecureString(char[] chars) {
/**
* Constructs a new SecureString from an existing String.
- *
+ *
* NOTE: This is not actually secure, since the provided String cannot be deallocated, but
* this constructor allows for easy compatibility between new and old apis.
*
diff --git a/libs/core/src/main/java/org/opensearch/core/common/unit/ByteSizeUnit.java b/libs/core/src/main/java/org/opensearch/core/common/unit/ByteSizeUnit.java
index c15db75d06d49..49eadbbb2bc00 100644
--- a/libs/core/src/main/java/org/opensearch/core/common/unit/ByteSizeUnit.java
+++ b/libs/core/src/main/java/org/opensearch/core/common/unit/ByteSizeUnit.java
@@ -45,7 +45,7 @@
* A {@code SizeUnit} does not maintain size information, but only
* helps organize and use size representations that may be maintained
* separately across various contexts.
- *
+ *
* It use conventional data storage values (base-2) :
*
* - 1KB = 1024 bytes
diff --git a/libs/core/src/main/java/org/opensearch/core/compress/Compressor.java b/libs/core/src/main/java/org/opensearch/core/compress/Compressor.java
index 27d5b5dfdfa15..5324ea6151e51 100644
--- a/libs/core/src/main/java/org/opensearch/core/compress/Compressor.java
+++ b/libs/core/src/main/java/org/opensearch/core/compress/Compressor.java
@@ -43,7 +43,7 @@
/**
* Compressor interface used for compressing {@link org.opensearch.core.xcontent.MediaType} and
* {@code org.opensearch.repositories.blobstore.BlobStoreRepository} implementations.
- *
+ *
* This is not to be confused with {@link org.apache.lucene.codecs.compressing.Compressor} which is used
* for codec implementations such as {@code org.opensearch.index.codec.customcodecs.Lucene95CustomCodec}
* for compressing {@link org.apache.lucene.document.StoredField}s
diff --git a/libs/core/src/main/java/org/opensearch/core/compress/CompressorRegistry.java b/libs/core/src/main/java/org/opensearch/core/compress/CompressorRegistry.java
index 9290254c30d8d..af09a7aebba79 100644
--- a/libs/core/src/main/java/org/opensearch/core/compress/CompressorRegistry.java
+++ b/libs/core/src/main/java/org/opensearch/core/compress/CompressorRegistry.java
@@ -23,7 +23,7 @@
/**
* A registry that wraps a static Map singleton which holds a mapping of unique String names (typically the
* compressor header as a string) to registerd {@link Compressor} implementations.
- *
+ *
* This enables plugins, modules, extensions to register their own compression implementations through SPI
*
* @opensearch.experimental
@@ -105,7 +105,7 @@ public static Compressor getCompressor(final String name) {
/**
* Returns the registered compressors as an Immutable collection
- *
+ *
* note: used for testing
*/
public static Map registeredCompressors() {
diff --git a/libs/core/src/main/java/org/opensearch/core/compress/spi/CompressorProvider.java b/libs/core/src/main/java/org/opensearch/core/compress/spi/CompressorProvider.java
index 019e282444d64..9b806618fe0a0 100644
--- a/libs/core/src/main/java/org/opensearch/core/compress/spi/CompressorProvider.java
+++ b/libs/core/src/main/java/org/opensearch/core/compress/spi/CompressorProvider.java
@@ -18,7 +18,7 @@
/**
* Service Provider Interface for plugins, modules, extensions providing custom
* compression algorithms
- *
+ *
* see {@link Compressor} for implementing methods
* and {@link org.opensearch.core.compress.CompressorRegistry} for the registration of custom
* Compressors
diff --git a/libs/core/src/main/java/org/opensearch/core/index/Index.java b/libs/core/src/main/java/org/opensearch/core/index/Index.java
index b5ee482bcd952..a927179114188 100644
--- a/libs/core/src/main/java/org/opensearch/core/index/Index.java
+++ b/libs/core/src/main/java/org/opensearch/core/index/Index.java
@@ -48,7 +48,7 @@
/**
* A value class representing the basic required properties of an OpenSearch index.
- *
+ *
* (This class is immutable.)
*
* @opensearch.api
@@ -116,7 +116,7 @@ public String getUUID() {
/**
* Returns either the name and unique identifier of the index
* or only the name if the uuid is {@link Strings#UNKNOWN_UUID_VALUE}.
- *
+ *
* If we have a uuid we put it in the toString so it'll show up in logs
* which is useful as more and more things use the uuid rather
* than the name as the lookup key for the index.
diff --git a/libs/core/src/main/java/org/opensearch/core/index/shard/ShardId.java b/libs/core/src/main/java/org/opensearch/core/index/shard/ShardId.java
index 984434190b486..c0abad7ed727f 100644
--- a/libs/core/src/main/java/org/opensearch/core/index/shard/ShardId.java
+++ b/libs/core/src/main/java/org/opensearch/core/index/shard/ShardId.java
@@ -143,7 +143,7 @@ public String toString() {
/**
* Parse the string representation of this shardId back to an object.
- *
+ *
* We lose index uuid information here, but since we use toString in
* rest responses, this is the best we can do to reconstruct the object
* on the client side.
diff --git a/libs/core/src/main/java/org/opensearch/core/xcontent/AbstractObjectParser.java b/libs/core/src/main/java/org/opensearch/core/xcontent/AbstractObjectParser.java
index a0e2a54fce91c..79e531a542026 100644
--- a/libs/core/src/main/java/org/opensearch/core/xcontent/AbstractObjectParser.java
+++ b/libs/core/src/main/java/org/opensearch/core/xcontent/AbstractObjectParser.java
@@ -108,7 +108,7 @@ public abstract void declareNamedObject(
*
* Unlike the other version of this method, "ordered" mode (arrays of
* objects) is not supported.
- *
+ *
* See NamedObjectHolder in ObjectParserTests for examples of how to invoke
* this.
*
@@ -163,7 +163,7 @@ public abstract void declareNamedObjects(
* the order sent but tools that generate json are free to put object
* members in an unordered Map, jumbling them. Thus, if you care about order
* you can send the object in the second way.
- *
+ *
* See NamedObjectHolder in ObjectParserTests for examples of how to invoke
* this.
*
@@ -366,10 +366,10 @@ public void declareFieldArray(
/**
* Declares a set of fields that are required for parsing to succeed. Only one of the values
* provided per String[] must be matched.
- *
+ *
* E.g. declareRequiredFieldSet("foo", "bar"); means at least one of "foo" or
* "bar" fields must be present. If neither of those fields are present, an exception will be thrown.
- *
+ *
* Multiple required sets can be configured:
*
*
@@ -379,7 +379,7 @@ public void declareFieldArray(
*
* requires that one of "foo" or "bar" fields are present, and also that one of "bizz" or
* "buzz" fields are present.
- *
+ *
* In JSON, it means any of these combinations are acceptable:
*
*
@@ -415,12 +415,12 @@ public void declareFieldArray(
/**
* Declares a set of fields of which at most one must appear for parsing to succeed
- *
+ *
* E.g. declareExclusiveFieldSet("foo", "bar"); means that only one of 'foo'
* or 'bar' must be present, and if both appear then an exception will be thrown. Note
* that this does not make 'foo' or 'bar' required - see {@link #declareRequiredFieldSet(String...)}
* for required fields.
- *
+ *
* Multiple exclusive sets may be declared
*
* @param exclusiveSet a set of field names, at most one of which must appear
diff --git a/libs/core/src/main/java/org/opensearch/core/xcontent/MapXContentParser.java b/libs/core/src/main/java/org/opensearch/core/xcontent/MapXContentParser.java
index 254c340f8836f..0a5cda324ddb7 100644
--- a/libs/core/src/main/java/org/opensearch/core/xcontent/MapXContentParser.java
+++ b/libs/core/src/main/java/org/opensearch/core/xcontent/MapXContentParser.java
@@ -277,7 +277,7 @@ public Token currentToken() {
/**
* field name that the child element needs to inherit.
- *
+ *
* In most cases this is the same as currentName() except with embedded arrays. In "foo": [[42]] the first START_ARRAY
* token will have the name "foo", but the second START_ARRAY will have no name.
*/
diff --git a/libs/core/src/main/java/org/opensearch/core/xcontent/XContentBuilder.java b/libs/core/src/main/java/org/opensearch/core/xcontent/XContentBuilder.java
index a38bdd049ee88..976f353100c55 100644
--- a/libs/core/src/main/java/org/opensearch/core/xcontent/XContentBuilder.java
+++ b/libs/core/src/main/java/org/opensearch/core/xcontent/XContentBuilder.java
@@ -726,7 +726,7 @@ public XContentBuilder value(byte[] value, int offset, int length) throws IOExce
/**
* Writes the binary content of the given byte array as UTF-8 bytes.
- *
+ *
* Use {@link XContentParser#charBuffer()} to read the value back
*/
public XContentBuilder utf8Value(byte[] bytes, int offset, int length) throws IOException {
diff --git a/libs/core/src/main/java/org/opensearch/core/xcontent/XContentBuilderExtension.java b/libs/core/src/main/java/org/opensearch/core/xcontent/XContentBuilderExtension.java
index 0535da1a584be..9b13ebb23be86 100644
--- a/libs/core/src/main/java/org/opensearch/core/xcontent/XContentBuilderExtension.java
+++ b/libs/core/src/main/java/org/opensearch/core/xcontent/XContentBuilderExtension.java
@@ -37,7 +37,7 @@
/**
* This interface provides a way for non-JDK classes to plug in a way to serialize to xcontent.
- *
+ *
* It is greatly preferred that you implement {@link ToXContentFragment}
* in the class for encoding, however, in some situations you may not own the
* class, in which case you can add an implementation here for encoding it.
@@ -63,7 +63,7 @@ public interface XContentBuilderExtension {
* Used for plugging in a human readable version of a class's encoding. It is assumed that
* the human readable equivalent is always behind the {@code toString()} method, so
* this transformer returns the raw value to be used.
- *
+ *
* An example implementation:
*
*
@@ -79,7 +79,7 @@ public interface XContentBuilderExtension {
/**
* Used for plugging a transformer for a date or time type object into a String (or other
* encodable object).
- *
+ *
* For example:
*
*
diff --git a/libs/core/src/main/java/org/opensearch/core/xcontent/XContentParser.java b/libs/core/src/main/java/org/opensearch/core/xcontent/XContentParser.java
index a2f16209a5b7f..4bfd47ccfdc94 100644
--- a/libs/core/src/main/java/org/opensearch/core/xcontent/XContentParser.java
+++ b/libs/core/src/main/java/org/opensearch/core/xcontent/XContentParser.java
@@ -44,7 +44,7 @@
/**
* Interface for pull - parsing {@link XContent} see {@code XContentType} for supported types.
- *
+ *
* To obtain an instance of this class use the following pattern:
*
*
@@ -202,11 +202,11 @@ Map map(Supplier> mapFactory, CheckedFunction
* Default implementation simply returns false since only actual
* implementation class has knowledge of its internal buffering
* state.
- *
+ *
* This method shouldn't be used to check if the token contains text or not.
*/
boolean hasTextCharacters();
diff --git a/libs/core/src/main/java/org/opensearch/core/xcontent/XContentParserUtils.java b/libs/core/src/main/java/org/opensearch/core/xcontent/XContentParserUtils.java
index 13e2f6a695d1b..b10be393f9adb 100644
--- a/libs/core/src/main/java/org/opensearch/core/xcontent/XContentParserUtils.java
+++ b/libs/core/src/main/java/org/opensearch/core/xcontent/XContentParserUtils.java
@@ -142,10 +142,10 @@ public static Object parseFieldsValue(XContentParser parser) throws IOException
* This method expects that the current field name is the concatenation of a type, a delimiter and a name
* (ex: terms#foo where "terms" refers to the type of a registered {@link NamedXContentRegistry.Entry},
* "#" is the delimiter and "foo" the name of the object to parse).
- *
+ *
* It also expected that following this field name is either an Object or an array xContent structure and
* the cursor points to the start token of this structure.
- *
+ *
* The method splits the field's name to extract the type and name and then parses the object
* using the {@link XContentParser#namedObject(Class, String, Object)} method.
*
diff --git a/libs/core/src/main/java/org/opensearch/core/xcontent/XContentSubParser.java b/libs/core/src/main/java/org/opensearch/core/xcontent/XContentSubParser.java
index d1cdda4aeb8be..337cf9f95fe5f 100644
--- a/libs/core/src/main/java/org/opensearch/core/xcontent/XContentSubParser.java
+++ b/libs/core/src/main/java/org/opensearch/core/xcontent/XContentSubParser.java
@@ -43,7 +43,7 @@
/**
* Wrapper for a XContentParser that makes a single object/array look like a complete document.
- *
+ *
* The wrapper prevents the parsing logic to consume tokens outside of the wrapped object as well
* as skipping to the end of the object in case of a parsing error. The wrapper is intended to be
* used for parsing objects that should be ignored if they are malformed.
diff --git a/libs/dissect/src/main/java/org/opensearch/dissect/DissectParser.java b/libs/dissect/src/main/java/org/opensearch/dissect/DissectParser.java
index 9861847c9e1ea..b6dc0ceb1028f 100644
--- a/libs/dissect/src/main/java/org/opensearch/dissect/DissectParser.java
+++ b/libs/dissect/src/main/java/org/opensearch/dissect/DissectParser.java
@@ -194,26 +194,25 @@ public DissectParser(String pattern, String appendSeparator) {
* @throws DissectException if unable to dissect a pair into it's parts.
*/
public Map parse(String inputString) {
- /**
- *
- * This implements a naive string matching algorithm. The string is walked left to right, comparing each byte against
- * another string's bytes looking for matches. If the bytes match, then a second cursor looks ahead to see if all the bytes
- * of the other string matches. If they all match, record it and advances the primary cursor to the match point. If it can not match
- * all of the bytes then progress the main cursor. Repeat till the end of the input string. Since the string being searching for
- * (the delimiter) is generally small and rare the naive approach is efficient.
- *
- * In this case the string that is walked is the input string, and the string being searched for is the current delimiter.
- * For example for a dissect pattern of {@code %{a},%{b}:%{c}} the delimiters (comma then colon) are searched for in the
- * input string. At class construction the list of keys+delimiters are found (dissectPairs), which allows the use of that ordered
- * list to know which delimiter to use for the search. The delimiters is progressed once the current delimiter is matched.
- *
- * There are two special cases that requires additional parsing beyond the standard naive algorithm. Consecutive delimiters should
- * results in a empty matches unless the {@code ->} is provided. For example given the dissect pattern of
- * {@code %{a},%{b},%{c},%{d}} and input string of {@code foo,,,} the match should be successful with empty values for b,c and d.
- * However, if the key modifier {@code ->}, is present it will simply skip over any delimiters just to the right of the key
- * without assigning any values. For example {@code %{a->},{%b}} will match the input string of {@code foo,,,,,,bar} with a=foo and
- * b=bar.
- *
+ /*
+
+ This implements a naive string matching algorithm. The string is walked left to right, comparing each byte against
+ another string's bytes looking for matches. If the bytes match, then a second cursor looks ahead to see if all the bytes
+ of the other string matches. If they all match, record it and advances the primary cursor to the match point. If it can not match
+ all of the bytes then progress the main cursor. Repeat till the end of the input string. Since the string being searching for
+ (the delimiter) is generally small and rare the naive approach is efficient.
+
+ In this case the string that is walked is the input string, and the string being searched for is the current delimiter.
+ For example for a dissect pattern of {@code %{a},%{b}:%{c}} the delimiters (comma then colon) are searched for in the
+ input string. At class construction the list of keys+delimiters are found (dissectPairs), which allows the use of that ordered
+ list to know which delimiter to use for the search. The delimiters is progressed once the current delimiter is matched.
+
+ There are two special cases that requires additional parsing beyond the standard naive algorithm. Consecutive delimiters should
+ results in a empty matches unless the {@code ->} is provided. For example given the dissect pattern of
+ {@code %{a},%{b},%{c},%{d}} and input string of {@code foo,,,} the match should be successful with empty values for b,c and d.
+ However, if the key modifier {@code ->}, is present it will simply skip over any delimiters just to the right of the key
+ without assigning any values. For example {@code %{a->},{%b}} will match the input string of {@code foo,,,,,,bar} with a=foo and
+ b=bar.
*/
DissectMatch dissectMatch = new DissectMatch(appendSeparator, maxMatches, maxResults, appendCount, referenceCount);
Iterator it = matchPairs.iterator();
diff --git a/libs/geo/src/main/java/org/opensearch/geometry/Circle.java b/libs/geo/src/main/java/org/opensearch/geometry/Circle.java
index cf1dce8966e1f..c05f316b53b9c 100644
--- a/libs/geo/src/main/java/org/opensearch/geometry/Circle.java
+++ b/libs/geo/src/main/java/org/opensearch/geometry/Circle.java
@@ -180,6 +180,7 @@ public int hashCode() {
/**
* Visit this circle with a {@link GeometryVisitor}.
+ *
* @param visitor The visitor
* @param The return type of the visitor
* @param The exception type of the visitor
diff --git a/libs/geo/src/main/java/org/opensearch/geometry/utils/BitUtil.java b/libs/geo/src/main/java/org/opensearch/geometry/utils/BitUtil.java
index 664e7e68d96a5..c946cc2473202 100644
--- a/libs/geo/src/main/java/org/opensearch/geometry/utils/BitUtil.java
+++ b/libs/geo/src/main/java/org/opensearch/geometry/utils/BitUtil.java
@@ -48,8 +48,8 @@ public class BitUtil { // magic numbers for bit interleaving
/**
* Interleaves the first 32 bits of each long value
- *
- * Adapted from: http://graphics.stanford.edu/~seander/bithacks.html#InterleaveBMN
+ *
+ * Adapted from: bithacks.html#InterleaveBMN
*/
public static long interleave(int even, int odd) {
long v1 = 0x00000000FFFFFFFFL & even;
diff --git a/libs/geo/src/main/java/org/opensearch/geometry/utils/Geohash.java b/libs/geo/src/main/java/org/opensearch/geometry/utils/Geohash.java
index 8b3b841e221e5..33c423e136613 100644
--- a/libs/geo/src/main/java/org/opensearch/geometry/utils/Geohash.java
+++ b/libs/geo/src/main/java/org/opensearch/geometry/utils/Geohash.java
@@ -39,12 +39,12 @@
/**
* Utilities for converting to/from the GeoHash standard
- *
+ *
* The geohash long format is represented as lon/lat (x/y) interleaved with the 4 least significant bits
* representing the level (1-12) [xyxy...xyxyllll]
- *
+ *
* This differs from a morton encoded value which interleaves lat/lon (y/x).
- *
+ *
* NOTE: this will replace {@code org.opensearch.common.geo.GeoHashUtils}
*/
public class Geohash {
diff --git a/libs/grok/src/main/java/org/opensearch/grok/Grok.java b/libs/grok/src/main/java/org/opensearch/grok/Grok.java
index cd786b74be039..7aa3347ba4f4b 100644
--- a/libs/grok/src/main/java/org/opensearch/grok/Grok.java
+++ b/libs/grok/src/main/java/org/opensearch/grok/Grok.java
@@ -151,7 +151,7 @@ private void validatePatternBank() {
/**
* Checks whether patterns reference each other in a circular manner and, if so, fail with an exception.
* Also checks for malformed pattern definitions and fails with an exception.
- *
+ *
* In a pattern, anything between %{ and } or : is considered
* a reference to another named pattern. This method will navigate to all these named patterns and
* check for a circular reference.
diff --git a/libs/grok/src/main/java/org/opensearch/grok/MatcherWatchdog.java b/libs/grok/src/main/java/org/opensearch/grok/MatcherWatchdog.java
index 5c7eaca2a634a..d5b7566ecc90f 100644
--- a/libs/grok/src/main/java/org/opensearch/grok/MatcherWatchdog.java
+++ b/libs/grok/src/main/java/org/opensearch/grok/MatcherWatchdog.java
@@ -44,7 +44,7 @@
* Protects against long running operations that happen between the register and unregister invocations.
* Threads that invoke {@link #register(Matcher)}, but take too long to invoke the {@link #unregister(Matcher)} method
* will be interrupted.
- *
+ *
* This is needed for Joni's {@link org.joni.Matcher#search(int, int, int)} method, because
* it can end up spinning endlessly if the regular expression is too complex. Joni has checks
* that for every 30k iterations it checks if the current thread is interrupted and if so
diff --git a/libs/nio/src/main/java/org/opensearch/nio/ChannelContext.java b/libs/nio/src/main/java/org/opensearch/nio/ChannelContext.java
index 797dfe859fa6c..0e29661978716 100644
--- a/libs/nio/src/main/java/org/opensearch/nio/ChannelContext.java
+++ b/libs/nio/src/main/java/org/opensearch/nio/ChannelContext.java
@@ -116,10 +116,10 @@ protected void handleException(Exception e) {
/**
* Schedules a channel to be closed by the selector event loop with which it is registered.
- *
+ *
* If the channel is open and the state can be transitioned to closed, the close operation will
* be scheduled with the event loop.
- *
+ *
* Depending on the underlying protocol of the channel, a close operation might simply close the socket
* channel or may involve reading and writing messages.
*/
diff --git a/libs/nio/src/main/java/org/opensearch/nio/NioSelector.java b/libs/nio/src/main/java/org/opensearch/nio/NioSelector.java
index a38a33182afea..4ed745723515c 100644
--- a/libs/nio/src/main/java/org/opensearch/nio/NioSelector.java
+++ b/libs/nio/src/main/java/org/opensearch/nio/NioSelector.java
@@ -512,12 +512,12 @@ private void handleQueuedWrites() {
* This is a convenience method to be called after some object (normally channels) are enqueued with this
* selector. This method will check if the selector is still open. If it is open, normal operation can
* proceed.
- *
+ *
* If the selector is closed, then we attempt to remove the object from the queue. If the removal
* succeeds then we throw an {@link IllegalStateException} indicating that normal operation failed. If
* the object cannot be removed from the queue, then the object has already been handled by the selector
* and operation can proceed normally.
- *
+ *
* If this method is called from the selector thread, we will not allow the queuing to occur as the
* selector thread can manipulate its queues internally even if it is no longer open.
*
diff --git a/libs/nio/src/main/java/org/opensearch/nio/SocketChannelContext.java b/libs/nio/src/main/java/org/opensearch/nio/SocketChannelContext.java
index 12a1e80055823..3df8e42fe4f14 100644
--- a/libs/nio/src/main/java/org/opensearch/nio/SocketChannelContext.java
+++ b/libs/nio/src/main/java/org/opensearch/nio/SocketChannelContext.java
@@ -59,7 +59,7 @@
* that it is ready to perform certain operations (read, write, etc) the {@link SocketChannelContext} will
* be called. This context will need to implement all protocol related logic. Additionally, if any special
* close behavior is required, it should be implemented in this context.
- *
+ *
* The only methods of the context that should ever be called from a non-selector thread are
* {@link #closeChannel()} and {@link #sendMessage(Object, BiConsumer)}.
*/
diff --git a/libs/telemetry/src/main/java/org/opensearch/telemetry/tracing/Tracer.java b/libs/telemetry/src/main/java/org/opensearch/telemetry/tracing/Tracer.java
index 49295f417df9e..e6d4878a5e833 100644
--- a/libs/telemetry/src/main/java/org/opensearch/telemetry/tracing/Tracer.java
+++ b/libs/telemetry/src/main/java/org/opensearch/telemetry/tracing/Tracer.java
@@ -16,7 +16,7 @@
/**
* Tracer is the interface used to create a {@link Span}
* It automatically handles the context propagation between threads, tasks, nodes etc.
- *
+ *
* All methods on the Tracer object are multi-thread safe.
*
* @opensearch.experimental
diff --git a/libs/telemetry/src/main/java/org/opensearch/telemetry/tracing/http/HttpTracer.java b/libs/telemetry/src/main/java/org/opensearch/telemetry/tracing/http/HttpTracer.java
index b0692f1b62a48..50d18c0a0d040 100644
--- a/libs/telemetry/src/main/java/org/opensearch/telemetry/tracing/http/HttpTracer.java
+++ b/libs/telemetry/src/main/java/org/opensearch/telemetry/tracing/http/HttpTracer.java
@@ -18,7 +18,7 @@
/**
* HttpTracer helps in creating a {@link Span} which reads the incoming tracing information
* from the HttpRequest header and propagate the span accordingly.
- *
+ *
* All methods on the Tracer object are multi-thread safe.
*
* @opensearch.experimental
diff --git a/libs/x-content/src/test/java/org/opensearch/common/xcontent/XContentParserTests.java b/libs/x-content/src/test/java/org/opensearch/common/xcontent/XContentParserTests.java
index 3b857a2c690b9..d3d9ea174cf1b 100644
--- a/libs/x-content/src/test/java/org/opensearch/common/xcontent/XContentParserTests.java
+++ b/libs/x-content/src/test/java/org/opensearch/common/xcontent/XContentParserTests.java
@@ -628,7 +628,7 @@ public void testCreateRootSubParser() throws IOException {
/**
* Generates a random object {"first_field": "foo", "marked_field": {...random...}, "last_field": "bar}
- *
+ *
* Returns the number of tokens in the marked field
*/
private static int generateRandomObjectForMarking(XContentBuilder builder) throws IOException {
diff --git a/modules/aggs-matrix-stats/src/main/java/org/opensearch/search/aggregations/matrix/stats/RunningStats.java b/modules/aggs-matrix-stats/src/main/java/org/opensearch/search/aggregations/matrix/stats/RunningStats.java
index de67cc2930652..de6b59b1546a5 100644
--- a/modules/aggs-matrix-stats/src/main/java/org/opensearch/search/aggregations/matrix/stats/RunningStats.java
+++ b/modules/aggs-matrix-stats/src/main/java/org/opensearch/search/aggregations/matrix/stats/RunningStats.java
@@ -46,7 +46,7 @@
/**
* Descriptive stats gathered per shard. Coordinating node computes final correlation and covariance stats
* based on these descriptive stats. This single pass, parallel approach is based on:
- *
+ *
* http://prod.sandia.gov/techlib/access-control.cgi/2008/086212.pdf
*/
public class RunningStats implements Writeable, Cloneable {
@@ -222,7 +222,7 @@ private void updateCovariance(final String[] fieldNames, final Map
* running computations taken from: http://prod.sandia.gov/techlib/access-control.cgi/2008/086212.pdf
**/
public void merge(final RunningStats other) {
diff --git a/modules/analysis-common/src/main/java/org/opensearch/analysis/common/CommonAnalysisModulePlugin.java b/modules/analysis-common/src/main/java/org/opensearch/analysis/common/CommonAnalysisModulePlugin.java
index b0d9c1765190a..edb8c37c2dbdd 100644
--- a/modules/analysis-common/src/main/java/org/opensearch/analysis/common/CommonAnalysisModulePlugin.java
+++ b/modules/analysis-common/src/main/java/org/opensearch/analysis/common/CommonAnalysisModulePlugin.java
@@ -555,7 +555,7 @@ public List getPreConfiguredTokenFilters() {
filters.add(PreConfiguredTokenFilter.singleton("scandinavian_normalization", true, ScandinavianNormalizationFilter::new));
filters.add(PreConfiguredTokenFilter.singleton("shingle", false, false, input -> {
TokenStream ts = new ShingleFilter(input);
- /**
+ /*
* We disable the graph analysis on this token stream
* because it produces shingles of different size.
* Graph analysis on such token stream is useless and dangerous as it may create too many paths
diff --git a/modules/analysis-common/src/main/java/org/opensearch/analysis/common/KeywordMarkerTokenFilterFactory.java b/modules/analysis-common/src/main/java/org/opensearch/analysis/common/KeywordMarkerTokenFilterFactory.java
index ad968aeee62cb..e9f3fd96dd69d 100644
--- a/modules/analysis-common/src/main/java/org/opensearch/analysis/common/KeywordMarkerTokenFilterFactory.java
+++ b/modules/analysis-common/src/main/java/org/opensearch/analysis/common/KeywordMarkerTokenFilterFactory.java
@@ -49,12 +49,12 @@
* A factory for creating keyword marker token filters that prevent tokens from
* being modified by stemmers. Two types of keyword marker filters are available:
* the {@link SetKeywordMarkerFilter} and the {@link PatternKeywordMarkerFilter}.
- *
+ *
* The {@link SetKeywordMarkerFilter} uses a set of keywords to denote which tokens
* should be excluded from stemming. This filter is created if the settings include
* {@code keywords}, which contains the list of keywords, or {@code `keywords_path`},
* which contains a path to a file in the config directory with the keywords.
- *
+ *
* The {@link PatternKeywordMarkerFilter} uses a regular expression pattern to match
* against tokens that should be excluded from stemming. This filter is created if
* the settings include {@code keywords_pattern}, which contains the regular expression
diff --git a/modules/analysis-common/src/main/java/org/opensearch/analysis/common/SnowballAnalyzer.java b/modules/analysis-common/src/main/java/org/opensearch/analysis/common/SnowballAnalyzer.java
index 78d151ee16c3b..04786689b50f0 100644
--- a/modules/analysis-common/src/main/java/org/opensearch/analysis/common/SnowballAnalyzer.java
+++ b/modules/analysis-common/src/main/java/org/opensearch/analysis/common/SnowballAnalyzer.java
@@ -45,7 +45,7 @@
/** Filters {@link StandardTokenizer} with {@link
* LowerCaseFilter}, {@link StopFilter} and {@link SnowballFilter}.
- *
+ *
* Available stemmers are listed in org.tartarus.snowball.ext. The name of a
* stemmer is the part of the class name before "Stemmer", e.g., the stemmer in
* {@link org.tartarus.snowball.ext.EnglishStemmer} is named "English".
diff --git a/modules/geo/src/main/java/org/opensearch/geo/search/aggregations/bucket/composite/GeoTileValuesSource.java b/modules/geo/src/main/java/org/opensearch/geo/search/aggregations/bucket/composite/GeoTileValuesSource.java
index 9149b8939b739..665ea6c5f2f37 100644
--- a/modules/geo/src/main/java/org/opensearch/geo/search/aggregations/bucket/composite/GeoTileValuesSource.java
+++ b/modules/geo/src/main/java/org/opensearch/geo/search/aggregations/bucket/composite/GeoTileValuesSource.java
@@ -48,7 +48,7 @@
/**
* A {@link SingleDimensionValuesSource} for geotile values.
- *
+ *
* Since geotile values can be represented as long values, this class is almost the same as {@link LongValuesSource}
* The main differences is {@link GeoTileValuesSource#setAfter(Comparable)} as it needs to accept geotile string values i.e. "zoom/x/y".
*
diff --git a/modules/geo/src/main/java/org/opensearch/geo/search/aggregations/bucket/geogrid/cells/BoundedCellValues.java b/modules/geo/src/main/java/org/opensearch/geo/search/aggregations/bucket/geogrid/cells/BoundedCellValues.java
index 588c8bc59c2e0..6ff38fa28978e 100644
--- a/modules/geo/src/main/java/org/opensearch/geo/search/aggregations/bucket/geogrid/cells/BoundedCellValues.java
+++ b/modules/geo/src/main/java/org/opensearch/geo/search/aggregations/bucket/geogrid/cells/BoundedCellValues.java
@@ -37,7 +37,7 @@
/**
* Class representing {@link CellValues} whose values are filtered
* according to whether they are within the specified {@link GeoBoundingBox}.
- *
+ *
* The specified bounding box is assumed to be bounded.
*
* @opensearch.internal
diff --git a/modules/ingest-common/src/main/java/org/opensearch/ingest/common/FailProcessorException.java b/modules/ingest-common/src/main/java/org/opensearch/ingest/common/FailProcessorException.java
index 37320c0e900a5..7e114023fb86f 100644
--- a/modules/ingest-common/src/main/java/org/opensearch/ingest/common/FailProcessorException.java
+++ b/modules/ingest-common/src/main/java/org/opensearch/ingest/common/FailProcessorException.java
@@ -37,7 +37,7 @@
/**
* Exception class thrown by {@link FailProcessor}.
- *
+ *
* This exception is caught in the {@link CompoundProcessor} and
* then changes the state of {@link IngestDocument}. This
* exception should get serialized.
diff --git a/modules/ingest-common/src/main/java/org/opensearch/ingest/common/ForEachProcessor.java b/modules/ingest-common/src/main/java/org/opensearch/ingest/common/ForEachProcessor.java
index 741a4fb29cfb8..b7c417f5f44a5 100644
--- a/modules/ingest-common/src/main/java/org/opensearch/ingest/common/ForEachProcessor.java
+++ b/modules/ingest-common/src/main/java/org/opensearch/ingest/common/ForEachProcessor.java
@@ -53,10 +53,10 @@
/**
* A processor that for each value in a list executes a one or more processors.
- *
+ *
* This can be useful in cases to do string operations on json array of strings,
* or remove a field from objects inside a json array.
- *
+ *
* Note that this processor is experimental.
*/
public final class ForEachProcessor extends AbstractProcessor implements WrappingProcessor {
diff --git a/modules/lang-expression/src/main/java/org/opensearch/script/expression/ExpressionScriptEngine.java b/modules/lang-expression/src/main/java/org/opensearch/script/expression/ExpressionScriptEngine.java
index 035d2402857e0..11b2e20eea523 100644
--- a/modules/lang-expression/src/main/java/org/opensearch/script/expression/ExpressionScriptEngine.java
+++ b/modules/lang-expression/src/main/java/org/opensearch/script/expression/ExpressionScriptEngine.java
@@ -73,7 +73,7 @@
/**
* Provides the infrastructure for Lucene expressions as a scripting language for OpenSearch.
- *
+ *
* Only contexts returning numeric types or {@link Object} are supported.
*/
public class ExpressionScriptEngine implements ScriptEngine {
diff --git a/modules/lang-mustache/src/main/java/org/opensearch/script/mustache/MustacheScriptEngine.java b/modules/lang-mustache/src/main/java/org/opensearch/script/mustache/MustacheScriptEngine.java
index f4d7198dc2124..ec84475b70bb6 100644
--- a/modules/lang-mustache/src/main/java/org/opensearch/script/mustache/MustacheScriptEngine.java
+++ b/modules/lang-mustache/src/main/java/org/opensearch/script/mustache/MustacheScriptEngine.java
@@ -59,7 +59,7 @@
/**
* Main entry point handling template registration, compilation and
* execution.
- *
+ *
* Template handling is based on Mustache. Template handling is a two step
* process: First compile the string representing the template, the resulting
* {@link Mustache} object can then be re-used for subsequent executions.
diff --git a/modules/lang-mustache/src/test/java/org/opensearch/script/mustache/MustacheScriptEngineTests.java b/modules/lang-mustache/src/test/java/org/opensearch/script/mustache/MustacheScriptEngineTests.java
index 9e97863306148..fbb7d09709a91 100644
--- a/modules/lang-mustache/src/test/java/org/opensearch/script/mustache/MustacheScriptEngineTests.java
+++ b/modules/lang-mustache/src/test/java/org/opensearch/script/mustache/MustacheScriptEngineTests.java
@@ -200,7 +200,7 @@ private String getChars() {
/**
* From https://www.ietf.org/rfc/rfc4627.txt:
- *
+ *
* All Unicode characters may be placed within the
* quotation marks except for the characters that must be escaped:
* quotation mark, reverse solidus, and the control characters (U+0000
diff --git a/modules/lang-painless/spi/src/main/java/org/opensearch/painless/spi/Allowlist.java b/modules/lang-painless/spi/src/main/java/org/opensearch/painless/spi/Allowlist.java
index 56ade63efa5e2..265263b41ca89 100644
--- a/modules/lang-painless/spi/src/main/java/org/opensearch/painless/spi/Allowlist.java
+++ b/modules/lang-painless/spi/src/main/java/org/opensearch/painless/spi/Allowlist.java
@@ -42,7 +42,7 @@
* Allowlist contains data structures designed to be used to generate an allowlist of Java classes,
* constructors, methods, and fields that can be used within a Painless script at both compile-time
* and run-time.
- *
+ *
* A Allowlist consists of several pieces with {@link AllowlistClass}s as the top level. Each
* {@link AllowlistClass} will contain zero-to-many {@link AllowlistConstructor}s, {@link AllowlistMethod}s, and
* {@link AllowlistField}s which are what will be available with a Painless script. See each individual
diff --git a/modules/lang-painless/spi/src/main/java/org/opensearch/painless/spi/AllowlistClass.java b/modules/lang-painless/spi/src/main/java/org/opensearch/painless/spi/AllowlistClass.java
index 17e6814addf3b..67f5a07846c53 100644
--- a/modules/lang-painless/spi/src/main/java/org/opensearch/painless/spi/AllowlistClass.java
+++ b/modules/lang-painless/spi/src/main/java/org/opensearch/painless/spi/AllowlistClass.java
@@ -45,12 +45,12 @@
* classes. Though, since multiple allowlists may be combined into a single allowlist for a
* specific context, as long as multiple classes representing the same Java class have the same
* class name and have legal constructor/method overloading they can be merged together.
- *
+ *
* Classes in Painless allow for arity overloading for constructors and methods. Arity overloading
* means that multiple constructors are allowed for a single class as long as they have a different
* number of parameters, and multiples methods with the same name are allowed for a single class
* as long as they have the same return type and a different number of parameters.
- *
+ *
* Classes will automatically extend other allowlisted classes if the Java class they represent is a
* subclass of other classes including Java interfaces.
*/
diff --git a/modules/lang-painless/spi/src/main/java/org/opensearch/painless/spi/AllowlistLoader.java b/modules/lang-painless/spi/src/main/java/org/opensearch/painless/spi/AllowlistLoader.java
index 71265f82acacc..632fee9187eba 100644
--- a/modules/lang-painless/spi/src/main/java/org/opensearch/painless/spi/AllowlistLoader.java
+++ b/modules/lang-painless/spi/src/main/java/org/opensearch/painless/spi/AllowlistLoader.java
@@ -67,11 +67,11 @@ public static Allowlist loadFromResourceFiles(Class resource, String... filep
* is the path of a single text file. The {@link Class}'s {@link ClassLoader} will be used to lookup the Java
* reflection objects for each individual {@link Class}, {@link Constructor}, {@link Method}, and {@link Field}
* specified as part of the allowlist in the text file.
- *
+ *
* A single pass is made through each file to collect all the information about each class, constructor, method,
* and field. Most validation will be done at a later point after all allowlists have been gathered and their
* merging takes place.
- *
+ *
* A painless type name is one of the following:
*
* - def - The Painless dynamic type which is automatically included without a need to be
@@ -129,13 +129,13 @@ public static Allowlist loadFromResourceFiles(Class resource, String... filep
* be appropriately parsed and handled. Painless complex types must be specified with the
* fully-qualified Java class name. Method argument types, method return types, and field types
* must be specified with Painless type names (def, fully-qualified, or short) as described earlier.
- *
+ *
* The following example is used to create a single allowlist text file:
*
- * {@code
+ *
* # primitive types
*
- * class int -> int {
+ * class int -> int {
* }
*
* # complex types
@@ -161,7 +161,7 @@ public static Allowlist loadFromResourceFiles(Class resource, String... filep
* int value1
* def value2
* }
- * }
+ *
*/
public static Allowlist loadFromResourceFiles(Class resource, Map parsers, String... filepaths) {
List allowlistClasses = new ArrayList<>();
diff --git a/modules/lang-painless/spi/src/main/java/org/opensearch/painless/spi/AllowlistMethod.java b/modules/lang-painless/spi/src/main/java/org/opensearch/painless/spi/AllowlistMethod.java
index 8bb0231ff3f4f..9fcaec3dbf7b6 100644
--- a/modules/lang-painless/spi/src/main/java/org/opensearch/painless/spi/AllowlistMethod.java
+++ b/modules/lang-painless/spi/src/main/java/org/opensearch/painless/spi/AllowlistMethod.java
@@ -45,7 +45,7 @@
* are using the '.' operator on an existing class variable/field. Painless classes may have multiple
* methods with the same name as long as they comply with arity overloading described in
* {@link AllowlistClass}.
- *
+ *
* Classes may also have additional methods that are not part of the Java class the class represents -
* these are known as augmented methods. An augmented method can be added to a class as a part of any
* Java class as long as the method is static and the first parameter of the method is the Java class
diff --git a/modules/lang-painless/src/main/java/org/opensearch/painless/Compiler.java b/modules/lang-painless/src/main/java/org/opensearch/painless/Compiler.java
index 35c676653fdc3..c19d4f361b2b6 100644
--- a/modules/lang-painless/src/main/java/org/opensearch/painless/Compiler.java
+++ b/modules/lang-painless/src/main/java/org/opensearch/painless/Compiler.java
@@ -73,9 +73,7 @@ final class Compiler {
*/
private static final CodeSource CODESOURCE;
- /**
- * Setup the code privileges.
- */
+ /* Setup the code privileges. */
static {
try {
// Setup the code privileges.
diff --git a/modules/lang-painless/src/main/java/org/opensearch/painless/lookup/PainlessLookupUtility.java b/modules/lang-painless/src/main/java/org/opensearch/painless/lookup/PainlessLookupUtility.java
index cae425ad1fe3b..3164f5e6388c7 100644
--- a/modules/lang-painless/src/main/java/org/opensearch/painless/lookup/PainlessLookupUtility.java
+++ b/modules/lang-painless/src/main/java/org/opensearch/painless/lookup/PainlessLookupUtility.java
@@ -42,13 +42,13 @@
/**
* PainlessLookupUtility contains methods shared by {@link PainlessLookupBuilder}, {@link PainlessLookup}, and other classes within
* Painless for conversion between type names and types along with some other various utility methods.
- *
+ *
* The following terminology is used for variable names throughout the lookup package:
- *
+ *
* A class is a set of methods and fields under a specific class name. A type is either a class or an array under a specific type name.
* Note the distinction between class versus type is class means that no array classes will be be represented whereas type allows array
* classes to be represented. The set of available classes will always be a subset of the available types.
- *
+ *
* Under ambiguous circumstances most variable names are prefixed with asm, java, or painless. If the variable value is the same for asm,
* java, and painless, no prefix is used. Target is used as a prefix to represent if a constructor, method, or field is being
* called/accessed on that specific class. Parameter is often a postfix used to represent if a type is used as a parameter to a
diff --git a/modules/lang-painless/src/main/java/org/opensearch/painless/phase/PainlessSemanticAnalysisPhase.java b/modules/lang-painless/src/main/java/org/opensearch/painless/phase/PainlessSemanticAnalysisPhase.java
index 04165f44ba212..8a05d6742af97 100644
--- a/modules/lang-painless/src/main/java/org/opensearch/painless/phase/PainlessSemanticAnalysisPhase.java
+++ b/modules/lang-painless/src/main/java/org/opensearch/painless/phase/PainlessSemanticAnalysisPhase.java
@@ -126,9 +126,9 @@ public void visitFunction(SFunction userFunctionNode, ScriptScope scriptScope) {
/**
* Visits an expression that is also considered a statement.
- *
+ *
* If the statement is a return from the execute method, performs return value conversion.
- *
+ *
* Checks: control flow, type validation
*/
@Override
@@ -168,9 +168,9 @@ public void visitExpression(SExpression userExpressionNode, SemanticScope semant
/**
* Visits a return statement and casts the value to the return type if possible.
- *
+ *
* If the statement is a return from the execute method, performs return value conversion.
- *
+ *
* Checks: type validation
*/
@Override
diff --git a/modules/lang-painless/src/main/java/org/opensearch/painless/symbol/SemanticScope.java b/modules/lang-painless/src/main/java/org/opensearch/painless/symbol/SemanticScope.java
index e27530d745e8f..5ac802038afa6 100644
--- a/modules/lang-painless/src/main/java/org/opensearch/painless/symbol/SemanticScope.java
+++ b/modules/lang-painless/src/main/java/org/opensearch/painless/symbol/SemanticScope.java
@@ -49,7 +49,7 @@
* Tracks information within a scope required for compilation during the
* semantic phase in the user tree. There are three types of scopes -
* {@link FunctionScope}, {@link LambdaScope}, and {@link BlockScope}.
- *
+ *
* Scopes are stacked as they are created during the user tree's semantic
* phase with each scope beyond the top-level containing a reference to
* its parent. As a scope is no longer necessary, it's dropped automatically
diff --git a/modules/mapper-extras/src/main/java/org/opensearch/index/mapper/SearchAsYouTypeFieldMapper.java b/modules/mapper-extras/src/main/java/org/opensearch/index/mapper/SearchAsYouTypeFieldMapper.java
index 397a7b48b472a..366e848416328 100644
--- a/modules/mapper-extras/src/main/java/org/opensearch/index/mapper/SearchAsYouTypeFieldMapper.java
+++ b/modules/mapper-extras/src/main/java/org/opensearch/index/mapper/SearchAsYouTypeFieldMapper.java
@@ -82,7 +82,7 @@
/**
* Mapper for a text field that optimizes itself for as-you-type completion by indexing its content into subfields. Each subfield
* modifies the analysis chain of the root field to index terms the user would create as they type out the value in the root field
- *
+ *
* The structure of these fields is
*
*
diff --git a/modules/parent-join/src/main/java/org/opensearch/join/query/HasChildQueryBuilder.java b/modules/parent-join/src/main/java/org/opensearch/join/query/HasChildQueryBuilder.java
index 1a51259e9e4e4..e930780613ed6 100644
--- a/modules/parent-join/src/main/java/org/opensearch/join/query/HasChildQueryBuilder.java
+++ b/modules/parent-join/src/main/java/org/opensearch/join/query/HasChildQueryBuilder.java
@@ -373,7 +373,7 @@ protected Query doToQuery(QueryShardContext context) throws IOException {
* A query that rewrites into another query using
* {@link JoinUtil#createJoinQuery(String, Query, Query, IndexSearcher, ScoreMode, OrdinalMap, int, int)}
* that executes the actual join.
- *
+ *
* This query is exclusively used by the {@link HasChildQueryBuilder} and {@link HasParentQueryBuilder} to get access
* to the {@link DirectoryReader} used by the current search in order to retrieve the {@link OrdinalMap}.
* The {@link OrdinalMap} is required by {@link JoinUtil} to execute the join.
diff --git a/modules/rank-eval/src/main/java/org/opensearch/index/rankeval/TransportRankEvalAction.java b/modules/rank-eval/src/main/java/org/opensearch/index/rankeval/TransportRankEvalAction.java
index ffdea14e0873d..8e72c6ef06849 100644
--- a/modules/rank-eval/src/main/java/org/opensearch/index/rankeval/TransportRankEvalAction.java
+++ b/modules/rank-eval/src/main/java/org/opensearch/index/rankeval/TransportRankEvalAction.java
@@ -71,10 +71,10 @@
* supplied query parameters) against a set of possible search requests (read:
* search specifications, expressed as query/search request templates) and
* compares the result against a set of annotated documents per search intent.
- *
+ *
* If any documents are returned that haven't been annotated the document id of
* those is returned per search intent.
- *
+ *
* The resulting search quality is computed in terms of precision at n and
* returned for each search specification for the full set of search intents as
* averaged precision at n.
diff --git a/modules/rank-eval/src/test/java/org/opensearch/index/rankeval/DiscountedCumulativeGainTests.java b/modules/rank-eval/src/test/java/org/opensearch/index/rankeval/DiscountedCumulativeGainTests.java
index fcf1fa489f740..d96e3212e05a2 100644
--- a/modules/rank-eval/src/test/java/org/opensearch/index/rankeval/DiscountedCumulativeGainTests.java
+++ b/modules/rank-eval/src/test/java/org/opensearch/index/rankeval/DiscountedCumulativeGainTests.java
@@ -67,7 +67,7 @@ public class DiscountedCumulativeGainTests extends OpenSearchTestCase {
/**
* Assuming the docs are ranked in the following order:
- *
+ *
* rank | relevance | 2^(relevance) - 1 | log_2(rank + 1) | (2^(relevance) - 1) / log_2(rank + 1)
* -------------------------------------------------------------------------------------------
* 1 |Â 3 |Â 7.0 |Â 1.0 |Â 7.0 |Â 7.0 |Â
@@ -76,7 +76,7 @@ public class DiscountedCumulativeGainTests extends OpenSearchTestCase {
* 4 |Â 0 |Â 0.0 |Â 2.321928094887362 |Â 0.0
* 5 |Â 1 |Â 1.0 |Â 2.584962500721156 |Â 0.38685280723454163
* 6 |Â 2 |Â 3.0 |Â 2.807354922057604 |Â 1.0686215613240666
- *
+ *
* dcg = 13.84826362927298 (sum of last column)
*/
public void testDCGAt() {
@@ -91,20 +91,20 @@ public void testDCGAt() {
DiscountedCumulativeGain dcg = new DiscountedCumulativeGain();
assertEquals(EXPECTED_DCG, dcg.evaluate("id", hits, rated).metricScore(), DELTA);
- /**
- * Check with normalization: to get the maximal possible dcg, sort documents by
- * relevance in descending order
- *
- * rank | relevance | 2^(relevance) - 1 | log_2(rank + 1) | (2^(relevance) - 1) / log_2(rank + 1)
- * ---------------------------------------------------------------------------------------
- * 1 | 3 | 7.0 | 1.0Â |Â 7.0
- * 2 | 3 | 7.0 | 1.5849625007211563Â |Â 4.416508275000202
- * 3 | 2 | 3.0 | 2.0Â |Â 1.5
- * 4 | 2 | 3.0 | 2.321928094887362Â |Â 1.2920296742201793
- * 5 | 1 | 1.0 | 2.584962500721156Â |Â 0.38685280723454163
- * 6 | 0 | 0.0 | 2.807354922057604Â |Â 0.0
- *
- * idcg = 14.595390756454922 (sum of last column)
+ /*
+ Check with normalization: to get the maximal possible dcg, sort documents by
+ relevance in descending order
+
+ rank | relevance | 2^(relevance) - 1 | log_2(rank + 1) | (2^(relevance) - 1) / log_2(rank + 1)
+ ---------------------------------------------------------------------------------------
+ 1 | 3 | 7.0 | 1.0Â |Â 7.0
+ 2 | 3 | 7.0 | 1.5849625007211563Â |Â 4.416508275000202
+ 3 | 2 | 3.0 | 2.0Â |Â 1.5
+ 4 | 2 | 3.0 | 2.321928094887362Â |Â 1.2920296742201793
+ 5 | 1 | 1.0 | 2.584962500721156Â |Â 0.38685280723454163
+ 6 | 0 | 0.0 | 2.807354922057604Â |Â 0.0
+
+ idcg = 14.595390756454922 (sum of last column)
*/
dcg = new DiscountedCumulativeGain(true, null, 10);
assertEquals(EXPECTED_NDCG, dcg.evaluate("id", hits, rated).metricScore(), DELTA);
@@ -113,7 +113,7 @@ public void testDCGAt() {
/**
* This tests metric when some documents in the search result don't have a
* rating provided by the user.
- *
+ *
* rank | relevance | 2^(relevance) - 1 | log_2(rank + 1) | (2^(relevance) - 1) / log_2(rank + 1)
* -------------------------------------------------------------------------------------------
* 1 |Â 3 |Â 7.0 |Â 1.0 |Â 7.0 2 |Â
@@ -122,7 +122,7 @@ public void testDCGAt() {
* 4 |Â n/a |Â n/a |Â n/a | n/a
* 5 |Â 1 |Â 1.0 |Â 2.584962500721156 |Â 0.38685280723454163
* 6 |Â n/a |Â n/a |Â n/a | n/a
- *
+ *
* dcg = 12.779642067948913 (sum of last column)
*/
public void testDCGAtSixMissingRatings() {
@@ -143,20 +143,20 @@ public void testDCGAtSixMissingRatings() {
assertEquals(12.779642067948913, result.metricScore(), DELTA);
assertEquals(2, filterUnratedDocuments(result.getHitsAndRatings()).size());
- /**
- * Check with normalization: to get the maximal possible dcg, sort documents by
- * relevance in descending order
- *
- * rank | relevance | 2^(relevance) - 1 | log_2(rank + 1) | (2^(relevance) - 1) / log_2(rank + 1)
- * ----------------------------------------------------------------------------------------
- * 1 | 3 | 7.0 | 1.0Â |Â 7.0
- * 2 | 3 | 7.0 | 1.5849625007211563Â |Â 4.416508275000202
- * 3 | 2 | 3.0 | 2.0Â |Â 1.5
- * 4 | 1 | 1.0 | 2.321928094887362Â Â |Â 0.43067655807339
- * 5 | n.a | n.a | n.a. | n.a.
- * 6 | n.a | n.a | n.a | n.a
- *
- * idcg = 13.347184833073591 (sum of last column)
+ /*
+ Check with normalization: to get the maximal possible dcg, sort documents by
+ relevance in descending order
+
+ rank | relevance | 2^(relevance) - 1 | log_2(rank + 1) | (2^(relevance) - 1) / log_2(rank + 1)
+ ----------------------------------------------------------------------------------------
+ 1 | 3 | 7.0 | 1.0Â |Â 7.0
+ 2 | 3 | 7.0 | 1.5849625007211563Â |Â 4.416508275000202
+ 3 | 2 | 3.0 | 2.0Â |Â 1.5
+ 4 | 1 | 1.0 | 2.321928094887362Â Â |Â 0.43067655807339
+ 5 | n.a | n.a | n.a. | n.a.
+ 6 | n.a | n.a | n.a | n.a
+
+ idcg = 13.347184833073591 (sum of last column)
*/
dcg = new DiscountedCumulativeGain(true, null, 10);
assertEquals(12.779642067948913 / 13.347184833073591, dcg.evaluate("id", hits, rated).metricScore(), DELTA);
@@ -166,7 +166,7 @@ public void testDCGAtSixMissingRatings() {
* This tests that normalization works as expected when there are more rated
* documents than search hits because we restrict DCG to be calculated at the
* fourth position
- *
+ *
* rank | relevance | 2^(relevance) - 1 | log_2(rank + 1) | (2^(relevance) - 1) / log_2(rank + 1)
* -------------------------------------------------------------------------------------------
* 1 |Â 3 |Â 7.0 |Â 1.0 |Â 7.0 2 |Â
@@ -176,7 +176,7 @@ public void testDCGAtSixMissingRatings() {
* -----------------------------------------------------------------
* 5 |Â 1 |Â 1.0 |Â 2.584962500721156 |Â 0.38685280723454163
* 6 |Â n/a |Â n/a |Â n/a | n/a
- *
+ *
* dcg = 12.392789260714371 (sum of last column until position 4)
*/
public void testDCGAtFourMoreRatings() {
@@ -200,21 +200,21 @@ public void testDCGAtFourMoreRatings() {
assertEquals(12.392789260714371, result.metricScore(), DELTA);
assertEquals(1, filterUnratedDocuments(result.getHitsAndRatings()).size());
- /**
- * Check with normalization: to get the maximal possible dcg, sort documents by
- * relevance in descending order
- *
- * rank | relevance | 2^(relevance) - 1 | log_2(rank + 1) | (2^(relevance) - 1) / log_2(rank + 1)
- * ---------------------------------------------------------------------------------------
- * 1 | 3 | 7.0 | 1.0Â |Â 7.0
- * 2 | 3 | 7.0 | 1.5849625007211563Â |Â 4.416508275000202
- * 3 | 2 | 3.0 | 2.0Â |Â 1.5
- * 4 | 1 | 1.0 | 2.321928094887362Â Â |Â 0.43067655807339
- * ---------------------------------------------------------------------------------------
- * 5 | n.a | n.a | n.a. | n.a.
- * 6 | n.a | n.a | n.a | n.a
- *
- * idcg = 13.347184833073591 (sum of last column)
+ /*
+ Check with normalization: to get the maximal possible dcg, sort documents by
+ relevance in descending order
+
+ rank | relevance | 2^(relevance) - 1 | log_2(rank + 1) | (2^(relevance) - 1) / log_2(rank + 1)
+ ---------------------------------------------------------------------------------------
+ 1 | 3 | 7.0 | 1.0Â |Â 7.0
+ 2 | 3 | 7.0 | 1.5849625007211563Â |Â 4.416508275000202
+ 3 | 2 | 3.0 | 2.0Â |Â 1.5
+ 4 | 1 | 1.0 | 2.321928094887362Â Â |Â 0.43067655807339
+ ---------------------------------------------------------------------------------------
+ 5 | n.a | n.a | n.a. | n.a.
+ 6 | n.a | n.a | n.a | n.a
+
+ idcg = 13.347184833073591 (sum of last column)
*/
dcg = new DiscountedCumulativeGain(true, null, 10);
assertEquals(12.392789260714371 / 13.347184833073591, dcg.evaluate("id", hits, ratedDocs).metricScore(), DELTA);
diff --git a/modules/reindex/src/main/java/org/opensearch/index/reindex/AbstractAsyncBulkByScrollAction.java b/modules/reindex/src/main/java/org/opensearch/index/reindex/AbstractAsyncBulkByScrollAction.java
index e2442e1f483f0..6ed486fbdb33b 100644
--- a/modules/reindex/src/main/java/org/opensearch/index/reindex/AbstractAsyncBulkByScrollAction.java
+++ b/modules/reindex/src/main/java/org/opensearch/index/reindex/AbstractAsyncBulkByScrollAction.java
@@ -206,7 +206,7 @@ public abstract class AbstractAsyncBulkByScrollAction<
/**
* Build the {@link BiFunction} to apply to all {@link RequestWrapper}.
- *
+ *
* Public for testings....
*/
public BiFunction, ScrollableHitSource.Hit, RequestWrapper> buildScriptApplier() {
diff --git a/modules/reindex/src/main/java/org/opensearch/index/reindex/BulkByScrollParallelizationHelper.java b/modules/reindex/src/main/java/org/opensearch/index/reindex/BulkByScrollParallelizationHelper.java
index d5a6e392f2019..7534de1408bcc 100644
--- a/modules/reindex/src/main/java/org/opensearch/index/reindex/BulkByScrollParallelizationHelper.java
+++ b/modules/reindex/src/main/java/org/opensearch/index/reindex/BulkByScrollParallelizationHelper.java
@@ -63,14 +63,14 @@ private BulkByScrollParallelizationHelper() {}
/**
* Takes an action created by a {@link BulkByScrollTask} and runs it with regard to whether the request is sliced or not.
- *
+ *
* If the request is not sliced (i.e. the number of slices is 1), the worker action in the given {@link Runnable} will be started on
* the local node. If the request is sliced (i.e. the number of slices is more than 1), then a subrequest will be created for each
* slice and sent.
- *
+ *
* If slices are set as {@code "auto"}, this class will resolve that to a specific number based on characteristics of the source
* indices. A request with {@code "auto"} slices may end up being sliced or unsliced.
- *
+ *
* This method is equivalent to calling {@link #initTaskState} followed by {@link #executeSlicedAction}
*/
static > void startSlicedAction(
@@ -98,11 +98,11 @@ public void onFailure(Exception e) {
/**
* Takes an action and a {@link BulkByScrollTask} and runs it with regard to whether this task is a
* leader or worker.
- *
+ *
* If this task is a worker, the worker action in the given {@link Runnable} will be started on the local
* node. If the task is a leader (i.e. the number of slices is more than 1), then a subrequest will be
* created for each slice and sent.
- *
+ *
* This method can only be called after the task state is initialized {@link #initTaskState}.
*/
static > void executeSlicedAction(
@@ -125,7 +125,7 @@ static > void executeSliced
/**
* Takes a {@link BulkByScrollTask} and ensures that its initial task state (leader or worker) is set.
- *
+ *
* If slices are set as {@code "auto"}, this method will resolve that to a specific number based on
* characteristics of the source indices. A request with {@code "auto"} slices may end up being sliced or
* unsliced. This method does not execute the action. In order to execute the action see
diff --git a/modules/transport-netty4/src/internalClusterTest/java/org/opensearch/http/netty4/Netty4HttpRequestSizeLimitIT.java b/modules/transport-netty4/src/internalClusterTest/java/org/opensearch/http/netty4/Netty4HttpRequestSizeLimitIT.java
index 6c8ca665424a6..826d4a7e5d61e 100644
--- a/modules/transport-netty4/src/internalClusterTest/java/org/opensearch/http/netty4/Netty4HttpRequestSizeLimitIT.java
+++ b/modules/transport-netty4/src/internalClusterTest/java/org/opensearch/http/netty4/Netty4HttpRequestSizeLimitIT.java
@@ -57,7 +57,7 @@
/**
* This test checks that in-flight requests are limited on HTTP level and that requests that are excluded from limiting can pass.
- *
+ *
* As the same setting is also used to limit in-flight requests on transport level, we avoid transport messages by forcing
* a single node "cluster".
*/
diff --git a/modules/transport-netty4/src/main/java/org/opensearch/http/netty4/Netty4HttpRequest.java b/modules/transport-netty4/src/main/java/org/opensearch/http/netty4/Netty4HttpRequest.java
index 7d937157c1034..3c96affb7adf7 100644
--- a/modules/transport-netty4/src/main/java/org/opensearch/http/netty4/Netty4HttpRequest.java
+++ b/modules/transport-netty4/src/main/java/org/opensearch/http/netty4/Netty4HttpRequest.java
@@ -258,7 +258,7 @@ public FullHttpRequest nettyRequest() {
/**
* A wrapper of {@link HttpHeaders} that implements a map to prevent copying unnecessarily. This class does not support modifications
* and due to the underlying implementation, it performs case insensitive lookups of key to values.
- *
+ *
* It is important to note that this implementation does have some downsides in that each invocation of the
* {@link #values()} and {@link #entrySet()} methods will perform a copy of the values in the HttpHeaders rather than returning a
* view of the underlying values.
diff --git a/modules/transport-netty4/src/main/java/org/opensearch/transport/CopyBytesSocketChannel.java b/modules/transport-netty4/src/main/java/org/opensearch/transport/CopyBytesSocketChannel.java
index b73f74d187a2a..4bab91565d3ad 100644
--- a/modules/transport-netty4/src/main/java/org/opensearch/transport/CopyBytesSocketChannel.java
+++ b/modules/transport-netty4/src/main/java/org/opensearch/transport/CopyBytesSocketChannel.java
@@ -65,7 +65,7 @@
* This class is adapted from {@link NioSocketChannel} class in the Netty project. It overrides the channel
* read/write behavior to ensure that the bytes are always copied to a thread-local direct bytes buffer. This
* happens BEFORE the call to the Java {@link SocketChannel} is issued.
- *
+ *
* The purpose of this class is to allow the disabling of netty direct buffer pooling while allowing us to
* control how bytes end up being copied to direct memory. If we simply disabled netty pooling, we would rely
* on the JDK's internal thread local buffer pooling. Instead, this class allows us to create a one thread
diff --git a/plugins/analysis-phonetic/src/main/java/org/opensearch/index/analysis/phonetic/HaasePhonetik.java b/plugins/analysis-phonetic/src/main/java/org/opensearch/index/analysis/phonetic/HaasePhonetik.java
index c80d32228feeb..b875fab7d4006 100644
--- a/plugins/analysis-phonetic/src/main/java/org/opensearch/index/analysis/phonetic/HaasePhonetik.java
+++ b/plugins/analysis-phonetic/src/main/java/org/opensearch/index/analysis/phonetic/HaasePhonetik.java
@@ -35,13 +35,13 @@
/**
* Geänderter Algorithmus aus der Matching Toolbox von Rainer Schnell
* Java-Programmierung von Jörg Reiher
- *
+ *
* Die Kölner Phonetik wurde für den Einsatz in Namensdatenbanken wie
* der Verwaltung eines Krankenhauses durch Martin Haase (Institut für
* Sprachwissenschaft, Universität zu Köln) und Kai Heitmann (Insitut für
* medizinische Statistik, Informatik und Epidemiologie, Köln) überarbeitet.
* M. Haase und K. Heitmann. Die Erweiterte Kölner Phonetik. 526, 2000.
- *
+ *
* nach: Martin Wilz, Aspekte der Kodierung phonetischer Ähnlichkeiten
* in deutschen Eigennamen, Magisterarbeit.
* http://www.uni-koeln.de/phil-fak/phonetik/Lehre/MA-Arbeiten/magister_wilz.pdf
diff --git a/plugins/analysis-phonetic/src/main/java/org/opensearch/index/analysis/phonetic/KoelnerPhonetik.java b/plugins/analysis-phonetic/src/main/java/org/opensearch/index/analysis/phonetic/KoelnerPhonetik.java
index 33e386af9f364..4bcc10ff73b0a 100644
--- a/plugins/analysis-phonetic/src/main/java/org/opensearch/index/analysis/phonetic/KoelnerPhonetik.java
+++ b/plugins/analysis-phonetic/src/main/java/org/opensearch/index/analysis/phonetic/KoelnerPhonetik.java
@@ -46,13 +46,13 @@
/**
* Kölner Phonetik
- *
+ *
* H.J. Postel, Die Kölner Phonetik. Ein Verfahren zu Identifizierung
* von Personennamen auf der Grundlage der Gestaltanalyse. IBM-Nachrichten 19 (1969), 925-931
- *
+ *
* Algorithmus aus der Matching Toolbox von Rainer Schnell
* Java-Programmierung von Jörg Reiher
- *
+ *
* mit Änderungen von Jörg Prante
*
*/
diff --git a/plugins/analysis-phonetic/src/main/java/org/opensearch/index/analysis/phonetic/Nysiis.java b/plugins/analysis-phonetic/src/main/java/org/opensearch/index/analysis/phonetic/Nysiis.java
index 818dbba85e2de..c3237114c65d5 100644
--- a/plugins/analysis-phonetic/src/main/java/org/opensearch/index/analysis/phonetic/Nysiis.java
+++ b/plugins/analysis-phonetic/src/main/java/org/opensearch/index/analysis/phonetic/Nysiis.java
@@ -40,7 +40,7 @@
/**
*
* Taken from commons-codec trunk (unreleased yet)
- *
+ *
* Encodes a string into a NYSIIS value. NYSIIS is an encoding used to relate
* similar names, but can also be used as a general purpose scheme to find word
* with similar phonemes.
diff --git a/plugins/discovery-gce/src/test/java/org/opensearch/discovery/gce/GceDiscoveryTests.java b/plugins/discovery-gce/src/test/java/org/opensearch/discovery/gce/GceDiscoveryTests.java
index b4af9773f33de..2208c78bef67a 100644
--- a/plugins/discovery-gce/src/test/java/org/opensearch/discovery/gce/GceDiscoveryTests.java
+++ b/plugins/discovery-gce/src/test/java/org/opensearch/discovery/gce/GceDiscoveryTests.java
@@ -66,7 +66,6 @@
* compute/v1/projects/[project-id]/zones/[zone]
*
* By default, project-id is the test method name, lowercase and missing the "test" prefix.
- *
* For example, if you create a test `myNewAwesomeTest` with following settings:
*
* Settings nodeSettings = Settings.builder()
@@ -75,7 +74,6 @@
* .build();
*
* You need to create a file under `src/test/resources/org/opensearch/discovery/gce/` named:
- *
* compute/v1/projects/mynewawesometest/zones/europe-west1-b/instances.json
*
*/
diff --git a/plugins/events-correlation-engine/src/main/java/org/opensearch/plugin/correlation/core/index/codec/BasePerFieldCorrelationVectorsFormat.java b/plugins/events-correlation-engine/src/main/java/org/opensearch/plugin/correlation/core/index/codec/BasePerFieldCorrelationVectorsFormat.java
index 7763b1e42d63e..00b55eb75995c 100644
--- a/plugins/events-correlation-engine/src/main/java/org/opensearch/plugin/correlation/core/index/codec/BasePerFieldCorrelationVectorsFormat.java
+++ b/plugins/events-correlation-engine/src/main/java/org/opensearch/plugin/correlation/core/index/codec/BasePerFieldCorrelationVectorsFormat.java
@@ -27,12 +27,12 @@
public abstract class BasePerFieldCorrelationVectorsFormat extends PerFieldKnnVectorsFormat {
/**
* the hyper-parameters for constructing HNSW graphs.
- * https://lucene.apache.org/core/9_4_0/core/org/apache/lucene/util/hnsw/HnswGraph.html
+ * HnswGraph.html
*/
public static final String METHOD_PARAMETER_M = "m";
/**
* the hyper-parameters for constructing HNSW graphs.
- * https://lucene.apache.org/core/9_4_0/core/org/apache/lucene/util/hnsw/HnswGraph.html
+ * HnswGraph.html
*/
public static final String METHOD_PARAMETER_EF_CONSTRUCTION = "ef_construction";
diff --git a/plugins/events-correlation-engine/src/test/java/org/opensearch/plugin/correlation/core/index/query/CorrelationQueryBuilderTests.java b/plugins/events-correlation-engine/src/test/java/org/opensearch/plugin/correlation/core/index/query/CorrelationQueryBuilderTests.java
index 134c6519d7220..3e567d0c04e53 100644
--- a/plugins/events-correlation-engine/src/test/java/org/opensearch/plugin/correlation/core/index/query/CorrelationQueryBuilderTests.java
+++ b/plugins/events-correlation-engine/src/test/java/org/opensearch/plugin/correlation/core/index/query/CorrelationQueryBuilderTests.java
@@ -203,6 +203,7 @@ public void testDoToQueryInvalidFieldType() {
/**
* test serialization of Correlation Query Builder
+ * @throws Exception throws an IOException if serialization fails
* @throws Exception Exception
*/
public void testSerialization() throws Exception {
diff --git a/plugins/examples/custom-suggester/src/main/java/org/opensearch/example/customsuggester/CustomSuggestion.java b/plugins/examples/custom-suggester/src/main/java/org/opensearch/example/customsuggester/CustomSuggestion.java
index 9255d3a2f299e..c8e9d8cfc0a12 100644
--- a/plugins/examples/custom-suggester/src/main/java/org/opensearch/example/customsuggester/CustomSuggestion.java
+++ b/plugins/examples/custom-suggester/src/main/java/org/opensearch/example/customsuggester/CustomSuggestion.java
@@ -53,7 +53,6 @@ public class CustomSuggestion extends Suggest.Suggestion
/**
* An integer representing the type of the suggestion formerly used for internal serialization over the network.
- *
* This class is now serialized as a NamedWriteable and this value only remains for backwards compatibility
*/
public static final int TYPE = 999;
@@ -106,7 +105,7 @@ public int getWriteableType() {
/**
* A meaningless value used to test that plugin suggesters can add fields to their Suggestion types
- *
+ *
* This can't be serialized to xcontent because Suggestions appear in xcontent as an array of entries, so there is no place
* to add a custom field. But we can still use a custom field internally and use it to define a Suggestion's behavior
*
diff --git a/plugins/examples/painless-allowlist/src/main/java/org/opensearch/example/painlessallowlist/ExampleAllowlistedClass.java b/plugins/examples/painless-allowlist/src/main/java/org/opensearch/example/painlessallowlist/ExampleAllowlistedClass.java
index ca58d97377478..ee04741eb5a03 100644
--- a/plugins/examples/painless-allowlist/src/main/java/org/opensearch/example/painlessallowlist/ExampleAllowlistedClass.java
+++ b/plugins/examples/painless-allowlist/src/main/java/org/opensearch/example/painlessallowlist/ExampleAllowlistedClass.java
@@ -34,7 +34,7 @@
/**
* An example of a class to be allowlisted for use by painless scripts
- *
+ *
* Each of the members and methods below are allowlisted for use in search scripts.
* See example_allowlist.txt.
*/
diff --git a/plugins/examples/painless-allowlist/src/main/java/org/opensearch/example/painlessallowlist/ExampleAllowlistedInstance.java b/plugins/examples/painless-allowlist/src/main/java/org/opensearch/example/painlessallowlist/ExampleAllowlistedInstance.java
index 0833f1f0c6659..35385e98187ea 100644
--- a/plugins/examples/painless-allowlist/src/main/java/org/opensearch/example/painlessallowlist/ExampleAllowlistedInstance.java
+++ b/plugins/examples/painless-allowlist/src/main/java/org/opensearch/example/painlessallowlist/ExampleAllowlistedInstance.java
@@ -34,7 +34,7 @@
/**
* An example of an instance to be allowlisted for use by painless scripts.
- *
+ *
* Each of the members and methods below are allowlisted for use in search scripts but only from this instance.
*/
public class ExampleAllowlistedInstance {
diff --git a/plugins/examples/painless-allowlist/src/main/java/org/opensearch/example/painlessallowlist/ExamplePainlessAnnotation.java b/plugins/examples/painless-allowlist/src/main/java/org/opensearch/example/painlessallowlist/ExamplePainlessAnnotation.java
index 428a0cc688ad3..ac42c2b1cf9bc 100644
--- a/plugins/examples/painless-allowlist/src/main/java/org/opensearch/example/painlessallowlist/ExamplePainlessAnnotation.java
+++ b/plugins/examples/painless-allowlist/src/main/java/org/opensearch/example/painlessallowlist/ExamplePainlessAnnotation.java
@@ -34,7 +34,7 @@
/**
* An example of an annotation to be allowlisted for use by painless scripts
- *
+ *
* The annotation below is allowlisted for use in search scripts.
* See example_allowlist.txt.
*/
diff --git a/plugins/examples/painless-allowlist/src/main/java/org/opensearch/example/painlessallowlist/ExampleStaticMethodClass.java b/plugins/examples/painless-allowlist/src/main/java/org/opensearch/example/painlessallowlist/ExampleStaticMethodClass.java
index 25443977a0f66..2f6d1ad9349bc 100644
--- a/plugins/examples/painless-allowlist/src/main/java/org/opensearch/example/painlessallowlist/ExampleStaticMethodClass.java
+++ b/plugins/examples/painless-allowlist/src/main/java/org/opensearch/example/painlessallowlist/ExampleStaticMethodClass.java
@@ -34,7 +34,7 @@
/**
* An example of a class with static methods to be allowlisted for use by painless scripts
- *
+ *
* The method below is allowlisted for use in search scripts.
* See example_allowlist.txt.
*/
diff --git a/plugins/mapper-annotated-text/src/main/java/org/opensearch/index/mapper/annotatedtext/AnnotatedTextFieldMapper.java b/plugins/mapper-annotated-text/src/main/java/org/opensearch/index/mapper/annotatedtext/AnnotatedTextFieldMapper.java
index 935887261dcc9..952cff96860f2 100644
--- a/plugins/mapper-annotated-text/src/main/java/org/opensearch/index/mapper/annotatedtext/AnnotatedTextFieldMapper.java
+++ b/plugins/mapper-annotated-text/src/main/java/org/opensearch/index/mapper/annotatedtext/AnnotatedTextFieldMapper.java
@@ -73,9 +73,9 @@
import java.util.regex.Pattern;
/** A {@link FieldMapper} for full-text fields with annotation markup e.g.
- *
+ *
* "New mayor is [John Smith](type=person&value=John%20Smith) "
- *
+ *
* A special Analyzer wraps the default choice of analyzer in order
* to strip the text field of annotation markup and inject the related
* entity annotation tokens as supplementary tokens at the relevant points
diff --git a/plugins/repository-azure/src/internalClusterTest/java/org/opensearch/repositories/azure/AzureBlobStoreRepositoryTests.java b/plugins/repository-azure/src/internalClusterTest/java/org/opensearch/repositories/azure/AzureBlobStoreRepositoryTests.java
index 82364d1b7b3c1..986720ec431fe 100644
--- a/plugins/repository-azure/src/internalClusterTest/java/org/opensearch/repositories/azure/AzureBlobStoreRepositoryTests.java
+++ b/plugins/repository-azure/src/internalClusterTest/java/org/opensearch/repositories/azure/AzureBlobStoreRepositoryTests.java
@@ -154,7 +154,7 @@ private static class AzureBlobStoreHttpHandler extends AzureHttpHandler implemen
/**
* HTTP handler that injects random Azure service errors
- *
+ *
* Note: it is not a good idea to allow this handler to simulate too many errors as it would
* slow down the test suite.
*/
diff --git a/plugins/repository-azure/src/main/java/org/opensearch/repositories/azure/AzureStorageService.java b/plugins/repository-azure/src/main/java/org/opensearch/repositories/azure/AzureStorageService.java
index 9dcc312f8f5a7..b60701ba5e533 100644
--- a/plugins/repository-azure/src/main/java/org/opensearch/repositories/azure/AzureStorageService.java
+++ b/plugins/repository-azure/src/main/java/org/opensearch/repositories/azure/AzureStorageService.java
@@ -212,8 +212,8 @@ protected PasswordAuthentication getPasswordAuthentication() {
/**
* The location mode is not there in v12 APIs anymore but it is possible to mimic its semantics using
- * retry options and combination of primary / secondary endpoints. Refer to migration guide for mode details:
- * https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/storage/azure-storage-blob/migrationGuides/V8_V12.md#miscellaneous
+ * retry options and combination of primary / secondary endpoints. Refer to
+ * migration guide for mode details:
*/
private BlobServiceClientBuilder applyLocationMode(final BlobServiceClientBuilder builder, final AzureStorageSettings settings) {
final StorageConnectionString storageConnectionString = StorageConnectionString.create(settings.getConnectString(), logger);
@@ -335,8 +335,8 @@ private void closeInternally(ClientState state) {
}
/**
- * Implements HTTP pipeline policy to collect statistics on API calls. See please:
- * https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/storage/azure-storage-blob/migrationGuides/V8_V12.md#miscellaneous
+ * Implements HTTP pipeline policy to collect statistics on API calls. See :
+ * migration guide
*/
private static class HttpStatsPolicy implements HttpPipelinePolicy {
private final BiConsumer statsCollector;
diff --git a/plugins/repository-azure/src/test/java/org/opensearch/repositories/azure/AzureStorageServiceTests.java b/plugins/repository-azure/src/test/java/org/opensearch/repositories/azure/AzureStorageServiceTests.java
index 264888bb7da3a..bb0eafc7d1d4a 100644
--- a/plugins/repository-azure/src/test/java/org/opensearch/repositories/azure/AzureStorageServiceTests.java
+++ b/plugins/repository-azure/src/test/java/org/opensearch/repositories/azure/AzureStorageServiceTests.java
@@ -451,7 +451,8 @@ private static RequestRetryPolicy requestRetryOptions(BlobServiceClient client)
}
/**
- * Extract the blob name from a URI like https://myservice.azure.net/container/path/to/myfile
+ * Extract the blob name from a URI like :
+ * {@code https://myservice.azure.net/container/path/to/myfile }
* It should remove the container part (first part of the path) and gives path/to/myfile
* @param uri URI to parse
* @return The blob name relative to the container
diff --git a/plugins/repository-gcs/src/internalClusterTest/java/org/opensearch/repositories/gcs/GoogleCloudStorageBlobStoreRepositoryTests.java b/plugins/repository-gcs/src/internalClusterTest/java/org/opensearch/repositories/gcs/GoogleCloudStorageBlobStoreRepositoryTests.java
index f8e1a1cc39ae0..d223f7989c688 100644
--- a/plugins/repository-gcs/src/internalClusterTest/java/org/opensearch/repositories/gcs/GoogleCloudStorageBlobStoreRepositoryTests.java
+++ b/plugins/repository-gcs/src/internalClusterTest/java/org/opensearch/repositories/gcs/GoogleCloudStorageBlobStoreRepositoryTests.java
@@ -298,7 +298,7 @@ private static class GoogleCloudStorageBlobStoreHttpHandler extends GoogleCloudS
/**
* HTTP handler that injects random Google Cloud Storage service errors
- *
+ *
* Note: it is not a good idea to allow this handler to simulate too many errors as it would
* slow down the test suite.
*/
diff --git a/plugins/repository-hdfs/src/main/java/org/opensearch/repositories/hdfs/HdfsSecurityContext.java b/plugins/repository-hdfs/src/main/java/org/opensearch/repositories/hdfs/HdfsSecurityContext.java
index 068adc2cc9991..07d1d29eecfc4 100644
--- a/plugins/repository-hdfs/src/main/java/org/opensearch/repositories/hdfs/HdfsSecurityContext.java
+++ b/plugins/repository-hdfs/src/main/java/org/opensearch/repositories/hdfs/HdfsSecurityContext.java
@@ -53,7 +53,7 @@
/**
* Oversees all the security specific logic for the HDFS Repository plugin.
- *
+ *
* Keeps track of the current user for a given repository, as well as which
* permissions to grant the blob store restricted execution methods.
*/
diff --git a/plugins/repository-hdfs/src/test/java/org/opensearch/repositories/hdfs/HdfsClientThreadLeakFilter.java b/plugins/repository-hdfs/src/test/java/org/opensearch/repositories/hdfs/HdfsClientThreadLeakFilter.java
index 2758bd020e979..856cdf1eb565e 100644
--- a/plugins/repository-hdfs/src/test/java/org/opensearch/repositories/hdfs/HdfsClientThreadLeakFilter.java
+++ b/plugins/repository-hdfs/src/test/java/org/opensearch/repositories/hdfs/HdfsClientThreadLeakFilter.java
@@ -42,7 +42,7 @@
* thread leaks out of the client and is picked up by the test framework. This thread filter is meant
* to ignore the offending thread until a version of Hadoop is released that addresses the incorrect
* interrupt handling.
- *
+ *
* In Hadoop 3.3.6, the org.apache.hadoop.fs.statistics.impl.EvaluatingStatisticsMap uses ForkJoinPool
* to perform statistics calculation, leaving dangling workers.
*
diff --git a/plugins/repository-s3/src/internalClusterTest/java/org/opensearch/repositories/s3/S3BlobStoreRepositoryTests.java b/plugins/repository-s3/src/internalClusterTest/java/org/opensearch/repositories/s3/S3BlobStoreRepositoryTests.java
index 4e8e7720572e8..5f88ad7867513 100644
--- a/plugins/repository-s3/src/internalClusterTest/java/org/opensearch/repositories/s3/S3BlobStoreRepositoryTests.java
+++ b/plugins/repository-s3/src/internalClusterTest/java/org/opensearch/repositories/s3/S3BlobStoreRepositoryTests.java
@@ -225,7 +225,7 @@ private void validateAuthHeader(HttpExchange exchange) {
/**
* HTTP handler that injects random S3 service errors
- *
+ *
* Note: it is not a good idea to allow this handler to simulate too many errors as it would
* slow down the test suite.
*/
diff --git a/plugins/repository-s3/src/main/java/org/opensearch/repositories/s3/S3ClientSettings.java b/plugins/repository-s3/src/main/java/org/opensearch/repositories/s3/S3ClientSettings.java
index 933136228b1bb..2392c66329e06 100644
--- a/plugins/repository-s3/src/main/java/org/opensearch/repositories/s3/S3ClientSettings.java
+++ b/plugins/repository-s3/src/main/java/org/opensearch/repositories/s3/S3ClientSettings.java
@@ -446,7 +446,7 @@ S3ClientSettings refine(Settings repositorySettings) {
/**
* Load all client settings from the given settings.
- *
+ *
* Note this will always at least return a client named "default".
*/
static Map load(final Settings settings, final Path configPath) {
diff --git a/plugins/repository-s3/src/main/java/org/opensearch/repositories/s3/S3RetryingInputStream.java b/plugins/repository-s3/src/main/java/org/opensearch/repositories/s3/S3RetryingInputStream.java
index 3a35f6135f28b..d7e47e0ab1bcc 100644
--- a/plugins/repository-s3/src/main/java/org/opensearch/repositories/s3/S3RetryingInputStream.java
+++ b/plugins/repository-s3/src/main/java/org/opensearch/repositories/s3/S3RetryingInputStream.java
@@ -54,7 +54,7 @@
* Wrapper around an S3 object that will retry the {@link GetObjectRequest} if the download fails part-way through, resuming from where
* the failure occurred. This should be handled by the SDK but it isn't today. This should be revisited in the future (e.g. before removing
* the {@code LegacyESVersion#V_7_0_0} version constant) and removed when the SDK handles retries itself.
- *
+ *
* See https://github.com/aws/aws-sdk-java/issues/856 for the related SDK issue
*/
class S3RetryingInputStream extends InputStream {
diff --git a/plugins/store-smb/src/test/java/org/opensearch/index/store/SmbMMapDirectoryTests.java b/plugins/store-smb/src/test/java/org/opensearch/index/store/SmbMMapDirectoryTests.java
index 2cac58262c75a..e1655cc5e0784 100644
--- a/plugins/store-smb/src/test/java/org/opensearch/index/store/SmbMMapDirectoryTests.java
+++ b/plugins/store-smb/src/test/java/org/opensearch/index/store/SmbMMapDirectoryTests.java
@@ -47,9 +47,9 @@ protected Directory getDirectory(Path file) throws IOException {
@Override
public void testCreateOutputForExistingFile() throws IOException {
- /**
- * This test is disabled because {@link SmbDirectoryWrapper} opens existing file
- * with an explicit StandardOpenOption.TRUNCATE_EXISTING option.
+ /*
+ This test is disabled because {@link SmbDirectoryWrapper} opens existing file
+ with an explicit StandardOpenOption.TRUNCATE_EXISTING option.
*/
}
}
diff --git a/plugins/store-smb/src/test/java/org/opensearch/index/store/SmbNIOFSDirectoryTests.java b/plugins/store-smb/src/test/java/org/opensearch/index/store/SmbNIOFSDirectoryTests.java
index 7390759029dfc..6f821147c3079 100644
--- a/plugins/store-smb/src/test/java/org/opensearch/index/store/SmbNIOFSDirectoryTests.java
+++ b/plugins/store-smb/src/test/java/org/opensearch/index/store/SmbNIOFSDirectoryTests.java
@@ -26,9 +26,9 @@ protected Directory getDirectory(Path file) throws IOException {
@Override
public void testCreateOutputForExistingFile() throws IOException {
- /**
- * This test is disabled because {@link SmbDirectoryWrapper} opens existing file
- * with an explicit StandardOpenOption.TRUNCATE_EXISTING option.
+ /*
+ This test is disabled because {@link SmbDirectoryWrapper} opens existing file
+ with an explicit StandardOpenOption.TRUNCATE_EXISTING option.
*/
}
}
diff --git a/plugins/transport-nio/src/main/java/org/opensearch/http/nio/NioHttpRequest.java b/plugins/transport-nio/src/main/java/org/opensearch/http/nio/NioHttpRequest.java
index d25ef33c2ce29..5abd6f2710198 100644
--- a/plugins/transport-nio/src/main/java/org/opensearch/http/nio/NioHttpRequest.java
+++ b/plugins/transport-nio/src/main/java/org/opensearch/http/nio/NioHttpRequest.java
@@ -257,7 +257,7 @@ public FullHttpRequest nettyRequest() {
/**
* A wrapper of {@link HttpHeaders} that implements a map to prevent copying unnecessarily. This class does not support modifications
* and due to the underlying implementation, it performs case insensitive lookups of key to values.
- *
+ *
* It is important to note that this implementation does have some downsides in that each invocation of the
* {@link #values()} and {@link #entrySet()} methods will perform a copy of the values in the HttpHeaders rather than returning a
* view of the underlying values.
diff --git a/qa/full-cluster-restart/src/test/java/org/opensearch/upgrades/QueryBuilderBWCIT.java b/qa/full-cluster-restart/src/test/java/org/opensearch/upgrades/QueryBuilderBWCIT.java
index aabc3aee8887f..2675e9b62de35 100644
--- a/qa/full-cluster-restart/src/test/java/org/opensearch/upgrades/QueryBuilderBWCIT.java
+++ b/qa/full-cluster-restart/src/test/java/org/opensearch/upgrades/QueryBuilderBWCIT.java
@@ -78,7 +78,7 @@
* PercolatorFieldMapper#createQueryBuilderField(...) method). Using the query builders writable contract. This test
* does best effort verifying that we don't break bwc for query builders between the first previous major version and
* the latest current major release.
- *
+ *
* The queries to test are specified in json format, which turns out to work because we tend break here rarely. If the
* json format of a query being tested here then feel free to change this.
*/
diff --git a/qa/no-bootstrap-tests/src/test/java/org/opensearch/bootstrap/SpawnerNoBootstrapTests.java b/qa/no-bootstrap-tests/src/test/java/org/opensearch/bootstrap/SpawnerNoBootstrapTests.java
index c3c332aecfd4c..8ca90791f649e 100644
--- a/qa/no-bootstrap-tests/src/test/java/org/opensearch/bootstrap/SpawnerNoBootstrapTests.java
+++ b/qa/no-bootstrap-tests/src/test/java/org/opensearch/bootstrap/SpawnerNoBootstrapTests.java
@@ -65,7 +65,7 @@
/**
* Create a simple "daemon controller", put it in the right place and check that it runs.
- *
+ *
* Extends LuceneTestCase rather than OpenSearchTestCase as OpenSearchTestCase installs a system call filter, and
* that prevents the Spawner class from doing its job. Also needs to run in a separate JVM to other
* tests that extend OpenSearchTestCase for the same reason.
diff --git a/qa/os/src/test/java/org/opensearch/packaging/test/PackagingTestCase.java b/qa/os/src/test/java/org/opensearch/packaging/test/PackagingTestCase.java
index 02a613be320c2..4bb3877fc04a8 100644
--- a/qa/os/src/test/java/org/opensearch/packaging/test/PackagingTestCase.java
+++ b/qa/os/src/test/java/org/opensearch/packaging/test/PackagingTestCase.java
@@ -441,7 +441,7 @@ public static Path createTempDir(String prefix) throws IOException {
/**
* Run the given action with a temporary copy of the config directory.
- *
+ *
* Files under the path passed to the action may be modified as necessary for the
* test to execute, and running OpenSearch with {@link #startOpenSearch()} will
* use the temporary directory.
diff --git a/qa/os/src/test/java/org/opensearch/packaging/util/FileMatcher.java b/qa/os/src/test/java/org/opensearch/packaging/util/FileMatcher.java
index 7904d1a046916..958de24848178 100644
--- a/qa/os/src/test/java/org/opensearch/packaging/util/FileMatcher.java
+++ b/qa/os/src/test/java/org/opensearch/packaging/util/FileMatcher.java
@@ -51,7 +51,7 @@
/**
* Asserts that a file at a path matches its status as Directory/File, and its owner. If on a posix system, also matches the permission
* set is what we expect.
- *
+ *
* This class saves information about its failed matches in instance variables and so instances should not be reused
*/
public class FileMatcher extends TypeSafeMatcher {
diff --git a/qa/os/src/test/java/org/opensearch/packaging/util/Installation.java b/qa/os/src/test/java/org/opensearch/packaging/util/Installation.java
index 25cefa948ff10..26af39d66cad3 100644
--- a/qa/os/src/test/java/org/opensearch/packaging/util/Installation.java
+++ b/qa/os/src/test/java/org/opensearch/packaging/util/Installation.java
@@ -137,7 +137,7 @@ public static Installation ofContainer(Shell sh, Distribution distribution) {
/**
* Returns the user that owns this installation.
- *
+ *
* For packages this is root, and for archives it is the user doing the installation.
*/
public String getOwner() {
diff --git a/qa/rolling-upgrade/src/test/java/org/opensearch/upgrades/IndexingIT.java b/qa/rolling-upgrade/src/test/java/org/opensearch/upgrades/IndexingIT.java
index aef363058b394..f963f8d221bb5 100644
--- a/qa/rolling-upgrade/src/test/java/org/opensearch/upgrades/IndexingIT.java
+++ b/qa/rolling-upgrade/src/test/java/org/opensearch/upgrades/IndexingIT.java
@@ -98,11 +98,11 @@ private void waitForSearchableDocs(String index, int shardCount, int replicaCoun
// Verify segment store
assertBusy(() -> {
- /**
- * Use default tabular output and sort response based on shard,segment,primaryOrReplica columns to allow line by
- * line parsing where records related to a segment (e.g. _0) are chunked together with first record belonging
- * to primary while remaining *replicaCount* records belongs to replica copies
- * */
+ /*
+ Use default tabular output and sort response based on shard,segment,primaryOrReplica columns to allow line by
+ line parsing where records related to a segment (e.g. _0) are chunked together with first record belonging
+ to primary while remaining *replicaCount* records belongs to replica copies
+ */
Request segrepStatsRequest = new Request("GET", "/_cat/segments/" + index + "?s=shard,segment,primaryOrReplica");
segrepStatsRequest.addParameter("h", "index,shard,primaryOrReplica,segment,docs.count");
Response segrepStatsResponse = client().performRequest(segrepStatsRequest);
@@ -259,7 +259,8 @@ public void testIndexing() throws Exception {
* This test verifies that during rolling upgrades the segment replication does not break when replica shards can
* be running on older codec versions.
*
- * @throws Exception exception
+ * @throws Exception if index creation fail
+ * @throws UnsupportedOperationException if cluster type is unknown
*/
@AwaitsFix(bugUrl = "https://github.com/opensearch-project/OpenSearch/issues/7679")
public void testIndexingWithSegRep() throws Exception {
diff --git a/server/src/internalClusterTest/java/org/opensearch/action/admin/HotThreadsIT.java b/server/src/internalClusterTest/java/org/opensearch/action/admin/HotThreadsIT.java
index 6343bd127c458..4c9f49df71257 100644
--- a/server/src/internalClusterTest/java/org/opensearch/action/admin/HotThreadsIT.java
+++ b/server/src/internalClusterTest/java/org/opensearch/action/admin/HotThreadsIT.java
@@ -60,8 +60,8 @@
public class HotThreadsIT extends OpenSearchIntegTestCase {
public void testHotThreadsDontFail() throws ExecutionException, InterruptedException {
- /**
- * This test just checks if nothing crashes or gets stuck etc.
+ /*
+ This test just checks if nothing crashes or gets stuck etc.
*/
createIndex("test");
final int iters = scaledRandomIntBetween(2, 20);
diff --git a/server/src/internalClusterTest/java/org/opensearch/action/admin/cluster/node/tasks/AbstractTasksIT.java b/server/src/internalClusterTest/java/org/opensearch/action/admin/cluster/node/tasks/AbstractTasksIT.java
index 0197ccf059737..44ba585016d8e 100644
--- a/server/src/internalClusterTest/java/org/opensearch/action/admin/cluster/node/tasks/AbstractTasksIT.java
+++ b/server/src/internalClusterTest/java/org/opensearch/action/admin/cluster/node/tasks/AbstractTasksIT.java
@@ -112,7 +112,7 @@ protected int numberOfEvents(String actionMasks, Function findEvents(String actionMasks, Function, Boolean> criteria) {
List events = new ArrayList<>();
diff --git a/server/src/internalClusterTest/java/org/opensearch/action/admin/cluster/node/tasks/ConcurrentSearchTasksIT.java b/server/src/internalClusterTest/java/org/opensearch/action/admin/cluster/node/tasks/ConcurrentSearchTasksIT.java
index c733329a1b5f7..e6fd9139d45f2 100644
--- a/server/src/internalClusterTest/java/org/opensearch/action/admin/cluster/node/tasks/ConcurrentSearchTasksIT.java
+++ b/server/src/internalClusterTest/java/org/opensearch/action/admin/cluster/node/tasks/ConcurrentSearchTasksIT.java
@@ -30,7 +30,7 @@
/**
* Integration tests for task management API with Concurrent Segment Search
- *
+ *
* The way the test framework bootstraps the test cluster makes it difficult to parameterize the feature flag.
* Once concurrent search is moved behind a cluster setting we can parameterize these tests behind the setting.
*/
@@ -72,7 +72,7 @@ protected Settings featureFlagSettings() {
/**
* Tests the number of threads that worked on a search task.
- *
+ *
* Currently, we try to control concurrency by creating an index with 7 segments and rely on
* the way concurrent search creates leaf slices from segments. Once more concurrency controls are introduced
* we should improve this test to use those methods.
diff --git a/server/src/internalClusterTest/java/org/opensearch/action/admin/cluster/repositories/RepositoryBlocksIT.java b/server/src/internalClusterTest/java/org/opensearch/action/admin/cluster/repositories/RepositoryBlocksIT.java
index aff7c5d9876ac..36fe3748e9d10 100644
--- a/server/src/internalClusterTest/java/org/opensearch/action/admin/cluster/repositories/RepositoryBlocksIT.java
+++ b/server/src/internalClusterTest/java/org/opensearch/action/admin/cluster/repositories/RepositoryBlocksIT.java
@@ -46,7 +46,7 @@
/**
* This class tests that repository operations (Put, Delete, Verify) are blocked when the cluster is read-only.
- *
+ *
* The @NodeScope TEST is needed because this class updates the cluster setting "cluster.blocks.read_only".
*/
@ClusterScope(scope = OpenSearchIntegTestCase.Scope.TEST)
diff --git a/server/src/internalClusterTest/java/org/opensearch/action/admin/cluster/snapshots/SnapshotBlocksIT.java b/server/src/internalClusterTest/java/org/opensearch/action/admin/cluster/snapshots/SnapshotBlocksIT.java
index 347011721c728..78fb01b07b6b1 100644
--- a/server/src/internalClusterTest/java/org/opensearch/action/admin/cluster/snapshots/SnapshotBlocksIT.java
+++ b/server/src/internalClusterTest/java/org/opensearch/action/admin/cluster/snapshots/SnapshotBlocksIT.java
@@ -53,7 +53,7 @@
/**
* This class tests that snapshot operations (Create, Delete, Restore) are blocked when the cluster is read-only.
- *
+ *
* The @NodeScope TEST is needed because this class updates the cluster setting "cluster.blocks.read_only".
*/
@ClusterScope(scope = OpenSearchIntegTestCase.Scope.TEST)
diff --git a/server/src/internalClusterTest/java/org/opensearch/action/bulk/BulkProcessorRetryIT.java b/server/src/internalClusterTest/java/org/opensearch/action/bulk/BulkProcessorRetryIT.java
index 737c0acc309fd..cd6cb0ca3b172 100644
--- a/server/src/internalClusterTest/java/org/opensearch/action/bulk/BulkProcessorRetryIT.java
+++ b/server/src/internalClusterTest/java/org/opensearch/action/bulk/BulkProcessorRetryIT.java
@@ -194,7 +194,7 @@ private static void indexDocs(BulkProcessor processor, int numDocs) {
/**
* Internal helper class to correlate backoff states with bulk responses. This is needed to check whether we maxed out the number
* of retries but still got rejected (which is perfectly fine and can also happen from time to time under heavy load).
- *
+ *
* This implementation relies on an implementation detail in Retry, namely that the bulk listener is notified on the same thread
* as the last call to the backoff policy's iterator. The advantage is that this is non-invasive to the rest of the production code.
*/
diff --git a/server/src/internalClusterTest/java/org/opensearch/action/ingest/AsyncIngestProcessorIT.java b/server/src/internalClusterTest/java/org/opensearch/action/ingest/AsyncIngestProcessorIT.java
index c62c61d5919d6..aefabcb9bc14f 100644
--- a/server/src/internalClusterTest/java/org/opensearch/action/ingest/AsyncIngestProcessorIT.java
+++ b/server/src/internalClusterTest/java/org/opensearch/action/ingest/AsyncIngestProcessorIT.java
@@ -69,7 +69,7 @@
/**
* The purpose of this test is to verify that when a processor executes an operation asynchronously that
* the expected result is the same as if the same operation happens synchronously.
- *
+ *
* In this test two test processor are defined that basically do the same operation, but a single processor
* executes asynchronously. The result of the operation should be the same and also the order in which the
* bulk responses are returned should be the same as how the corresponding index requests were defined.
diff --git a/server/src/internalClusterTest/java/org/opensearch/action/search/TransportSearchIT.java b/server/src/internalClusterTest/java/org/opensearch/action/search/TransportSearchIT.java
index f0a3b5a5901ce..b1934f901ac65 100644
--- a/server/src/internalClusterTest/java/org/opensearch/action/search/TransportSearchIT.java
+++ b/server/src/internalClusterTest/java/org/opensearch/action/search/TransportSearchIT.java
@@ -109,8 +109,8 @@ public List getAggregations() {
@Override
public List getFetchSubPhases(FetchPhaseConstructionContext context) {
- /**
- * Set up a fetch sub phase that throws an exception on indices whose name that start with "boom".
+ /*
+ Set up a fetch sub phase that throws an exception on indices whose name that start with "boom".
*/
return Collections.singletonList(fetchContext -> new FetchSubPhaseProcessor() {
@Override
diff --git a/server/src/internalClusterTest/java/org/opensearch/discovery/ClusterDisruptionIT.java b/server/src/internalClusterTest/java/org/opensearch/discovery/ClusterDisruptionIT.java
index 38b86d307d197..737b272613a44 100644
--- a/server/src/internalClusterTest/java/org/opensearch/discovery/ClusterDisruptionIT.java
+++ b/server/src/internalClusterTest/java/org/opensearch/discovery/ClusterDisruptionIT.java
@@ -461,7 +461,7 @@ public boolean validateClusterForming() {
/**
* Tests that indices are properly deleted even if there is a cluster-manager transition in between.
- * Test for https://github.com/elastic/elasticsearch/issues/11665
+ * Test for Elasticsearch issue #11665
*/
public void testIndicesDeleted() throws Exception {
final String idxName = "test";
diff --git a/server/src/internalClusterTest/java/org/opensearch/indices/replication/SegmentReplicationAllocationIT.java b/server/src/internalClusterTest/java/org/opensearch/indices/replication/SegmentReplicationAllocationIT.java
index bdefd7a5e199a..f485d4e402b41 100644
--- a/server/src/internalClusterTest/java/org/opensearch/indices/replication/SegmentReplicationAllocationIT.java
+++ b/server/src/internalClusterTest/java/org/opensearch/indices/replication/SegmentReplicationAllocationIT.java
@@ -91,7 +91,7 @@ public void testGlobalPrimaryAllocation() throws Exception {
/**
* This test verifies the happy path where primary shard allocation is balanced when multiple indices are created.
- *
+ *
* This test in general passes without primary shard balance as well due to nature of allocation algorithm which
* assigns all primary shards first followed by replica copies.
*/
diff --git a/server/src/internalClusterTest/java/org/opensearch/indices/state/CloseIndexIT.java b/server/src/internalClusterTest/java/org/opensearch/indices/state/CloseIndexIT.java
index ae88dd76d54e0..547f9e7a8d380 100644
--- a/server/src/internalClusterTest/java/org/opensearch/indices/state/CloseIndexIT.java
+++ b/server/src/internalClusterTest/java/org/opensearch/indices/state/CloseIndexIT.java
@@ -509,7 +509,7 @@ public Settings onNodeStopped(String nodeName) throws Exception {
}
/**
- * Test for https://github.com/elastic/elasticsearch/issues/47276 which checks that the persisted metadata on a data node does not
+ * Test for Elasticsearch issue #47276 which checks that the persisted metadata on a data node does not
* become inconsistent when using replicated closed indices.
*/
public void testRelocatedClosedIndexIssue() throws Exception {
diff --git a/server/src/internalClusterTest/java/org/opensearch/recovery/FullRollingRestartIT.java b/server/src/internalClusterTest/java/org/opensearch/recovery/FullRollingRestartIT.java
index f636185fd4649..d28df90216beb 100644
--- a/server/src/internalClusterTest/java/org/opensearch/recovery/FullRollingRestartIT.java
+++ b/server/src/internalClusterTest/java/org/opensearch/recovery/FullRollingRestartIT.java
@@ -198,11 +198,11 @@ public void testNoRebalanceOnRollingRestart() throws Exception {
// see https://github.com/elastic/elasticsearch/issues/14387
internalCluster().startClusterManagerOnlyNode(Settings.EMPTY);
internalCluster().startDataOnlyNodes(3);
- /**
- * We start 3 nodes and a dedicated cluster-manager. Restart on of the data-nodes and ensure that we got no relocations.
- * Yet we have 6 shards 0 replica so that means if the restarting node comes back both other nodes are subject
- * to relocating to the restarting node since all had 2 shards and now one node has nothing allocated.
- * We have a fix for this to wait until we have allocated unallocated shards now so this shouldn't happen.
+ /*
+ We start 3 nodes and a dedicated cluster-manager. Restart on of the data-nodes and ensure that we got no relocations.
+ Yet we have 6 shards 0 replica so that means if the restarting node comes back both other nodes are subject
+ to relocating to the restarting node since all had 2 shards and now one node has nothing allocated.
+ We have a fix for this to wait until we have allocated unallocated shards now so this shouldn't happen.
*/
prepareCreate("test").setSettings(
Settings.builder()
diff --git a/server/src/internalClusterTest/java/org/opensearch/search/aggregations/bucket/DateHistogramIT.java b/server/src/internalClusterTest/java/org/opensearch/search/aggregations/bucket/DateHistogramIT.java
index 895e24ba65132..ee94e574228df 100644
--- a/server/src/internalClusterTest/java/org/opensearch/search/aggregations/bucket/DateHistogramIT.java
+++ b/server/src/internalClusterTest/java/org/opensearch/search/aggregations/bucket/DateHistogramIT.java
@@ -1481,7 +1481,7 @@ public void testExceptionOnNegativeInterval() {
/**
* https://github.com/elastic/elasticsearch/issues/31760 shows an edge case where an unmapped "date" field in two indices
* that are queried simultaneously can lead to the "format" parameter in the aggregation not being preserved correctly.
- *
+ *
* The error happens when the bucket from the "unmapped" index is received first in the reduce phase, however the case can
* be recreated when aggregating about a single index with an unmapped date field and also getting "empty" buckets.
*/
diff --git a/server/src/internalClusterTest/java/org/opensearch/search/aggregations/pipeline/MaxBucketIT.java b/server/src/internalClusterTest/java/org/opensearch/search/aggregations/pipeline/MaxBucketIT.java
index bb90c1294ecb8..dc3b690c7f78f 100644
--- a/server/src/internalClusterTest/java/org/opensearch/search/aggregations/pipeline/MaxBucketIT.java
+++ b/server/src/internalClusterTest/java/org/opensearch/search/aggregations/pipeline/MaxBucketIT.java
@@ -544,13 +544,13 @@ public void testNested() throws Exception {
/**
* https://github.com/elastic/elasticsearch/issues/33514
- *
+ *
* This bug manifests as the max_bucket agg ("peak") being added to the response twice, because
* the pipeline agg is run twice. This makes invalid JSON and breaks conversion to maps.
* The bug was caused by an UnmappedTerms being the chosen as the first reduction target. UnmappedTerms
* delegated reduction to the first non-unmapped agg, which would reduce and run pipeline aggs. But then
* execution returns to the UnmappedTerms and _it_ runs pipelines as well, doubling up on the values.
- *
+ *
* Applies to any pipeline agg, not just max.
*/
public void testFieldIsntWrittenOutTwice() throws Exception {
diff --git a/server/src/internalClusterTest/java/org/opensearch/search/aggregations/pipeline/MovAvgIT.java b/server/src/internalClusterTest/java/org/opensearch/search/aggregations/pipeline/MovAvgIT.java
index 0cf89778c6e99..2aad0d2d38901 100644
--- a/server/src/internalClusterTest/java/org/opensearch/search/aggregations/pipeline/MovAvgIT.java
+++ b/server/src/internalClusterTest/java/org/opensearch/search/aggregations/pipeline/MovAvgIT.java
@@ -1168,7 +1168,7 @@ public void testHoltWintersMinimization() {
* the default settings. Which means our mock histo will match the generated result (which it won't
* if the minimizer is actually working, since the coefficients will be different and thus generate different
* data)
- *
+ *
* We can simulate this by setting the window size == size of histo
*/
public void testMinimizeNotEnoughData() {
diff --git a/server/src/internalClusterTest/java/org/opensearch/search/pit/DeletePitMultiNodeIT.java b/server/src/internalClusterTest/java/org/opensearch/search/pit/DeletePitMultiNodeIT.java
index 43b7179a335f8..4a178e7066846 100644
--- a/server/src/internalClusterTest/java/org/opensearch/search/pit/DeletePitMultiNodeIT.java
+++ b/server/src/internalClusterTest/java/org/opensearch/search/pit/DeletePitMultiNodeIT.java
@@ -93,8 +93,8 @@ public void testDeletePit() throws Exception {
assertTrue(deletePitInfo.isSuccessful());
}
validatePitStats("index", 0, 10);
- /**
- * Checking deleting the same PIT id again results in succeeded
+ /*
+ Checking deleting the same PIT id again results in succeeded
*/
deleteExecute = client().execute(DeletePitAction.INSTANCE, deletePITRequest);
deletePITResponse = deleteExecute.get();
@@ -113,8 +113,8 @@ public void testDeletePitWithValidAndDeletedIds() throws Exception {
pitIds.add(pitResponse.getId());
validatePitStats("index", 5, 0);
- /**
- * Delete Pit #1
+ /*
+ Delete Pit #1
*/
DeletePitRequest deletePITRequest = new DeletePitRequest(pitIds);
ActionFuture deleteExecute = client().execute(DeletePitAction.INSTANCE, deletePITRequest);
@@ -128,8 +128,8 @@ public void testDeletePitWithValidAndDeletedIds() throws Exception {
pitResponse = execute.get();
pitIds.add(pitResponse.getId());
validatePitStats("index", 5, 5);
- /**
- * Delete PIT with both Ids #1 (which is deleted) and #2 (which is present)
+ /*
+ Delete PIT with both Ids #1 (which is deleted) and #2 (which is present)
*/
deletePITRequest = new DeletePitRequest(pitIds);
deleteExecute = client().execute(DeletePitAction.INSTANCE, deletePITRequest);
@@ -165,9 +165,9 @@ public void testDeleteAllPits() throws Exception {
validatePitStats("index1", 5, 0);
DeletePitRequest deletePITRequest = new DeletePitRequest("_all");
- /**
- * When we invoke delete again, returns success after clearing the remaining readers. Asserting reader context
- * not found exceptions don't result in failures ( as deletion in one node is successful )
+ /*
+ When we invoke delete again, returns success after clearing the remaining readers. Asserting reader context
+ not found exceptions don't result in failures ( as deletion in one node is successful )
*/
ActionFuture execute = client().execute(DeletePitAction.INSTANCE, deletePITRequest);
DeletePitResponse deletePITResponse = execute.get();
@@ -207,9 +207,9 @@ public Settings onNodeStopped(String nodeName) throws Exception {
});
ensureGreen();
- /**
- * When we invoke delete again, returns success after clearing the remaining readers. Asserting reader context
- * not found exceptions don't result in failures ( as deletion in one node is successful )
+ /*
+ When we invoke delete again, returns success after clearing the remaining readers. Asserting reader context
+ not found exceptions don't result in failures ( as deletion in one node is successful )
*/
ActionFuture execute = client().execute(DeletePitAction.INSTANCE, deletePITRequest);
DeletePitResponse deletePITResponse = execute.get();
@@ -242,9 +242,9 @@ public Settings onNodeStopped(String nodeName) throws Exception {
}
});
ensureGreen();
- /**
- * When we invoke delete again, returns success as all readers are cleared. (Delete all on node which is Up and
- * once the node restarts, all active contexts are cleared in the node )
+ /*
+ When we invoke delete again, returns success as all readers are cleared. (Delete all on node which is Up and
+ once the node restarts, all active contexts are cleared in the node )
*/
ActionFuture execute = client().execute(DeletePitAction.INSTANCE, deletePITRequest);
DeletePitResponse deletePITResponse = execute.get();
@@ -278,8 +278,8 @@ public void testDeleteWhileSearch() throws Exception {
}
}
} catch (Exception e) {
- /**
- * assert for exception once delete pit goes through. throw error in case of any exeption before that.
+ /*
+ assert for exception once delete pit goes through. throw error in case of any exeption before that.
*/
if (deleted.get() == true) {
Throwable t = ExceptionsHelper.unwrapCause(e.getCause());
diff --git a/server/src/internalClusterTest/java/org/opensearch/search/searchafter/SearchAfterIT.java b/server/src/internalClusterTest/java/org/opensearch/search/searchafter/SearchAfterIT.java
index 00ac574b8bd72..b99f66850e9e3 100644
--- a/server/src/internalClusterTest/java/org/opensearch/search/searchafter/SearchAfterIT.java
+++ b/server/src/internalClusterTest/java/org/opensearch/search/searchafter/SearchAfterIT.java
@@ -220,8 +220,8 @@ public void testPitWithSearchAfter() throws Exception {
.setPointInTime(new PointInTimeBuilder(pitResponse.getId()))
.get();
assertEquals(3, sr.getHits().getHits().length);
- /**
- * Add new data and assert PIT results remain the same and normal search results gets refreshed
+ /*
+ Add new data and assert PIT results remain the same and normal search results gets refreshed
*/
indexRandom(true, client().prepareIndex("test").setId("4").setSource("field1", 102));
sr = client().prepareSearch()
diff --git a/server/src/internalClusterTest/java/org/opensearch/search/sort/GeoDistanceSortBuilderIT.java b/server/src/internalClusterTest/java/org/opensearch/search/sort/GeoDistanceSortBuilderIT.java
index 7880fc24fd846..1b8bd9694483d 100644
--- a/server/src/internalClusterTest/java/org/opensearch/search/sort/GeoDistanceSortBuilderIT.java
+++ b/server/src/internalClusterTest/java/org/opensearch/search/sort/GeoDistanceSortBuilderIT.java
@@ -91,16 +91,16 @@ protected boolean forbidPrivateIndexSettings() {
}
public void testManyToManyGeoPoints() throws ExecutionException, InterruptedException, IOException {
- /**
- * | q | d1 | d2
- * | | |
- * | | |
- * | | |
- * |2 o| x | x
- * | | |
- * |1 o| x | x
- * |___________________________
- * 1 2 3 4 5 6 7
+ /*
+ | q | d1 | d2
+ | | |
+ | | |
+ | | |
+ |2 o| x | x
+ | | |
+ |1 o| x | x
+ |___________________________
+ 1 2 3 4 5 6 7
*/
Version version = randomBoolean() ? Version.CURRENT : VersionUtils.randomIndexCompatibleVersion(random());
Settings settings = Settings.builder().put(IndexMetadata.SETTING_VERSION_CREATED, version).build();
@@ -187,11 +187,10 @@ public void testManyToManyGeoPoints() throws ExecutionException, InterruptedExce
}
public void testSingeToManyAvgMedian() throws ExecutionException, InterruptedException, IOException {
- /**
- * q = (0, 0)
- *
- * d1 = (0, 1), (0, 4), (0, 10); so avg. distance is 5, median distance is 4
- * d2 = (0, 1), (0, 5), (0, 6); so avg. distance is 4, median distance is 5
+ /*
+ q = (0, 0)
+ d1 = (0, 1), (0, 4), (0, 10); so avg. distance is 5, median distance is 4
+ d2 = (0, 1), (0, 5), (0, 6); so avg. distance is 4, median distance is 5
*/
Version version = randomBoolean() ? Version.CURRENT : VersionUtils.randomIndexCompatibleVersion(random());
Settings settings = Settings.builder().put(IndexMetadata.SETTING_VERSION_CREATED, version).build();
@@ -256,16 +255,17 @@ protected void createShuffeldJSONArray(XContentBuilder builder, GeoPoint[] point
}
public void testManyToManyGeoPointsWithDifferentFormats() throws ExecutionException, InterruptedException, IOException {
- /** q d1 d2
- * |4 o| x | x
- * | | |
- * |3 o| x | x
- * | | |
- * |2 o| x | x
- * | | |
- * |1 o|x |x
- * |______________________
- * 1 2 3 4 5 6
+ /*
+ q d1 d2
+ |4 o| x | x
+ | | |
+ |3 o| x | x
+ | | |
+ |2 o| x | x
+ | | |
+ |1 o|x |x
+ |______________________
+ 1 2 3 4 5 6
*/
Version version = randomBoolean() ? Version.CURRENT : VersionUtils.randomIndexCompatibleVersion(random());
Settings settings = Settings.builder().put(IndexMetadata.SETTING_VERSION_CREATED, version).build();
diff --git a/server/src/internalClusterTest/java/org/opensearch/snapshots/SharedClusterSnapshotRestoreIT.java b/server/src/internalClusterTest/java/org/opensearch/snapshots/SharedClusterSnapshotRestoreIT.java
index 5268d5ddf35af..91b0aa6438753 100644
--- a/server/src/internalClusterTest/java/org/opensearch/snapshots/SharedClusterSnapshotRestoreIT.java
+++ b/server/src/internalClusterTest/java/org/opensearch/snapshots/SharedClusterSnapshotRestoreIT.java
@@ -1884,7 +1884,7 @@ public void testCannotCreateSnapshotsWithSameName() throws Exception {
* This test ensures that when a shard is removed from a node (perhaps due to the node
* leaving the cluster, then returning), all snapshotting of that shard is aborted, so
* all Store references held onto by the snapshot are released.
- *
+ *
* See https://github.com/elastic/elasticsearch/issues/20876
*/
public void testSnapshotCanceledOnRemovedShard() throws Exception {
diff --git a/server/src/internalClusterTest/java/org/opensearch/versioning/ConcurrentSeqNoVersioningIT.java b/server/src/internalClusterTest/java/org/opensearch/versioning/ConcurrentSeqNoVersioningIT.java
index c651689e21d3d..7f016caf22149 100644
--- a/server/src/internalClusterTest/java/org/opensearch/versioning/ConcurrentSeqNoVersioningIT.java
+++ b/server/src/internalClusterTest/java/org/opensearch/versioning/ConcurrentSeqNoVersioningIT.java
@@ -93,7 +93,7 @@
* provided the primaryTerm and seqNo still matches. The reason we cannot assume it will not take place after receiving the failure
* is that a request can fork into two because of retries on disconnect, and now race against itself. The retry might complete (and do a
* dirty or stale read) before the forked off request gets to execute, and that one might still subsequently succeed.
- *
+ *
* Such writes are not necessarily fully replicated and can be lost. There is no
* guarantee that the previous value did not have the specified primaryTerm and seqNo
* - CAS writes with other exceptions might or might not have taken place. If they have taken place, then after invocation but not
diff --git a/server/src/main/java/org/apache/lucene/index/OneMergeHelper.java b/server/src/main/java/org/apache/lucene/index/OneMergeHelper.java
index 8f67bb87b5c42..0ada02a09d157 100644
--- a/server/src/main/java/org/apache/lucene/index/OneMergeHelper.java
+++ b/server/src/main/java/org/apache/lucene/index/OneMergeHelper.java
@@ -59,8 +59,8 @@ public static double getMbPerSec(Thread thread, MergePolicy.OneMerge merge) {
* Returns total bytes written by this merge.
**/
public static long getTotalBytesWritten(Thread thread, MergePolicy.OneMerge merge) throws IOException {
- /**
- * TODO: The number of bytes written during the merge should be accessible in OneMerge.
+ /*
+ TODO: The number of bytes written during the merge should be accessible in OneMerge.
*/
if (thread instanceof ConcurrentMergeScheduler.MergeThread) {
return ((ConcurrentMergeScheduler.MergeThread) thread).rateLimiter.getTotalBytesWritten();
diff --git a/server/src/main/java/org/apache/lucene/queryparser/classic/XQueryParser.java b/server/src/main/java/org/apache/lucene/queryparser/classic/XQueryParser.java
index 9a8c295d60ec7..2f00ea69207a7 100644
--- a/server/src/main/java/org/apache/lucene/queryparser/classic/XQueryParser.java
+++ b/server/src/main/java/org/apache/lucene/queryparser/classic/XQueryParser.java
@@ -38,7 +38,7 @@
/**
* This class is just a workaround to make {@link QueryParser#handleBareFuzzy(String, Token, String)} accessible by sub-classes.
* It is needed for {@link QueryParser}s that need to override the parsing of the slop in a fuzzy query (e.g. word~2, word~).
- *
+ *
* TODO: We should maybe rewrite this with the flexible query parser which matches the same syntax with more freedom.
*/
public class XQueryParser extends QueryParser {
diff --git a/server/src/main/java/org/apache/lucene/search/grouping/CollapsingTopDocsCollector.java b/server/src/main/java/org/apache/lucene/search/grouping/CollapsingTopDocsCollector.java
index e4c299ba572b1..9ca0491bc29f5 100644
--- a/server/src/main/java/org/apache/lucene/search/grouping/CollapsingTopDocsCollector.java
+++ b/server/src/main/java/org/apache/lucene/search/grouping/CollapsingTopDocsCollector.java
@@ -50,7 +50,7 @@
* A collector that groups documents based on field values and returns {@link CollapseTopFieldDocs}
* output. The collapsing is done in a single pass by selecting only the top sorted document per collapse key.
* The value used for the collapse key of each group can be found in {@link CollapseTopFieldDocs#collapseValues}.
- *
+ *
* TODO: If the sort is based on score we should propagate the mininum competitive score when orderedGroups is full.
* This is safe for collapsing since the group sort is the same as the query sort.
*/
diff --git a/server/src/main/java/org/apache/lucene/search/uhighlight/BoundedBreakIteratorScanner.java b/server/src/main/java/org/apache/lucene/search/uhighlight/BoundedBreakIteratorScanner.java
index 6fde39b16a59a..4edcdea42b53b 100644
--- a/server/src/main/java/org/apache/lucene/search/uhighlight/BoundedBreakIteratorScanner.java
+++ b/server/src/main/java/org/apache/lucene/search/uhighlight/BoundedBreakIteratorScanner.java
@@ -43,13 +43,13 @@
* If the {@link BreakIterator} cannot find a passage smaller than the maximum length,
* a secondary break iterator is used to re-split the passage at the first boundary after
* maximum length.
- *
+ *
* This is useful to split passages created by {@link BreakIterator}s like `sentence` that
* can create big outliers on semi-structured text.
- *
+ *
*
* WARNING: This break iterator is designed to work with the {@link UnifiedHighlighter}.
- *
+ *
* TODO: We should be able to create passages incrementally, starting from the offset of the first match and expanding or not
* depending on the offsets of subsequent matches. This is currently impossible because {@link FieldHighlighter} uses
* only the first matching offset to derive the start and end of each passage.
diff --git a/server/src/main/java/org/apache/lucene/util/packed/XPacked64.java b/server/src/main/java/org/apache/lucene/util/packed/XPacked64.java
index 4777b77cfbfed..9e9f6d1fd817d 100644
--- a/server/src/main/java/org/apache/lucene/util/packed/XPacked64.java
+++ b/server/src/main/java/org/apache/lucene/util/packed/XPacked64.java
@@ -38,8 +38,8 @@
/**
* Forked from Lucene 8.x; removed in Lucene 9.0
*
- * @todo further investigate a better alternative
- *
+ * TODO: further investigate a better alternative
+ *
* Space optimized random access capable array of values with a fixed number of bits/value. Values
* are packed contiguously.
*
diff --git a/server/src/main/java/org/apache/lucene/util/packed/XPacked64SingleBlock.java b/server/src/main/java/org/apache/lucene/util/packed/XPacked64SingleBlock.java
index 0324522e9a68d..53cf4ed8e2273 100644
--- a/server/src/main/java/org/apache/lucene/util/packed/XPacked64SingleBlock.java
+++ b/server/src/main/java/org/apache/lucene/util/packed/XPacked64SingleBlock.java
@@ -25,8 +25,8 @@
/**
* Forked from Lucene 8.x; removed in Lucene 9.0
*
- * @todo further investigate a better alternative
- *
+ * TODO: further investigate a better alternative
+ *
* This class is similar to {@link Packed64} except that it trades space for speed by ensuring that
* a single block needs to be read/written in order to read/write a value.
*/
diff --git a/server/src/main/java/org/apache/lucene/util/packed/XPackedInts.java b/server/src/main/java/org/apache/lucene/util/packed/XPackedInts.java
index f94a4531a7db9..4260d34ead7c9 100644
--- a/server/src/main/java/org/apache/lucene/util/packed/XPackedInts.java
+++ b/server/src/main/java/org/apache/lucene/util/packed/XPackedInts.java
@@ -35,9 +35,9 @@
/**
* Forked from Lucene 8.x; removed in Lucene 8.9
- *
+ *
* Todo: further investigate a better alternative
- *
+ *
* Simplistic compression for array of unsigned long values. Each value is {@code >= 0} and {@code
* <=} a specified maximum value. The values are stored as packed ints, with each value consuming a
* fixed number of bits.
diff --git a/server/src/main/java/org/opensearch/action/AliasesRequest.java b/server/src/main/java/org/opensearch/action/AliasesRequest.java
index 4c5d5628b1aac..3632ba2d7304f 100644
--- a/server/src/main/java/org/opensearch/action/AliasesRequest.java
+++ b/server/src/main/java/org/opensearch/action/AliasesRequest.java
@@ -54,7 +54,7 @@ public interface AliasesRequest extends IndicesRequest.Replaceable {
/**
* Replaces current aliases with the provided aliases.
- *
+ *
* Sometimes aliases expressions need to be resolved to concrete aliases prior to executing the transport action.
*/
void replaceAliases(String... aliases);
diff --git a/server/src/main/java/org/opensearch/action/DocWriteRequest.java b/server/src/main/java/org/opensearch/action/DocWriteRequest.java
index df6414470ab6b..31f61e76c74ff 100644
--- a/server/src/main/java/org/opensearch/action/DocWriteRequest.java
+++ b/server/src/main/java/org/opensearch/action/DocWriteRequest.java
@@ -149,7 +149,7 @@ public interface DocWriteRequest extends IndicesRequest, Accountable {
/**
* If set, only perform this request if the document was last modification was assigned this primary term.
- *
+ *
* If the document last modification was assigned a different term a
* {@link org.opensearch.index.engine.VersionConflictEngineException} will be thrown.
*/
diff --git a/server/src/main/java/org/opensearch/action/DocWriteResponse.java b/server/src/main/java/org/opensearch/action/DocWriteResponse.java
index afdb1d3a0bdd9..e3052b3b80035 100644
--- a/server/src/main/java/org/opensearch/action/DocWriteResponse.java
+++ b/server/src/main/java/org/opensearch/action/DocWriteResponse.java
@@ -341,7 +341,7 @@ public XContentBuilder innerToXContent(XContentBuilder builder, Params params) t
/**
* Parse the output of the {@link #innerToXContent(XContentBuilder, Params)} method.
- *
+ *
* This method is intended to be called by subclasses and must be called multiple times to parse all the information concerning
* {@link DocWriteResponse} objects. It always parses the current token, updates the given parsing context accordingly
* if needed and then immediately returns.
diff --git a/server/src/main/java/org/opensearch/action/TaskOperationFailure.java b/server/src/main/java/org/opensearch/action/TaskOperationFailure.java
index 0930bd2741810..5948dd3e2b7cb 100644
--- a/server/src/main/java/org/opensearch/action/TaskOperationFailure.java
+++ b/server/src/main/java/org/opensearch/action/TaskOperationFailure.java
@@ -50,7 +50,7 @@
/**
* Information about task operation failures
- *
+ *
* The class is final due to serialization limitations
*
* @opensearch.internal
diff --git a/server/src/main/java/org/opensearch/action/admin/cluster/allocation/ClusterAllocationExplainRequest.java b/server/src/main/java/org/opensearch/action/admin/cluster/allocation/ClusterAllocationExplainRequest.java
index 625aa91e6ea7f..3dec781f0acf4 100644
--- a/server/src/main/java/org/opensearch/action/admin/cluster/allocation/ClusterAllocationExplainRequest.java
+++ b/server/src/main/java/org/opensearch/action/admin/cluster/allocation/ClusterAllocationExplainRequest.java
@@ -95,7 +95,7 @@ public ClusterAllocationExplainRequest(StreamInput in) throws IOException {
* Create a new allocation explain request. If {@code primary} is false, the first unassigned replica
* will be picked for explanation. If no replicas are unassigned, the first assigned replica will
* be explained.
- *
+ *
* Package private for testing.
*/
ClusterAllocationExplainRequest(String index, int shard, boolean primary, @Nullable String currentNode) {
diff --git a/server/src/main/java/org/opensearch/action/admin/cluster/node/tasks/get/TransportGetTaskAction.java b/server/src/main/java/org/opensearch/action/admin/cluster/node/tasks/get/TransportGetTaskAction.java
index 8d82827f4ee50..e62c83490d810 100644
--- a/server/src/main/java/org/opensearch/action/admin/cluster/node/tasks/get/TransportGetTaskAction.java
+++ b/server/src/main/java/org/opensearch/action/admin/cluster/node/tasks/get/TransportGetTaskAction.java
@@ -67,7 +67,7 @@
/**
* ActionType to get a single task. If the task isn't running then it'll try to request the status from request index.
- *
+ *
* The general flow is:
*
* - If this isn't being executed on the node to which the requested TaskId belongs then move to that node.
diff --git a/server/src/main/java/org/opensearch/action/admin/cluster/repositories/cleanup/TransportCleanupRepositoryAction.java b/server/src/main/java/org/opensearch/action/admin/cluster/repositories/cleanup/TransportCleanupRepositoryAction.java
index f26ccbc569cf0..774bffa10da4f 100644
--- a/server/src/main/java/org/opensearch/action/admin/cluster/repositories/cleanup/TransportCleanupRepositoryAction.java
+++ b/server/src/main/java/org/opensearch/action/admin/cluster/repositories/cleanup/TransportCleanupRepositoryAction.java
@@ -67,7 +67,7 @@
/**
* Repository cleanup action for repository implementations based on {@link BlobStoreRepository}.
- *
+ *
* The steps taken by the repository cleanup operation are as follows:
*
* - Check that there are no running repository cleanup, snapshot create, or snapshot delete actions
diff --git a/server/src/main/java/org/opensearch/action/admin/cluster/repositories/get/GetRepositoriesRequest.java b/server/src/main/java/org/opensearch/action/admin/cluster/repositories/get/GetRepositoriesRequest.java
index ac975e917e056..6fb086f65497e 100644
--- a/server/src/main/java/org/opensearch/action/admin/cluster/repositories/get/GetRepositoriesRequest.java
+++ b/server/src/main/java/org/opensearch/action/admin/cluster/repositories/get/GetRepositoriesRequest.java
@@ -88,7 +88,7 @@ public ActionRequestValidationException validate() {
/**
* The names of the repositories.
*
- * @return list of repositories
+ * @return array of repository names
*/
public String[] repositories() {
return this.repositories;
diff --git a/server/src/main/java/org/opensearch/action/admin/cluster/snapshots/create/CreateSnapshotRequest.java b/server/src/main/java/org/opensearch/action/admin/cluster/snapshots/create/CreateSnapshotRequest.java
index 9f8fc6067f405..0cfc24994768a 100644
--- a/server/src/main/java/org/opensearch/action/admin/cluster/snapshots/create/CreateSnapshotRequest.java
+++ b/server/src/main/java/org/opensearch/action/admin/cluster/snapshots/create/CreateSnapshotRequest.java
@@ -261,7 +261,7 @@ public CreateSnapshotRequest indices(List
indices) {
/**
* Returns a list of indices that should be included into the snapshot
*
- * @return list of indices
+ * @return array of index names
*/
@Override
public String[] indices() {
@@ -316,7 +316,7 @@ public CreateSnapshotRequest partial(boolean partial) {
/**
* If set to true the operation should wait for the snapshot completion before returning.
- *
+ *
* By default, the operation will return as soon as snapshot is initialized. It can be changed by setting this
* flag to true.
*
diff --git a/server/src/main/java/org/opensearch/action/admin/cluster/snapshots/restore/RestoreSnapshotRequest.java b/server/src/main/java/org/opensearch/action/admin/cluster/snapshots/restore/RestoreSnapshotRequest.java
index 256850da0d503..c688b13ed9fdd 100644
--- a/server/src/main/java/org/opensearch/action/admin/cluster/snapshots/restore/RestoreSnapshotRequest.java
+++ b/server/src/main/java/org/opensearch/action/admin/cluster/snapshots/restore/RestoreSnapshotRequest.java
@@ -497,7 +497,7 @@ public Settings indexSettings() {
* this is the snapshot that this request restores. If the client can only identify a snapshot by its name then there is a risk that the
* desired snapshot may be deleted and replaced by a new snapshot with the same name which is inconsistent with the original one. This
* method lets us fail the restore if the precise snapshot we want is not available.
- *
+ *
* This is for internal use only and is not exposed in the REST layer.
*/
public RestoreSnapshotRequest snapshotUuid(String snapshotUuid) {
diff --git a/server/src/main/java/org/opensearch/action/admin/indices/alias/get/BaseAliasesRequestBuilder.java b/server/src/main/java/org/opensearch/action/admin/indices/alias/get/BaseAliasesRequestBuilder.java
index 7cda041b7d9cf..814a65e2a5bf0 100644
--- a/server/src/main/java/org/opensearch/action/admin/indices/alias/get/BaseAliasesRequestBuilder.java
+++ b/server/src/main/java/org/opensearch/action/admin/indices/alias/get/BaseAliasesRequestBuilder.java
@@ -81,7 +81,7 @@ public Builder addIndices(String... indices) {
/**
* Specifies what type of requested indices to ignore and wildcard indices expressions.
- *
+ *
* For example indices that don't exist.
*/
@SuppressWarnings("unchecked")
diff --git a/server/src/main/java/org/opensearch/action/admin/indices/create/CreateIndexRequest.java b/server/src/main/java/org/opensearch/action/admin/indices/create/CreateIndexRequest.java
index 7cda0c1948d24..d048a3008f588 100644
--- a/server/src/main/java/org/opensearch/action/admin/indices/create/CreateIndexRequest.java
+++ b/server/src/main/java/org/opensearch/action/admin/indices/create/CreateIndexRequest.java
@@ -243,7 +243,7 @@ public CreateIndexRequest settings(Map source) {
/**
* Set the mapping for this index
- *
+ *
* The mapping should be in the form of a JSON string, with an outer _doc key
*
* .mapping("{\"_doc\":{\"properties\": ... }}")
@@ -269,7 +269,7 @@ public CreateIndexRequest mapping(String source, XContentType xContentType) {
/**
* Adds mapping that will be added when the index gets created.
- *
+ *
* Note that the definition should *not* be nested under a type name.
*
* @param source The mapping source
@@ -296,7 +296,7 @@ private CreateIndexRequest mapping(BytesReference source, XContentType xContentT
/**
* Adds mapping that will be added when the index gets created.
- *
+ *
* Note that the definition should *not* be nested under a type name.
*
* @param source The mapping source
@@ -432,7 +432,7 @@ public CreateIndexRequest source(String source, XContentType xContentType) {
/**
* Sets the settings and mappings as a single source.
- *
+ *
* Note that the mapping definition should *not* be nested under a type name.
*/
public CreateIndexRequest source(String source, MediaType mediaType) {
@@ -458,7 +458,7 @@ public CreateIndexRequest source(byte[] source, XContentType xContentType) {
/**
* Sets the settings and mappings as a single source.
- *
+ *
* Note that the mapping definition should *not* be nested under a type name.
*/
public CreateIndexRequest source(byte[] source, MediaType mediaType) {
diff --git a/server/src/main/java/org/opensearch/action/admin/indices/dangling/list/ListDanglingIndicesResponse.java b/server/src/main/java/org/opensearch/action/admin/indices/dangling/list/ListDanglingIndicesResponse.java
index 0cff01af536dc..384ae2e028bba 100644
--- a/server/src/main/java/org/opensearch/action/admin/indices/dangling/list/ListDanglingIndicesResponse.java
+++ b/server/src/main/java/org/opensearch/action/admin/indices/dangling/list/ListDanglingIndicesResponse.java
@@ -130,7 +130,7 @@ protected void writeNodesTo(StreamOutput out, List
* NOTE: visible for testing
*
* @opensearch.internal
diff --git a/server/src/main/java/org/opensearch/action/admin/indices/mapping/get/GetFieldMappingsRequest.java b/server/src/main/java/org/opensearch/action/admin/indices/mapping/get/GetFieldMappingsRequest.java
index e3c812aedcfe7..6a1d04efa9714 100644
--- a/server/src/main/java/org/opensearch/action/admin/indices/mapping/get/GetFieldMappingsRequest.java
+++ b/server/src/main/java/org/opensearch/action/admin/indices/mapping/get/GetFieldMappingsRequest.java
@@ -46,7 +46,7 @@
/**
* Request the mappings of specific fields
- *
+ *
* Note: there is a new class with the same name for the Java HLRC that uses a typeless format.
* Any changes done to this class should go to that client class as well.
*
diff --git a/server/src/main/java/org/opensearch/action/admin/indices/mapping/get/GetFieldMappingsResponse.java b/server/src/main/java/org/opensearch/action/admin/indices/mapping/get/GetFieldMappingsResponse.java
index d874b5bb6b1ac..94c88e30295a8 100644
--- a/server/src/main/java/org/opensearch/action/admin/indices/mapping/get/GetFieldMappingsResponse.java
+++ b/server/src/main/java/org/opensearch/action/admin/indices/mapping/get/GetFieldMappingsResponse.java
@@ -61,7 +61,7 @@
/**
* Response object for {@link GetFieldMappingsRequest} API
- *
+ *
* Note: there is a new class with the same name for the Java HLRC that uses a typeless format.
* Any changes done to this class should go to that client class as well.
*
diff --git a/server/src/main/java/org/opensearch/action/admin/indices/mapping/put/PutMappingRequest.java b/server/src/main/java/org/opensearch/action/admin/indices/mapping/put/PutMappingRequest.java
index 4a2d2fbe8e950..32f751ceb1c5a 100644
--- a/server/src/main/java/org/opensearch/action/admin/indices/mapping/put/PutMappingRequest.java
+++ b/server/src/main/java/org/opensearch/action/admin/indices/mapping/put/PutMappingRequest.java
@@ -210,7 +210,7 @@ public String source() {
/**
* A specialized simplified mapping source method, takes the form of simple properties definition:
* ("field1", "type=string,store=true").
- *
+ *
* Also supports metadata mapping fields such as `_all` and `_parent` as property definition, these metadata
* mapping fields will automatically be put on the top level mapping object.
*/
diff --git a/server/src/main/java/org/opensearch/action/admin/indices/replication/SegmentReplicationStatsRequest.java b/server/src/main/java/org/opensearch/action/admin/indices/replication/SegmentReplicationStatsRequest.java
index c46940fbfecf9..b82b68f6f9489 100644
--- a/server/src/main/java/org/opensearch/action/admin/indices/replication/SegmentReplicationStatsRequest.java
+++ b/server/src/main/java/org/opensearch/action/admin/indices/replication/SegmentReplicationStatsRequest.java
@@ -89,7 +89,7 @@ public void activeOnly(boolean activeOnly) {
/**
* Contains list of shard id's if shards are passed, empty otherwise. Array is empty by default.
*
- * @return list of shard id's if shards are passed, empty otherwise
+ * @return array of shard id's if shards are passed, empty otherwise
*/
public String[] shards() {
return shards;
diff --git a/server/src/main/java/org/opensearch/action/admin/indices/rollover/RolloverRequest.java b/server/src/main/java/org/opensearch/action/admin/indices/rollover/RolloverRequest.java
index b25bc94a5c8e2..353cdbbbc840c 100644
--- a/server/src/main/java/org/opensearch/action/admin/indices/rollover/RolloverRequest.java
+++ b/server/src/main/java/org/opensearch/action/admin/indices/rollover/RolloverRequest.java
@@ -54,7 +54,7 @@
/**
* Request class to swap index under an alias or increment data stream generation upon satisfying conditions
- *
+ *
* Note: there is a new class with the same name for the Java HLRC that uses a typeless format.
* Any changes done to this class should also go to that client class.
*
diff --git a/server/src/main/java/org/opensearch/action/admin/indices/rollover/RolloverResponse.java b/server/src/main/java/org/opensearch/action/admin/indices/rollover/RolloverResponse.java
index 55ee65d0a4973..a66fcc9e9bcf2 100644
--- a/server/src/main/java/org/opensearch/action/admin/indices/rollover/RolloverResponse.java
+++ b/server/src/main/java/org/opensearch/action/admin/indices/rollover/RolloverResponse.java
@@ -51,7 +51,7 @@
/**
* Response object for {@link RolloverRequest} API
- *
+ *
* Note: there is a new class with the same name for the Java HLRC that uses a typeless format.
* Any changes done to this class should also go to that client class.
*
diff --git a/server/src/main/java/org/opensearch/action/bulk/BackoffPolicy.java b/server/src/main/java/org/opensearch/action/bulk/BackoffPolicy.java
index 0d6d122e31261..25a2c081f8441 100644
--- a/server/src/main/java/org/opensearch/action/bulk/BackoffPolicy.java
+++ b/server/src/main/java/org/opensearch/action/bulk/BackoffPolicy.java
@@ -40,9 +40,9 @@
/**
* Provides a backoff policy for bulk requests. Whenever a bulk request is rejected due to resource constraints (i.e. the client's internal
* thread pool is full), the backoff policy decides how long the bulk processor will wait before the operation is retried internally.
- *
+ *
* Notes for implementing custom subclasses:
- *
+ *
* The underlying mathematical principle of BackoffPolicy are progressions which can be either finite or infinite although
* the latter should not be used for retrying. A progression can be mapped to a java.util.Iterator with the following
* semantics:
@@ -241,7 +241,7 @@ private static class ExponentialEqualJitterBackoffIterator implements Iterator
* NOTE: If the value is greater than 30, there can be integer overflow
* issues during delay calculation.
**/
diff --git a/server/src/main/java/org/opensearch/action/bulk/BulkItemResponse.java b/server/src/main/java/org/opensearch/action/bulk/BulkItemResponse.java
index 138f21f1f80e5..20dea872e0ad2 100644
--- a/server/src/main/java/org/opensearch/action/bulk/BulkItemResponse.java
+++ b/server/src/main/java/org/opensearch/action/bulk/BulkItemResponse.java
@@ -209,7 +209,7 @@ public static class Failure implements Writeable, ToXContentFragment {
/**
* For write failures before operation was assigned a sequence number.
- *
+ *
* use @{link {@link #Failure(String, String, Exception, long, long)}}
* to record operation sequence no with failure
*/
diff --git a/server/src/main/java/org/opensearch/action/bulk/BulkProcessor.java b/server/src/main/java/org/opensearch/action/bulk/BulkProcessor.java
index baf64b3e80af6..141ec24fc390f 100644
--- a/server/src/main/java/org/opensearch/action/bulk/BulkProcessor.java
+++ b/server/src/main/java/org/opensearch/action/bulk/BulkProcessor.java
@@ -185,7 +185,7 @@ public Builder setGlobalPipeline(String globalPipeline) {
/**
* Sets a custom backoff policy. The backoff policy defines how the bulk processor should handle retries of bulk requests internally
* in case they have failed due to resource constraints (i.e. a thread pool was full).
- *
+ *
* The default is to back off exponentially.
*
* @see org.opensearch.action.bulk.BackoffPolicy#exponentialBackoff()
diff --git a/server/src/main/java/org/opensearch/action/bulk/BulkRequest.java b/server/src/main/java/org/opensearch/action/bulk/BulkRequest.java
index 65043da6c2684..f2f3077001a13 100644
--- a/server/src/main/java/org/opensearch/action/bulk/BulkRequest.java
+++ b/server/src/main/java/org/opensearch/action/bulk/BulkRequest.java
@@ -67,7 +67,7 @@
/**
* A bulk request holds an ordered {@link IndexRequest}s, {@link DeleteRequest}s and {@link UpdateRequest}s
* and allows to executes it in a single batch.
- *
+ *
* Note that we only support refresh on the bulk request not per item.
* @see org.opensearch.client.Client#bulk(BulkRequest)
*
@@ -123,7 +123,7 @@ public BulkRequest add(DocWriteRequest... requests) {
/**
* Add a request to the current BulkRequest.
- *
+ *
* Note for internal callers: This method does not respect all global parameters.
* Only the global index is applied to the request objects.
* Global parameters would be respected if the request was serialized for a REST call as it is
@@ -347,7 +347,7 @@ public final BulkRequest timeout(TimeValue timeout) {
/**
* Note for internal callers (NOT high level rest client),
* the global parameter setting is ignored when used with:
- *
+ *
* - {@link BulkRequest#add(IndexRequest)}
* - {@link BulkRequest#add(UpdateRequest)}
* - {@link BulkRequest#add(DocWriteRequest)}
@@ -364,7 +364,7 @@ public final BulkRequest pipeline(String globalPipeline) {
/**
* Note for internal callers (NOT high level rest client),
* the global parameter setting is ignored when used with:
- *
+ *
- {@link BulkRequest#add(IndexRequest)}
- {@link BulkRequest#add(UpdateRequest)}
- {@link BulkRequest#add(DocWriteRequest)}
@@ -404,7 +404,7 @@ public Boolean requireAlias() {
/**
* Note for internal callers (NOT high level rest client),
* the global parameter setting is ignored when used with:
- *
+ *
* - {@link BulkRequest#add(IndexRequest)}
* - {@link BulkRequest#add(UpdateRequest)}
* - {@link BulkRequest#add(DocWriteRequest)}
diff --git a/server/src/main/java/org/opensearch/action/delete/DeleteRequest.java b/server/src/main/java/org/opensearch/action/delete/DeleteRequest.java
index 81ae3d78e8ced..9a9e861ad8055 100644
--- a/server/src/main/java/org/opensearch/action/delete/DeleteRequest.java
+++ b/server/src/main/java/org/opensearch/action/delete/DeleteRequest.java
@@ -205,7 +205,7 @@ public long ifSeqNo() {
/**
* If set, only perform this delete request if the document was last modification was assigned this primary term.
- *
+ *
* If the document last modification was assigned a different term a
* {@link org.opensearch.index.engine.VersionConflictEngineException} will be thrown.
*/
diff --git a/server/src/main/java/org/opensearch/action/delete/TransportDeleteAction.java b/server/src/main/java/org/opensearch/action/delete/TransportDeleteAction.java
index 039214459ac21..6cbabfec6d763 100644
--- a/server/src/main/java/org/opensearch/action/delete/TransportDeleteAction.java
+++ b/server/src/main/java/org/opensearch/action/delete/TransportDeleteAction.java
@@ -40,7 +40,7 @@
/**
* Performs the delete operation.
- *
+ *
* Deprecated use TransportBulkAction with a single item instead
*
* @opensearch.internal
diff --git a/server/src/main/java/org/opensearch/action/index/IndexRequest.java b/server/src/main/java/org/opensearch/action/index/IndexRequest.java
index d0b78cfd49d4b..c7926e65cf792 100644
--- a/server/src/main/java/org/opensearch/action/index/IndexRequest.java
+++ b/server/src/main/java/org/opensearch/action/index/IndexRequest.java
@@ -76,14 +76,14 @@
/**
* Index request to index a typed JSON document into a specific index and make it searchable. Best
* created using {@link org.opensearch.client.Requests#indexRequest(String)}.
- *
+ *
* The index requires the {@link #index()}, {@link #id(String)} and
* {@link #source(byte[], MediaType)} to be set.
- *
+ *
* The source (content to index) can be set in its bytes form using ({@link #source(byte[], MediaType)}),
* its string form ({@link #source(String, MediaType)}) or using a {@link XContentBuilder}
* ({@link #source(XContentBuilder)}).
- *
+ *
* If the {@link #id(String)} is not set, it will be automatically generated.
*
* @see IndexResponse
@@ -388,7 +388,7 @@ public IndexRequest source(Map source, MediaType contentType) throws
/**
* Sets the document source to index.
- *
+ *
* Note, its preferable to either set it using {@link #source(XContentBuilder)}
* or using the {@link #source(byte[], MediaType)}.
*/
@@ -591,7 +591,7 @@ public long ifSeqNo() {
/**
* If set, only perform this indexing request if the document was last modification was assigned this primary term.
- *
+ *
* If the document last modification was assigned a different term a
* {@link org.opensearch.index.engine.VersionConflictEngineException} will be thrown.
*/
diff --git a/server/src/main/java/org/opensearch/action/index/TransportIndexAction.java b/server/src/main/java/org/opensearch/action/index/TransportIndexAction.java
index fe4f80bf0c065..ce32840f6751b 100644
--- a/server/src/main/java/org/opensearch/action/index/TransportIndexAction.java
+++ b/server/src/main/java/org/opensearch/action/index/TransportIndexAction.java
@@ -40,7 +40,7 @@
/**
* Performs the index operation.
- *
+ *
* Allows for the following settings:
*
* - autoCreateIndex: When set to {@code true}, will automatically create an index if one does not exists.
diff --git a/server/src/main/java/org/opensearch/action/ingest/IngestActionForwarder.java b/server/src/main/java/org/opensearch/action/ingest/IngestActionForwarder.java
index 9927affbc7442..2821f4fd7fadb 100644
--- a/server/src/main/java/org/opensearch/action/ingest/IngestActionForwarder.java
+++ b/server/src/main/java/org/opensearch/action/ingest/IngestActionForwarder.java
@@ -46,7 +46,7 @@
/**
* A utility for forwarding ingest requests to ingest nodes in a round-robin fashion.
- *
+ *
* TODO: move this into IngestService and make index/bulk actions call that
*
* @opensearch.internal
diff --git a/server/src/main/java/org/opensearch/action/search/CreatePitController.java b/server/src/main/java/org/opensearch/action/search/CreatePitController.java
index 1d11ad2760675..87eb27bdb8255 100644
--- a/server/src/main/java/org/opensearch/action/search/CreatePitController.java
+++ b/server/src/main/java/org/opensearch/action/search/CreatePitController.java
@@ -98,18 +98,18 @@ public void executeCreatePit(
task.getParentTaskId(),
Collections.emptyMap()
);
- /**
- * This is needed for cross cluster functionality to work with PITs and current ccsMinimizeRoundTrips is
- * not supported for point in time
+ /*
+ This is needed for cross cluster functionality to work with PITs and current ccsMinimizeRoundTrips is
+ not supported for point in time
*/
searchRequest.setCcsMinimizeRoundtrips(false);
- /**
- * Phase 1 of create PIT
+ /*
+ Phase 1 of create PIT
*/
executeCreatePit(searchTask, searchRequest, createPitListener);
- /**
- * Phase 2 of create PIT where we update pit id in pit contexts
+ /*
+ Phase 2 of create PIT where we update pit id in pit contexts
*/
createPitListener.whenComplete(
searchResponse -> { executeUpdatePitId(request, searchRequest, searchResponse, updatePitIdListener); },
@@ -167,9 +167,9 @@ void executeUpdatePitId(
searchResponse.pointInTimeId()
)
);
- /**
- * store the create time ( same create time for all PIT contexts across shards ) to be used
- * for list PIT api
+ /*
+ store the create time ( same create time for all PIT contexts across shards ) to be used
+ for list PIT api
*/
final long relativeStartNanos = System.nanoTime();
final TransportSearchAction.SearchTimeProvider timeProvider = new TransportSearchAction.SearchTimeProvider(
diff --git a/server/src/main/java/org/opensearch/action/search/SearchPhaseController.java b/server/src/main/java/org/opensearch/action/search/SearchPhaseController.java
index cca85f92d2676..161a103cdf36a 100644
--- a/server/src/main/java/org/opensearch/action/search/SearchPhaseController.java
+++ b/server/src/main/java/org/opensearch/action/search/SearchPhaseController.java
@@ -162,7 +162,7 @@ public AggregatedDfs aggregateDfs(Collection results) {
* Returns a score doc array of top N search docs across all shards, followed by top suggest docs for each
* named completion suggestion across all shards. If more than one named completion suggestion is specified in the
* request, the suggest docs for a named suggestion are ordered by the suggestion name.
- *
+ *
* Note: The order of the sorted score docs depends on the shard index in the result array if the merge process needs to disambiguate
* the result. In oder to obtain stable results the shard index (index of the result in the result array) must be the same.
*
@@ -284,7 +284,7 @@ public List[] fillDocIdsToLoad(int numShards, ScoreDoc[] shardDocs) {
/**
* Enriches search hits and completion suggestion hits from sortedDocs using fetchResultsArr,
* merges suggestions, aggregations and profile results
- *
+ *
* Expects sortedDocs to have top search docs across all shards, optionally followed by top suggest docs for each named
* completion suggestion ordered by suggestion name
*/
diff --git a/server/src/main/java/org/opensearch/action/search/SearchRequest.java b/server/src/main/java/org/opensearch/action/search/SearchRequest.java
index 762022460ebdb..21cf0ed97b9da 100644
--- a/server/src/main/java/org/opensearch/action/search/SearchRequest.java
+++ b/server/src/main/java/org/opensearch/action/search/SearchRequest.java
@@ -600,7 +600,7 @@ public void setMaxConcurrentShardRequests(int maxConcurrentShardRequests) {
* the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for
* instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard
* bounds and the query are disjoint.
- *
+ *
* When unspecified, the pre-filter phase is executed if any of these conditions is met:
*
* - The request targets more than 128 shards
@@ -621,7 +621,7 @@ public void setPreFilterShardSize(int preFilterShardSize) {
* This filter roundtrip can limit the number of shards significantly if for
* instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard
* bounds and the query are disjoint.
- *
+ *
* When unspecified, the pre-filter phase is executed if any of these conditions is met:
*
* - The request targets more than 128 shards
diff --git a/server/src/main/java/org/opensearch/action/search/SearchRequestBuilder.java b/server/src/main/java/org/opensearch/action/search/SearchRequestBuilder.java
index 861e1df0203d7..bc43b65e5d844 100644
--- a/server/src/main/java/org/opensearch/action/search/SearchRequestBuilder.java
+++ b/server/src/main/java/org/opensearch/action/search/SearchRequestBuilder.java
@@ -605,7 +605,7 @@ public SearchRequestBuilder setMaxConcurrentShardRequests(int maxConcurrentShard
* the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for
* instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard
* bounds and the query are disjoint.
- *
+ *
* When unspecified, the pre-filter phase is executed if any of these conditions is met:
*
* - The request targets more than 128 shards
diff --git a/server/src/main/java/org/opensearch/action/search/SearchResponseSections.java b/server/src/main/java/org/opensearch/action/search/SearchResponseSections.java
index 2e447abd125c5..579a01f0dd932 100644
--- a/server/src/main/java/org/opensearch/action/search/SearchResponseSections.java
+++ b/server/src/main/java/org/opensearch/action/search/SearchResponseSections.java
@@ -53,7 +53,7 @@
/**
* Base class that holds the various sections which a search response is
* composed of (hits, aggs, suggestions etc.) and allows to retrieve them.
- *
+ *
* The reason why this class exists is that the high level REST client uses its own classes
* to parse aggregations into, which are not serializable. This is the common part that can be
* shared between core and client.
diff --git a/server/src/main/java/org/opensearch/action/search/TransportDeletePitAction.java b/server/src/main/java/org/opensearch/action/search/TransportDeletePitAction.java
index 614d576324026..b15a4b66e8870 100644
--- a/server/src/main/java/org/opensearch/action/search/TransportDeletePitAction.java
+++ b/server/src/main/java/org/opensearch/action/search/TransportDeletePitAction.java
@@ -76,7 +76,7 @@ private void deletePits(ActionListener listener, DeletePitReq
/**
* Delete all active PIT reader contexts leveraging list all PITs
- *
+ *
* For Cross cluster PITs :
* - mixed cluster PITs ( PIT comprising local and remote ) will be fully deleted. Since there will atleast be
* one reader context with PIT ID present in local cluster, 'Get all PITs' will retrieve the PIT ID with which
diff --git a/server/src/main/java/org/opensearch/action/support/TransportAction.java b/server/src/main/java/org/opensearch/action/support/TransportAction.java
index daa11c2d7d80f..72aae210d61ae 100644
--- a/server/src/main/java/org/opensearch/action/support/TransportAction.java
+++ b/server/src/main/java/org/opensearch/action/support/TransportAction.java
@@ -81,7 +81,7 @@ private Releasable registerChildNode(TaskId parentTask) {
/**
* Use this method when the transport action call should result in creation of a new task associated with the call.
- *
+ *
* This is a typical behavior.
*/
public final Task execute(Request request, ActionListener listener) {
diff --git a/server/src/main/java/org/opensearch/action/support/nodes/BaseNodesRequest.java b/server/src/main/java/org/opensearch/action/support/nodes/BaseNodesRequest.java
index f5fb41dc5bae3..4d54ce51c923c 100644
--- a/server/src/main/java/org/opensearch/action/support/nodes/BaseNodesRequest.java
+++ b/server/src/main/java/org/opensearch/action/support/nodes/BaseNodesRequest.java
@@ -53,9 +53,9 @@ public abstract class BaseNodesRequest
* the list of nodesIds that will be used to resolve this request and {@link #concreteNodes}
* will be populated. Note that if {@link #concreteNodes} is not null, it will be used and nodeIds
* will be ignored.
- *
+ *
* See {@link DiscoveryNodes#resolveNodes} for a full description of the options.
- *
+ *
* TODO: get rid of this and resolve it to concrete nodes in the rest layer
**/
private String[] nodesIds;
diff --git a/server/src/main/java/org/opensearch/action/support/replication/ReplicationOperation.java b/server/src/main/java/org/opensearch/action/support/replication/ReplicationOperation.java
index 60c490a50575a..9f69d41d83f5b 100644
--- a/server/src/main/java/org/opensearch/action/support/replication/ReplicationOperation.java
+++ b/server/src/main/java/org/opensearch/action/support/replication/ReplicationOperation.java
@@ -479,7 +479,7 @@ public interface Primary<
/**
* Notifies the primary of a local checkpoint for the given allocation.
- *
+ *
* Note: The primary will use this information to advance the global checkpoint if possible.
*
* @param allocationId allocation ID of the shard corresponding to the supplied local checkpoint
diff --git a/server/src/main/java/org/opensearch/action/support/replication/TransportReplicationAction.java b/server/src/main/java/org/opensearch/action/support/replication/TransportReplicationAction.java
index de5a92fdcc4b1..b68bd13cfed80 100644
--- a/server/src/main/java/org/opensearch/action/support/replication/TransportReplicationAction.java
+++ b/server/src/main/java/org/opensearch/action/support/replication/TransportReplicationAction.java
@@ -100,7 +100,7 @@
/**
* Base class for requests that should be executed on a primary copy followed by replica copies.
* Subclasses can resolve the target shard and provide implementation for primary and replica operations.
- *
+ *
* The action samples cluster state on the receiving node to reroute to node with primary copy and on the
* primary node to validate request before primary operation followed by sampling state again for resolving
* nodes with replica copies to perform replication.
@@ -866,7 +866,7 @@ protected IndexShard getIndexShard(final ShardId shardId) {
* Responsible for routing and retrying failed operations on the primary.
* The actual primary operation is done in {@link ReplicationOperation} on the
* node with primary copy.
- *
+ *
* Resolves index and shard id for the request before routing it to target node
*
* @opensearch.internal
diff --git a/server/src/main/java/org/opensearch/action/support/replication/TransportWriteAction.java b/server/src/main/java/org/opensearch/action/support/replication/TransportWriteAction.java
index 62cbfbde9780a..a0b5299805868 100644
--- a/server/src/main/java/org/opensearch/action/support/replication/TransportWriteAction.java
+++ b/server/src/main/java/org/opensearch/action/support/replication/TransportWriteAction.java
@@ -266,7 +266,7 @@ protected abstract void dispatchedShardOperationOnReplica(
/**
* Result of taking the action on the primary.
- *
+ *
* NOTE: public for testing
*
* @opensearch.internal
@@ -496,7 +496,7 @@ void run() {
* A proxy for write operations that need to be performed on the
* replicas, where a failure to execute the operation should fail
* the replica shard and/or mark the replica as stale.
- *
+ *
* This extends {@code TransportReplicationAction.ReplicasProxy} to do the
* failing and stale-ing.
*
diff --git a/server/src/main/java/org/opensearch/action/support/single/shard/SingleShardRequest.java b/server/src/main/java/org/opensearch/action/support/single/shard/SingleShardRequest.java
index c474096ff94e4..56b34aea8248d 100644
--- a/server/src/main/java/org/opensearch/action/support/single/shard/SingleShardRequest.java
+++ b/server/src/main/java/org/opensearch/action/support/single/shard/SingleShardRequest.java
@@ -55,7 +55,7 @@ public abstract class SingleShardRequest
* Whether index property is optional depends on the concrete implementation. If index property is required the
* concrete implementation should use {@link #validateNonNullIndex()} to check if the index property has been set
*/
diff --git a/server/src/main/java/org/opensearch/action/support/tasks/BaseTasksRequest.java b/server/src/main/java/org/opensearch/action/support/tasks/BaseTasksRequest.java
index a10f74f7c2aa8..c2ae333b17055 100644
--- a/server/src/main/java/org/opensearch/action/support/tasks/BaseTasksRequest.java
+++ b/server/src/main/java/org/opensearch/action/support/tasks/BaseTasksRequest.java
@@ -128,7 +128,7 @@ public final Request setNodes(String... nodes) {
/**
* Returns the id of the task that should be processed.
- *
+ *
* By default tasks with any ids are returned.
*/
public TaskId getTaskId() {
diff --git a/server/src/main/java/org/opensearch/action/update/UpdateRequest.java b/server/src/main/java/org/opensearch/action/update/UpdateRequest.java
index b354482871521..946c3c2446173 100644
--- a/server/src/main/java/org/opensearch/action/update/UpdateRequest.java
+++ b/server/src/main/java/org/opensearch/action/update/UpdateRequest.java
@@ -589,7 +589,7 @@ public long ifSeqNo() {
/**
* If set, only perform this update request if the document was last modification was assigned this primary term.
- *
+ *
* If the document last modification was assigned a different term a
* {@link org.opensearch.index.engine.VersionConflictEngineException} will be thrown.
*/
diff --git a/server/src/main/java/org/opensearch/bootstrap/BootstrapChecks.java b/server/src/main/java/org/opensearch/bootstrap/BootstrapChecks.java
index f9661e71d60e6..e43c42446de2c 100644
--- a/server/src/main/java/org/opensearch/bootstrap/BootstrapChecks.java
+++ b/server/src/main/java/org/opensearch/bootstrap/BootstrapChecks.java
@@ -73,7 +73,7 @@
/**
* We enforce bootstrap checks once a node has the transport protocol bound to a non-loopback interface or if the system property {@code
- * opensearch.enforce.bootstrap.checks} is set to {@true}. In this case we assume the node is running in production and
+ * opensearch.enforce.bootstrap.checks} is set to {@code true}. In this case we assume the node is running in production and
* all bootstrap checks must pass.
*
* @opensearch.internal
diff --git a/server/src/main/java/org/opensearch/bootstrap/JNAKernel32Library.java b/server/src/main/java/org/opensearch/bootstrap/JNAKernel32Library.java
index 8e556df4b2f9b..91da34fb7216d 100644
--- a/server/src/main/java/org/opensearch/bootstrap/JNAKernel32Library.java
+++ b/server/src/main/java/org/opensearch/bootstrap/JNAKernel32Library.java
@@ -141,7 +141,7 @@ public boolean callback(long dwCtrlType) {
/**
* Memory protection constraints
- *
+ *
* https://msdn.microsoft.com/en-us/library/windows/desktop/aa366786%28v=vs.85%29.aspx
*/
public static final int PAGE_NOACCESS = 0x0001;
@@ -151,7 +151,7 @@ public boolean callback(long dwCtrlType) {
/**
* Contains information about a range of pages in the virtual address space of a process.
* The VirtualQuery and VirtualQueryEx functions use this structure.
- *
+ *
* https://msdn.microsoft.com/en-us/library/windows/desktop/aa366775%28v=vs.85%29.aspx
*/
public static class MemoryBasicInformation extends Structure {
@@ -186,7 +186,7 @@ public SizeT() {
/**
* Locks the specified region of the process's virtual address space into physical
* memory, ensuring that subsequent access to the region will not incur a page fault.
- *
+ *
* https://msdn.microsoft.com/en-us/library/windows/desktop/aa366895%28v=vs.85%29.aspx
*
* @param address A pointer to the base address of the region of pages to be locked.
@@ -197,7 +197,7 @@ public SizeT() {
/**
* Retrieves information about a range of pages within the virtual address space of a specified process.
- *
+ *
* https://msdn.microsoft.com/en-us/library/windows/desktop/aa366907%28v=vs.85%29.aspx
*
* @param handle A handle to the process whose memory information is queried.
@@ -210,7 +210,7 @@ public SizeT() {
/**
* Sets the minimum and maximum working set sizes for the specified process.
- *
+ *
* https://msdn.microsoft.com/en-us/library/windows/desktop/ms686234%28v=vs.85%29.aspx
*
* @param handle A handle to the process whose working set sizes is to be set.
@@ -222,7 +222,7 @@ public SizeT() {
/**
* Retrieves a pseudo handle for the current process.
- *
+ *
* https://msdn.microsoft.com/en-us/library/windows/desktop/ms683179%28v=vs.85%29.aspx
*
* @return a pseudo handle to the current process.
@@ -231,7 +231,7 @@ public SizeT() {
/**
* Closes an open object handle.
- *
+ *
* https://msdn.microsoft.com/en-us/library/windows/desktop/ms724211%28v=vs.85%29.aspx
*
* @param handle A valid handle to an open object.
@@ -252,7 +252,7 @@ public SizeT() {
/**
* Creates or opens a new job object
- *
+ *
* https://msdn.microsoft.com/en-us/library/windows/desktop/ms682409%28v=vs.85%29.aspx
*
* @param jobAttributes security attributes
@@ -263,7 +263,7 @@ public SizeT() {
/**
* Associates a process with an existing job
- *
+ *
* https://msdn.microsoft.com/en-us/library/windows/desktop/ms681949%28v=vs.85%29.aspx
*
* @param job job handle
@@ -274,7 +274,7 @@ public SizeT() {
/**
* Basic limit information for a job object
- *
+ *
* https://msdn.microsoft.com/en-us/library/windows/desktop/ms684147%28v=vs.85%29.aspx
*/
public static class JOBOBJECT_BASIC_LIMIT_INFORMATION extends Structure implements Structure.ByReference {
@@ -316,7 +316,7 @@ protected List getFieldOrder() {
/**
* Get job limit and state information
- *
+ *
* https://msdn.microsoft.com/en-us/library/windows/desktop/ms684925%28v=vs.85%29.aspx
*
* @param job job handle
@@ -330,7 +330,7 @@ protected List getFieldOrder() {
/**
* Set job limit and state information
- *
+ *
* https://msdn.microsoft.com/en-us/library/windows/desktop/ms686216%28v=vs.85%29.aspx
*
* @param job job handle
diff --git a/server/src/main/java/org/opensearch/bootstrap/OpenSearch.java b/server/src/main/java/org/opensearch/bootstrap/OpenSearch.java
index ab52ae5a43a2a..4d36efff0e192 100644
--- a/server/src/main/java/org/opensearch/bootstrap/OpenSearch.java
+++ b/server/src/main/java/org/opensearch/bootstrap/OpenSearch.java
@@ -188,9 +188,9 @@ void init(final boolean daemonize, final Path pidFile, final boolean quiet, Envi
/**
* Required method that's called by Apache Commons procrun when
* running as a service on Windows, when the service is stopped.
- *
+ *
* http://commons.apache.org/proper/commons-daemon/procrun.html
- *
+ *
* NOTE: If this method is renamed and/or moved, make sure to
* update opensearch-service.bat!
*/
diff --git a/server/src/main/java/org/opensearch/cluster/AckedClusterStateTaskListener.java b/server/src/main/java/org/opensearch/cluster/AckedClusterStateTaskListener.java
index 482087be1c8eb..28e1e7c53cb9c 100644
--- a/server/src/main/java/org/opensearch/cluster/AckedClusterStateTaskListener.java
+++ b/server/src/main/java/org/opensearch/cluster/AckedClusterStateTaskListener.java
@@ -44,7 +44,7 @@ public interface AckedClusterStateTaskListener extends ClusterStateTaskListener
/**
* Called to determine which nodes the acknowledgement is expected from.
- *
+ *
* As this method will be called multiple times to determine the set of acking nodes,
* it is crucial for it to return consistent results: Given the same listener instance
* and the same node parameter, the method implementation should return the same result.
diff --git a/server/src/main/java/org/opensearch/cluster/ClusterStateTaskExecutor.java b/server/src/main/java/org/opensearch/cluster/ClusterStateTaskExecutor.java
index 50beeb1f03deb..bf8494cc36857 100644
--- a/server/src/main/java/org/opensearch/cluster/ClusterStateTaskExecutor.java
+++ b/server/src/main/java/org/opensearch/cluster/ClusterStateTaskExecutor.java
@@ -70,7 +70,7 @@ default boolean runOnlyOnMaster() {
/**
* Callback invoked after new cluster state is published. Note that
* this method is not invoked if the cluster state was not updated.
- *
+ *
* Note that this method will be executed using system context.
*
* @param clusterChangedEvent the change event for this cluster state change, containing
@@ -80,7 +80,7 @@ default void clusterStatePublished(ClusterChangedEvent clusterChangedEvent) {}
/**
* Builds a concise description of a list of tasks (to be used in logging etc.).
- *
+ *
* Note that the tasks given are not necessarily the same as those that will be passed to {@link #execute(ClusterState, List)}.
* but are guaranteed to be a subset of them. This method can be called multiple times with different lists before execution.
* This allows groupd task description but the submitting source.
diff --git a/server/src/main/java/org/opensearch/cluster/DiffableUtils.java b/server/src/main/java/org/opensearch/cluster/DiffableUtils.java
index dd2232968114e..a38fc81bebc08 100644
--- a/server/src/main/java/org/opensearch/cluster/DiffableUtils.java
+++ b/server/src/main/java/org/opensearch/cluster/DiffableUtils.java
@@ -182,7 +182,7 @@ public Map apply(Map map) {
/**
* Represents differences between two maps of objects and is used as base class for different map implementations.
- *
+ *
* Implements serialization. How differences are applied is left to subclasses.
*
* @param the type of map keys
@@ -381,9 +381,9 @@ public Integer readKey(StreamInput in) throws IOException {
/**
* Provides read and write operations to serialize map values.
* Reading of values can be made dependent on map key.
- *
+ *
* Also provides operations to distinguish whether map values are diffable.
- *
+ *
* Should not be directly implemented, instead implement either
* {@link DiffableValueSerializer} or {@link NonDiffableValueSerializer}.
*
@@ -517,7 +517,7 @@ public Diff readDiff(StreamInput in, K key) throws IOException {
/**
* Implementation of the ValueSerializer that wraps value and diff readers.
- *
+ *
* Note: this implementation is ignoring the key.
*
* @opensearch.internal
diff --git a/server/src/main/java/org/opensearch/cluster/InternalClusterInfoService.java b/server/src/main/java/org/opensearch/cluster/InternalClusterInfoService.java
index 35490d2f37a49..e381b8f244bf3 100644
--- a/server/src/main/java/org/opensearch/cluster/InternalClusterInfoService.java
+++ b/server/src/main/java/org/opensearch/cluster/InternalClusterInfoService.java
@@ -82,7 +82,7 @@
* to 30 seconds). The InternalClusterInfoService only runs on the cluster-manager node.
* Listens for changes in the number of data nodes and immediately submits a
* ClusterInfoUpdateJob if a node has been added.
- *
+ *
* Every time the timer runs, gathers information about the disk usage and
* shard sizes across the cluster.
*
diff --git a/server/src/main/java/org/opensearch/cluster/RestoreInProgress.java b/server/src/main/java/org/opensearch/cluster/RestoreInProgress.java
index 042a4743ca25d..3e0c78099e6b4 100644
--- a/server/src/main/java/org/opensearch/cluster/RestoreInProgress.java
+++ b/server/src/main/java/org/opensearch/cluster/RestoreInProgress.java
@@ -189,7 +189,7 @@ public Snapshot snapshot() {
/**
* Returns list of shards that being restore and their status
*
- * @return list of shards
+ * @return map of shard id to shard restore status
*/
public Map shards() {
return this.shards;
diff --git a/server/src/main/java/org/opensearch/cluster/coordination/ClusterStatePublisher.java b/server/src/main/java/org/opensearch/cluster/coordination/ClusterStatePublisher.java
index 39d05e672f977..3a506397bcac8 100644
--- a/server/src/main/java/org/opensearch/cluster/coordination/ClusterStatePublisher.java
+++ b/server/src/main/java/org/opensearch/cluster/coordination/ClusterStatePublisher.java
@@ -46,11 +46,11 @@ public interface ClusterStatePublisher {
/**
* Publish all the changes to the cluster from the cluster-manager (can be called just by the cluster-manager). The publish
* process should apply this state to the cluster-manager as well!
- *
+ *
* The publishListener allows to wait for the publication to complete, which can be either successful completion, timing out or failing.
* The method is guaranteed to pass back a {@link FailedToCommitClusterStateException} to the publishListener if the change is not
* committed and should be rejected. Any other exception signals that something bad happened but the change is committed.
- *
+ *
* The {@link AckListener} allows to keep track of the ack received from nodes, and verify whether
* they updated their own cluster state or not.
*/
diff --git a/server/src/main/java/org/opensearch/cluster/coordination/JoinTaskExecutor.java b/server/src/main/java/org/opensearch/cluster/coordination/JoinTaskExecutor.java
index 15eaf9c8bcc1e..f701a2f52277d 100644
--- a/server/src/main/java/org/opensearch/cluster/coordination/JoinTaskExecutor.java
+++ b/server/src/main/java/org/opensearch/cluster/coordination/JoinTaskExecutor.java
@@ -483,10 +483,10 @@ public static void ensureNodeCommissioned(DiscoveryNode node, Metadata metadata)
* 2. The joining node has to be a non-remote store backed if it is joining a non-remote store backed cluster.
* Validates no remote store attributes are present in joining node as existing nodes in the cluster doesn't have
* remote store attributes.
- *
+ *
* A remote store backed node is the one which holds all the remote store attributes and a remote store backed
* cluster is the one which has only homogeneous remote store backed nodes with same node attributes
- *
+ *
* TODO: When we support moving from remote store cluster to non remote store and vice versa the this logic will
* needs to be modified.
*/
diff --git a/server/src/main/java/org/opensearch/cluster/coordination/Reconfigurator.java b/server/src/main/java/org/opensearch/cluster/coordination/Reconfigurator.java
index 1570a84ab871f..128bd42fd7947 100644
--- a/server/src/main/java/org/opensearch/cluster/coordination/Reconfigurator.java
+++ b/server/src/main/java/org/opensearch/cluster/coordination/Reconfigurator.java
@@ -63,7 +63,7 @@ public class Reconfigurator {
* and still the cluster would be unavailable. However not reducing the voting configuration size can also hamper resilience: in a
* five-node cluster we could lose two nodes and by reducing the voting configuration to the remaining three nodes we could tolerate the
* loss of a further node before failing.
- *
+ *
* We offer two options: either we auto-shrink the voting configuration as long as it contains more than three nodes, or we don't and we
* require the user to control the voting configuration manually using the retirement API. The former, default, option, guarantees that
* as long as there have been at least three cluster-manager-eligible nodes in the cluster and no more than one of them is currently unavailable,
diff --git a/server/src/main/java/org/opensearch/cluster/health/ClusterShardHealth.java b/server/src/main/java/org/opensearch/cluster/health/ClusterShardHealth.java
index d06e89d9ea170..cbc63565228f9 100644
--- a/server/src/main/java/org/opensearch/cluster/health/ClusterShardHealth.java
+++ b/server/src/main/java/org/opensearch/cluster/health/ClusterShardHealth.java
@@ -219,13 +219,13 @@ public void writeTo(final StreamOutput out) throws IOException {
/**
* Checks if an inactive primary shard should cause the cluster health to go RED.
- *
+ *
* An inactive primary shard in an index should cause the cluster health to be RED to make it visible that some of the existing data is
* unavailable. In case of index creation, snapshot restore or index shrinking, which are unexceptional events in the cluster lifecycle,
* cluster health should not turn RED for the time where primaries are still in the initializing state but go to YELLOW instead.
* However, in case of exceptional events, for example when the primary shard cannot be assigned to a node or initialization fails at
* some point, cluster health should still turn RED.
- *
+ *
* NB: this method should *not* be called on active shards nor on non-primary shards.
*/
public static ClusterHealthStatus getInactivePrimaryHealth(final ShardRouting shardRouting) {
diff --git a/server/src/main/java/org/opensearch/cluster/metadata/IndexGraveyard.java b/server/src/main/java/org/opensearch/cluster/metadata/IndexGraveyard.java
index 0da948dc78c5d..85a203e5e059a 100644
--- a/server/src/main/java/org/opensearch/cluster/metadata/IndexGraveyard.java
+++ b/server/src/main/java/org/opensearch/cluster/metadata/IndexGraveyard.java
@@ -61,7 +61,7 @@
/**
* A collection of tombstones for explicitly marking indices as deleted in the cluster state.
- *
+ *
* The cluster state contains a list of index tombstones for indices that have been
* deleted in the cluster. Because cluster states are processed asynchronously by
* nodes and a node could be removed from the cluster for a period of time, the
@@ -250,7 +250,7 @@ public int getNumPurged() {
/**
* Purge tombstone entries. Returns the number of entries that were purged.
- *
+ *
* Tombstones are purged if the number of tombstones in the list
* is greater than the input parameter of maximum allowed tombstones.
* Tombstones are purged until the list is equal to the maximum allowed.
diff --git a/server/src/main/java/org/opensearch/cluster/metadata/IndexMetadata.java b/server/src/main/java/org/opensearch/cluster/metadata/IndexMetadata.java
index 52df72b342b3e..5d8b751b241e2 100644
--- a/server/src/main/java/org/opensearch/cluster/metadata/IndexMetadata.java
+++ b/server/src/main/java/org/opensearch/cluster/metadata/IndexMetadata.java
@@ -779,7 +779,7 @@ public long getAliasesVersion() {
/**
* The term of the current selected primary. This is a non-negative number incremented when
* a primary shard is assigned after a full cluster restart or a replica shard is promoted to a primary.
- *
+ *
* Note: since we increment the term every time a shard is assigned, the term for any operational shard (i.e., a shard
* that can be indexed into) is larger than 0. See {@link IndexMetadataUpdater#applyChanges}.
**/
@@ -1884,7 +1884,7 @@ public static Settings addHumanReadableSettings(Settings settings) {
/**
* Return the version the index was created from the provided index settings
- *
+ *
* This looks for the presence of the {@link Version} object with key {@link IndexMetadata#SETTING_VERSION_CREATED}
*/
public static Version indexCreated(final Settings indexSettings) {
diff --git a/server/src/main/java/org/opensearch/cluster/metadata/IndexTemplateMetadata.java b/server/src/main/java/org/opensearch/cluster/metadata/IndexTemplateMetadata.java
index 272bb132197af..c5efb55316b84 100644
--- a/server/src/main/java/org/opensearch/cluster/metadata/IndexTemplateMetadata.java
+++ b/server/src/main/java/org/opensearch/cluster/metadata/IndexTemplateMetadata.java
@@ -369,7 +369,7 @@ public IndexTemplateMetadata build() {
/**
* Serializes the template to xContent, using the legacy format where the mappings are
* nested under the type name.
- *
+ *
* This method is used for serializing templates before storing them in the cluster metadata,
* and also in the REST layer when returning a deprecated typed response.
*/
@@ -386,7 +386,7 @@ public static void toXContentWithTypes(
/**
* Serializes the template to xContent, making sure not to nest mappings under the
* type name.
- *
+ *
* Note that this method should currently only be used for creating REST responses,
* and not when directly updating stored templates. Index templates are still stored
* in the old, typed format, and have yet to be migrated to be typeless.
diff --git a/server/src/main/java/org/opensearch/cluster/metadata/Metadata.java b/server/src/main/java/org/opensearch/cluster/metadata/Metadata.java
index 146193b8d22c4..626903877b0c6 100644
--- a/server/src/main/java/org/opensearch/cluster/metadata/Metadata.java
+++ b/server/src/main/java/org/opensearch/cluster/metadata/Metadata.java
@@ -1666,7 +1666,7 @@ private SortedMap buildIndicesLookup() {
/**
* Validates there isn't any index with a name that would clash with the future backing indices of the existing data streams.
- *
+ *
* E.g., if data stream `foo` has backing indices [`.ds-foo-000001`, `.ds-foo-000002`] and the indices lookup contains indices
* `.ds-foo-000001`, `.ds-foo-000002` and `.ds-foo-000006` this will throw an IllegalStateException (as attempting to rollover the
* `foo` data stream from generation 5 to 6 will not be possible)
diff --git a/server/src/main/java/org/opensearch/cluster/metadata/MetadataCreateIndexService.java b/server/src/main/java/org/opensearch/cluster/metadata/MetadataCreateIndexService.java
index b2861e566dd4b..8d76a39712ee3 100644
--- a/server/src/main/java/org/opensearch/cluster/metadata/MetadataCreateIndexService.java
+++ b/server/src/main/java/org/opensearch/cluster/metadata/MetadataCreateIndexService.java
@@ -754,7 +754,7 @@ private ClusterState applyCreateIndexRequestWithExistingMetadata(
/**
* Parses the provided mappings json and the inheritable mappings from the templates (if any)
* into a map.
- *
+ *
* The template mappings are applied in the order they are encountered in the list (clients
* should make sure the lower index, closer to the head of the list, templates have the highest
* {@link IndexTemplateMetadata#order()}). This merging makes no distinction between field
@@ -792,7 +792,7 @@ static Map parseV1Mappings(
* Validates and creates the settings for the new index based on the explicitly configured settings via the
* {@link CreateIndexClusterStateUpdateRequest}, inherited from templates and, if recovering from another index (ie. split, shrink,
* clone), the resize settings.
- *
+ *
* The template mappings are applied in the order they are encountered in the list (clients should make sure the lower index, closer
* to the head of the list, templates have the highest {@link IndexTemplateMetadata#order()})
*
@@ -1009,7 +1009,7 @@ static int getIndexNumberOfRoutingShards(Settings indexSettings, @Nullable Index
/**
* Validate and resolve the aliases explicitly set for the index, together with the ones inherited from the specified
* templates.
- *
+ *
* The template mappings are applied in the order they are encountered in the list (clients should make sure the lower index, closer
* to the head of the list, templates have the highest {@link IndexTemplateMetadata#order()})
*
diff --git a/server/src/main/java/org/opensearch/cluster/metadata/MetadataIndexStateService.java b/server/src/main/java/org/opensearch/cluster/metadata/MetadataIndexStateService.java
index 91c996448ea8f..e30e878f1b31a 100644
--- a/server/src/main/java/org/opensearch/cluster/metadata/MetadataIndexStateService.java
+++ b/server/src/main/java/org/opensearch/cluster/metadata/MetadataIndexStateService.java
@@ -166,7 +166,7 @@ public MetadataIndexStateService(
/**
* Closes one or more indices.
- *
+ *
* Closing indices is a 3 steps process: it first adds a write block to every indices to close, then waits for the operations on shards
* to be terminated and finally closes the indices by moving their state to CLOSE.
*/
@@ -302,7 +302,7 @@ public TimeValue timeout() {
/**
* Step 1 - Start closing indices by adding a write block
- *
+ *
* This step builds the list of indices to close (the ones explicitly requested that are not in CLOSE state) and adds a unique cluster
* block (or reuses an existing one) to every index to close in the cluster state. After the cluster state is published, the shards
* should start to reject writing operations and we can proceed with step 2.
diff --git a/server/src/main/java/org/opensearch/cluster/metadata/MetadataIndexTemplateService.java b/server/src/main/java/org/opensearch/cluster/metadata/MetadataIndexTemplateService.java
index 71b86ec853ce4..1093ac09777e7 100644
--- a/server/src/main/java/org/opensearch/cluster/metadata/MetadataIndexTemplateService.java
+++ b/server/src/main/java/org/opensearch/cluster/metadata/MetadataIndexTemplateService.java
@@ -747,7 +747,7 @@ public static Map> findConflictingV2Templates(
/**
* Return a map of v2 template names to their index patterns for v2 templates that would overlap
* with the given template's index patterns.
- *
+ *
* Based on the provided checkPriority and priority parameters this aims to report the overlapping
* index templates regardless of the priority (ie. checkPriority == false) or otherwise overlapping
* templates with the same priority as the given priority parameter (this is useful when trying to
diff --git a/server/src/main/java/org/opensearch/cluster/node/DiscoveryNodes.java b/server/src/main/java/org/opensearch/cluster/node/DiscoveryNodes.java
index 675d4e09e3be0..561f1b727efe0 100644
--- a/server/src/main/java/org/opensearch/cluster/node/DiscoveryNodes.java
+++ b/server/src/main/java/org/opensearch/cluster/node/DiscoveryNodes.java
@@ -356,7 +356,7 @@ public DiscoveryNode findByAddress(TransportAddress address) {
/**
* Returns the version of the node with the oldest version in the cluster that is not a client node
- *
+ *
* If there are no non-client nodes, Version.CURRENT will be returned.
*
* @return the oldest version in the cluster
@@ -367,7 +367,7 @@ public Version getSmallestNonClientNodeVersion() {
/**
* Returns the version of the node with the youngest version in the cluster that is not a client node.
- *
+ *
* If there are no non-client nodes, Version.CURRENT will be returned.
*
* @return the youngest version in the cluster
@@ -417,16 +417,16 @@ public DiscoveryNode resolveNode(String node) {
/**
* Resolves a set of nodes according to the given sequence of node specifications. Implements the logic in various APIs that allow the
* user to run the action on a subset of the nodes in the cluster. See [Node specification] in the reference manual for full details.
- *
+ *
* Works by tracking the current set of nodes and applying each node specification in sequence. The set starts out empty and each node
* specification may either add or remove nodes. For instance:
- *
+ *
* - _local, _cluster_manager (_master) and _all respectively add to the subset the local node, the currently-elected cluster_manager, and all the nodes
* - node IDs, names, hostnames and IP addresses all add to the subset any nodes which match
* - a wildcard-based pattern of the form "attr*:value*" adds to the subset all nodes with a matching attribute with a matching value
* - role:true adds to the subset all nodes with a matching role
* - role:false removes from the subset all nodes with a matching role.
- *
+ *
* An empty sequence of node specifications returns all nodes, since the corresponding actions run on all nodes by default.
*/
public String[] resolveNodes(String... nodes) {
@@ -813,7 +813,7 @@ public Builder localNodeId(String localNodeId) {
* Checks that a node can be safely added to this node collection.
*
* @return null if all is OK or an error message explaining why a node can not be added.
- *
+ *
* Note: if this method returns a non-null value, calling {@link #add(DiscoveryNode)} will fail with an
* exception
*/
diff --git a/server/src/main/java/org/opensearch/cluster/routing/IndexShardRoutingTable.java b/server/src/main/java/org/opensearch/cluster/routing/IndexShardRoutingTable.java
index 9cc09c6e4c31c..2dd57431d0375 100644
--- a/server/src/main/java/org/opensearch/cluster/routing/IndexShardRoutingTable.java
+++ b/server/src/main/java/org/opensearch/cluster/routing/IndexShardRoutingTable.java
@@ -463,7 +463,7 @@ private static Map rankNodes(
* OpenSearch, however, we do not have that sort of broadcast-to-all behavior. In order to prevent a node that gets a high score and
* then never gets any more requests, we must ensure it eventually returns to a more normal score and can be a candidate for serving
* requests.
- *
+ *
* This adjustment takes the "winning" node's statistics and adds the average of those statistics with each non-winning node. Let's say
* the winning node had a queue size of 10 and a non-winning node had a queue of 18. The average queue size is (10 + 18) / 2 = 14 so the
* non-winning node will have statistics added for a queue size of 14. This is repeated for the response time and service times as well.
diff --git a/server/src/main/java/org/opensearch/cluster/routing/RecoverySource.java b/server/src/main/java/org/opensearch/cluster/routing/RecoverySource.java
index 5cef46689ffc7..b01e074ce40c2 100644
--- a/server/src/main/java/org/opensearch/cluster/routing/RecoverySource.java
+++ b/server/src/main/java/org/opensearch/cluster/routing/RecoverySource.java
@@ -49,7 +49,7 @@
/**
* Represents the recovery source of a shard. Available recovery types are:
- *
+ *
* - {@link EmptyStoreRecoverySource} recovery from an empty store
* - {@link ExistingStoreRecoverySource} recovery from an existing store
* - {@link PeerRecoverySource} recovery from a primary on another node
diff --git a/server/src/main/java/org/opensearch/cluster/routing/RoutingNodes.java b/server/src/main/java/org/opensearch/cluster/routing/RoutingNodes.java
index 4f7b935f15f93..5a4352653cc89 100644
--- a/server/src/main/java/org/opensearch/cluster/routing/RoutingNodes.java
+++ b/server/src/main/java/org/opensearch/cluster/routing/RoutingNodes.java
@@ -70,7 +70,7 @@
* {@link RoutingNodes} represents a copy the routing information contained in the {@link ClusterState cluster state}.
* It can be either initialized as mutable or immutable (see {@link #RoutingNodes(ClusterState, boolean)}), allowing
* or disallowing changes to its elements.
- *
+ *
* The main methods used to update routing entries are:
*
* - {@link #initializeShard} initializes an unassigned shard.
@@ -369,7 +369,7 @@ public ShardRouting activePrimary(ShardId shardId) {
/**
* Returns one active replica shard for the given shard id or
null if
* no active replica is found.
- *
+ *
* Since replicas could possibly be on nodes with an older version of OpenSearch than
* the primary is, this will return replicas on the highest version of OpenSearch when document
* replication is enabled.
@@ -395,7 +395,7 @@ public ShardRouting activeReplicaWithHighestVersion(ShardId shardId) {
/**
* Returns one active replica shard for the given shard id or null if
* no active replica is found.
- *
+ *
* Since replicas could possibly be on nodes with a higher version of OpenSearch than
* the primary is, this will return replicas on the oldest version of OpenSearch when segment
* replication is enabled to allow for replica to read segments from primary.
@@ -544,9 +544,9 @@ public Tuple relocateShard(
/**
* Applies the relevant logic to start an initializing shard.
- *
+ *
* Moves the initializing shard to started. If the shard is a relocation target, also removes the relocation source.
- *
+ *
* If the started shard is a primary relocation target, this also reinitializes currently initializing replicas as their
* recovery source changes
*
@@ -605,9 +605,9 @@ public ShardRouting startShard(Logger logger, ShardRouting initializingShard, Ro
/**
* Applies the relevant logic to handle a cancelled or failed shard.
- *
+ *
* Moves the shard to unassigned or completely removes the shard (if relocation target).
- *
+ *
* - If shard is a primary, this also fails initializing replicas.
* - If shard is an active primary, this also promotes an active replica to primary (if such a replica exists).
* - If shard is a relocating primary, this also removes the primary relocation target shard.
diff --git a/server/src/main/java/org/opensearch/cluster/routing/ShardMovementStrategy.java b/server/src/main/java/org/opensearch/cluster/routing/ShardMovementStrategy.java
index cfdeed5c227b6..7f5109416494e 100644
--- a/server/src/main/java/org/opensearch/cluster/routing/ShardMovementStrategy.java
+++ b/server/src/main/java/org/opensearch/cluster/routing/ShardMovementStrategy.java
@@ -14,7 +14,7 @@
/**
* ShardMovementStrategy defines the order in which shard movement occurs.
- *
+ *
* ShardMovementStrategy values or rather their string representation to be used with
* {@link BalancedShardsAllocator#SHARD_MOVEMENT_STRATEGY_SETTING} via cluster settings.
*
diff --git a/server/src/main/java/org/opensearch/cluster/routing/UnassignedInfo.java b/server/src/main/java/org/opensearch/cluster/routing/UnassignedInfo.java
index de36547b10707..5e748df5eed2d 100644
--- a/server/src/main/java/org/opensearch/cluster/routing/UnassignedInfo.java
+++ b/server/src/main/java/org/opensearch/cluster/routing/UnassignedInfo.java
@@ -153,7 +153,7 @@ public enum Reason {
/**
* Captures the status of an unsuccessful allocation attempt for the shard,
* causing it to remain in the unassigned state.
- *
+ *
* Note, ordering of the enum is important, make sure to add new values
* at the end and handle version serialization properly.
*
diff --git a/server/src/main/java/org/opensearch/cluster/routing/allocation/AwarenessReplicaBalance.java b/server/src/main/java/org/opensearch/cluster/routing/allocation/AwarenessReplicaBalance.java
index 19601483d5607..6fc0e535ef4dc 100644
--- a/server/src/main/java/org/opensearch/cluster/routing/allocation/AwarenessReplicaBalance.java
+++ b/server/src/main/java/org/opensearch/cluster/routing/allocation/AwarenessReplicaBalance.java
@@ -26,7 +26,7 @@
* This {@link AwarenessReplicaBalance} gives total unique values of awareness attributes
* It takes in effect only iff cluster.routing.allocation.awareness.attributes and
* cluster.routing.allocation.awareness.force.zone.values both are specified.
- *
+ *
* This is used in enforcing total copy of shard is a maximum of unique values of awareness attributes
* Helps in balancing shards across all awareness attributes and ensuring high availability of data.
*/
diff --git a/server/src/main/java/org/opensearch/cluster/routing/allocation/ConstraintTypes.java b/server/src/main/java/org/opensearch/cluster/routing/allocation/ConstraintTypes.java
index f209e993518c1..ae2d4a0926194 100644
--- a/server/src/main/java/org/opensearch/cluster/routing/allocation/ConstraintTypes.java
+++ b/server/src/main/java/org/opensearch/cluster/routing/allocation/ConstraintTypes.java
@@ -36,14 +36,14 @@ public class ConstraintTypes {
/**
* Constraint to control number of shards of an index allocated on a single
* node.
- *
+ *
* In current weight function implementation, when a node has significantly
* fewer shards than other nodes (e.g. during single new node addition or node
* replacement), its weight is much less than other nodes. All shard allocations
* at this time tend to land on the new node with skewed weight. This breaks
* index level balance in the cluster, by creating all shards of the same index
* on one node, often resulting in a hotspot on that node.
- *
+ *
* This constraint is breached when balancer attempts to allocate more than
* average shards per index per node.
*/
diff --git a/server/src/main/java/org/opensearch/cluster/routing/allocation/IndexMetadataUpdater.java b/server/src/main/java/org/opensearch/cluster/routing/allocation/IndexMetadataUpdater.java
index ae8d92dae6811..7fc78b05880f3 100644
--- a/server/src/main/java/org/opensearch/cluster/routing/allocation/IndexMetadataUpdater.java
+++ b/server/src/main/java/org/opensearch/cluster/routing/allocation/IndexMetadataUpdater.java
@@ -59,9 +59,9 @@
/**
* Observer that tracks changes made to RoutingNodes in order to update the primary terms and in-sync allocation ids in
* {@link IndexMetadata} once the allocation round has completed.
- *
+ *
* Primary terms are updated on primary initialization or when an active primary fails.
- *
+ *
* Allocation ids are added for shards that become active and removed for shards that stop being active.
*
* @opensearch.internal
diff --git a/server/src/main/java/org/opensearch/cluster/routing/allocation/allocator/BalancedShardsAllocator.java b/server/src/main/java/org/opensearch/cluster/routing/allocation/allocator/BalancedShardsAllocator.java
index 90eff50fd9b5d..41ace0e7661fe 100644
--- a/server/src/main/java/org/opensearch/cluster/routing/allocation/allocator/BalancedShardsAllocator.java
+++ b/server/src/main/java/org/opensearch/cluster/routing/allocation/allocator/BalancedShardsAllocator.java
@@ -336,7 +336,7 @@ public boolean getPreferPrimaryBalance() {
*
*
* weight(node, index) = weightindex(node, index) + weightnode(node, index)
- *
+ *
* package-private for testing
*/
static class WeightFunction {
diff --git a/server/src/main/java/org/opensearch/cluster/routing/allocation/allocator/LocalShardsBalancer.java b/server/src/main/java/org/opensearch/cluster/routing/allocation/allocator/LocalShardsBalancer.java
index 3365b58d92a63..75448520a499c 100644
--- a/server/src/main/java/org/opensearch/cluster/routing/allocation/allocator/LocalShardsBalancer.java
+++ b/server/src/main/java/org/opensearch/cluster/routing/allocation/allocator/LocalShardsBalancer.java
@@ -530,7 +530,7 @@ private void checkAndAddInEligibleTargetNode(RoutingNode targetNode) {
/**
* Move started shards that can not be allocated to a node anymore
- *
+ *
* For each shard to be moved this function executes a move operation
* to the minimal eligible node with respect to the
* weight function. If a shard is moved the shard will be set to
diff --git a/server/src/main/java/org/opensearch/cluster/routing/allocation/allocator/ShardsAllocator.java b/server/src/main/java/org/opensearch/cluster/routing/allocation/allocator/ShardsAllocator.java
index 63d8c656f5049..29e9acca4e6c2 100644
--- a/server/src/main/java/org/opensearch/cluster/routing/allocation/allocator/ShardsAllocator.java
+++ b/server/src/main/java/org/opensearch/cluster/routing/allocation/allocator/ShardsAllocator.java
@@ -63,12 +63,12 @@ public interface ShardsAllocator {
* Returns the decision for where a shard should reside in the cluster. If the shard is unassigned,
* then the {@link AllocateUnassignedDecision} will be non-null. If the shard is not in the unassigned
* state, then the {@link MoveDecision} will be non-null.
- *
+ *
* This method is primarily used by the cluster allocation explain API to provide detailed explanations
* for the allocation of a single shard. Implementations of the {@link #allocate(RoutingAllocation)} method
* may use the results of this method implementation to decide on allocating shards in the routing table
* to the cluster.
- *
+ *
* If an implementation of this interface does not support explaining decisions for a single shard through
* the cluster explain API, then this method should throw a {@code UnsupportedOperationException}.
*/
diff --git a/server/src/main/java/org/opensearch/cluster/routing/allocation/command/AllocationCommand.java b/server/src/main/java/org/opensearch/cluster/routing/allocation/command/AllocationCommand.java
index 7fffb0299af85..def0411853643 100644
--- a/server/src/main/java/org/opensearch/cluster/routing/allocation/command/AllocationCommand.java
+++ b/server/src/main/java/org/opensearch/cluster/routing/allocation/command/AllocationCommand.java
@@ -43,7 +43,7 @@
/**
* A command to move shards in some way.
- *
+ *
* Commands are registered in {@link NetworkModule}.
*
* @opensearch.internal
diff --git a/server/src/main/java/org/opensearch/cluster/routing/allocation/decider/AllocationDecider.java b/server/src/main/java/org/opensearch/cluster/routing/allocation/decider/AllocationDecider.java
index 24c3fd7f34e4a..85f193c8c5580 100644
--- a/server/src/main/java/org/opensearch/cluster/routing/allocation/decider/AllocationDecider.java
+++ b/server/src/main/java/org/opensearch/cluster/routing/allocation/decider/AllocationDecider.java
@@ -109,7 +109,7 @@ public Decision canRebalance(RoutingAllocation allocation) {
* Returns a {@link Decision} whether the given primary shard can be
* forcibly allocated on the given node. This method should only be called
* for unassigned primary shards where the node has a shard copy on disk.
- *
+ *
* Note: all implementations that override this behavior should take into account
* the results of {@link #canAllocate(ShardRouting, RoutingNode, RoutingAllocation)}
* before making a decision on force allocation, because force allocation should only
diff --git a/server/src/main/java/org/opensearch/cluster/routing/allocation/decider/DiskThresholdDecider.java b/server/src/main/java/org/opensearch/cluster/routing/allocation/decider/DiskThresholdDecider.java
index 1bd47f111591d..2c7df6b81e676 100644
--- a/server/src/main/java/org/opensearch/cluster/routing/allocation/decider/DiskThresholdDecider.java
+++ b/server/src/main/java/org/opensearch/cluster/routing/allocation/decider/DiskThresholdDecider.java
@@ -73,23 +73,23 @@
/**
* The {@link DiskThresholdDecider} checks that the node a shard is potentially
* being allocated to has enough disk space.
- *
+ *
* It has three configurable settings, all of which can be changed dynamically:
- *
+ *
* cluster.routing.allocation.disk.watermark.low is the low disk
* watermark. New shards will not allocated to a node with usage higher than this,
* although this watermark may be passed by allocating a shard. It defaults to
* 0.85 (85.0%).
- *
+ *
* cluster.routing.allocation.disk.watermark.high is the high disk
* watermark. If a node has usage higher than this, shards are not allowed to
* remain on the node. In addition, if allocating a shard to a node causes the
* node to pass this watermark, it will not be allowed. It defaults to
* 0.90 (90.0%).
- *
+ *
* Both watermark settings are expressed in terms of used disk percentage, or
* exact byte values for free space (like "500mb")
- *
+ *
* cluster.routing.allocation.disk.threshold_enabled is used to
* enable or disable this decider. It defaults to true (enabled).
*
@@ -119,7 +119,7 @@ public DiskThresholdDecider(Settings settings, ClusterSettings clusterSettings)
/**
* Returns the size of all shards that are currently being relocated to
* the node, but may not be finished transferring yet.
- *
+ *
* If subtractShardsMovingAway is true then the size of shards moving away is subtracted from the total size of all shards
*/
public static long sizeOfRelocatingShards(
diff --git a/server/src/main/java/org/opensearch/cluster/routing/allocation/decider/SameShardAllocationDecider.java b/server/src/main/java/org/opensearch/cluster/routing/allocation/decider/SameShardAllocationDecider.java
index 1680f2d8cad1d..c2eccdbc6ed26 100644
--- a/server/src/main/java/org/opensearch/cluster/routing/allocation/decider/SameShardAllocationDecider.java
+++ b/server/src/main/java/org/opensearch/cluster/routing/allocation/decider/SameShardAllocationDecider.java
@@ -44,7 +44,7 @@
/**
* An allocation decider that prevents multiple instances of the same shard to
* be allocated on the same {@code node}.
- *
+ *
* The {@link #CLUSTER_ROUTING_ALLOCATION_SAME_HOST_SETTING} setting allows to perform a check to prevent
* allocation of multiple instances of the same shard on a single {@code host},
* based on host name and host address. Defaults to `false`, meaning that no
diff --git a/server/src/main/java/org/opensearch/cluster/routing/allocation/decider/ThrottlingAllocationDecider.java b/server/src/main/java/org/opensearch/cluster/routing/allocation/decider/ThrottlingAllocationDecider.java
index 3a9fdf0ea10cf..26a04de31ce39 100644
--- a/server/src/main/java/org/opensearch/cluster/routing/allocation/decider/ThrottlingAllocationDecider.java
+++ b/server/src/main/java/org/opensearch/cluster/routing/allocation/decider/ThrottlingAllocationDecider.java
@@ -323,7 +323,7 @@ private Decision allocateShardCopies(
* - the initializing shard routing if we want to assign the initializing shard to this node instead
* - the started shard routing in case if we want to check if we can relocate to this node.
* - the relocating shard routing if we want to relocate to this node now instead.
- *
+ *
* This method returns the corresponding initializing shard that would be allocated to this node.
*/
private ShardRouting initializingShard(ShardRouting shardRouting, String currentNodeId) {
diff --git a/server/src/main/java/org/opensearch/cluster/service/ClusterApplierService.java b/server/src/main/java/org/opensearch/cluster/service/ClusterApplierService.java
index 007508162ba14..8e94e7cab23d3 100644
--- a/server/src/main/java/org/opensearch/cluster/service/ClusterApplierService.java
+++ b/server/src/main/java/org/opensearch/cluster/service/ClusterApplierService.java
@@ -294,7 +294,7 @@ public void addLocalNodeMasterListener(LocalNodeMasterListener listener) {
/**
* Adds a cluster state listener that is expected to be removed during a short period of time.
* If provided, the listener will be notified once a specific time has elapsed.
- *
+ *
* NOTE: the listener is not removed on timeout. This is the responsibility of the caller.
*/
public void addTimeoutListener(@Nullable final TimeValue timeout, final TimeoutClusterStateListener listener) {
diff --git a/server/src/main/java/org/opensearch/cluster/service/ClusterManagerTaskThrottler.java b/server/src/main/java/org/opensearch/cluster/service/ClusterManagerTaskThrottler.java
index 8da6b1b941f83..afc4e36ec352e 100644
--- a/server/src/main/java/org/opensearch/cluster/service/ClusterManagerTaskThrottler.java
+++ b/server/src/main/java/org/opensearch/cluster/service/ClusterManagerTaskThrottler.java
@@ -29,7 +29,7 @@
/**
* This class does throttling on task submission to cluster manager node, it uses throttling key defined in various executors
* as key for throttling. Throttling will be performed over task executor's class level, different task types have different executors class.
- *
+ *
* Set specific setting to for setting the threshold of throttling of particular task type.
* e.g : Set "cluster_manager.throttling.thresholds.put_mapping" to set throttling limit of "put mapping" tasks,
* Set it to default value(-1) to disable the throttling for this task type.
@@ -117,9 +117,9 @@ public static TimeValue getMaxDelayForRetry() {
* * Register task to cluster service with task key,
* * override getClusterManagerThrottlingKey method with above task key in task executor.
* * Verify that throttled tasks would be retried from data nodes
- *
+ *
* Added retry mechanism in TransportClusterManagerNodeAction, so it would be retried for customer generated tasks.
- *
+ *
* If tasks are not getting retried then we can register with false flag, so user won't be able to configure threshold limits for it.
*/
protected ThrottlingKey registerClusterManagerTask(String taskKey, boolean throttlingEnabled) {
@@ -236,7 +236,7 @@ public void onBeginSubmit(List tasks) {
* It may start throwing throttling exception to older nodes in cluster.
* Older version nodes will not be equipped to handle the throttling exception and
* this may result in unexpected behavior where internal tasks would start failing without any retries.
- *
+ *
* For every task submission request, it will validate if nodes version is greater or equal to 2.5.0 and set the startThrottling flag.
* Once the startThrottling flag is set, it will not perform check for next set of tasks.
*/
diff --git a/server/src/main/java/org/opensearch/common/Randomness.java b/server/src/main/java/org/opensearch/common/Randomness.java
index 2c60e848b9db9..221bc95c41f31 100644
--- a/server/src/main/java/org/opensearch/common/Randomness.java
+++ b/server/src/main/java/org/opensearch/common/Randomness.java
@@ -127,7 +127,7 @@ public static Random get() {
/**
* Provides a secure source of randomness.
- *
+ *
* This acts exactly similar to {@link #get()}, but returning a new {@link SecureRandom}.
*/
public static SecureRandom createSecure() {
diff --git a/server/src/main/java/org/opensearch/common/blobstore/BlobContainer.java b/server/src/main/java/org/opensearch/common/blobstore/BlobContainer.java
index 3cdb1ce30b68d..2e25a532b5abf 100644
--- a/server/src/main/java/org/opensearch/common/blobstore/BlobContainer.java
+++ b/server/src/main/java/org/opensearch/common/blobstore/BlobContainer.java
@@ -93,10 +93,10 @@ public interface BlobContainer {
/**
* Provides a hint to clients for a suitable length to use with {@link BlobContainer#readBlob(String, long, long)}.
- *
+ *
* Some blob containers have nontrivial costs attached to each readBlob call, so it is a good idea for consumers to speculatively
* request more data than they need right now and to re-use this stream for future needs if possible.
- *
+ *
* Also, some blob containers return streams that are expensive to close before the stream has been fully consumed, and the cost may
* depend on the length of the data that was left unconsumed. For these containers it's best to bound the cost of a partial read by
* bounding the length of the data requested.
@@ -131,7 +131,7 @@ default long readBlobPreferredLength() {
/**
* Reads blob content from the input stream and writes it to the container in a new blob with the given name,
* using an atomic write operation if the implementation supports it.
- *
+ *
* This method assumes the container does not already contain a blob of the same blobName. If a blob by the
* same name already exists, the operation will fail and an {@link IOException} will be thrown.
*
diff --git a/server/src/main/java/org/opensearch/common/blobstore/fs/FsBlobContainer.java b/server/src/main/java/org/opensearch/common/blobstore/fs/FsBlobContainer.java
index 394855671688a..b6644ffd16bab 100644
--- a/server/src/main/java/org/opensearch/common/blobstore/fs/FsBlobContainer.java
+++ b/server/src/main/java/org/opensearch/common/blobstore/fs/FsBlobContainer.java
@@ -69,7 +69,7 @@
/**
* A file system based implementation of {@link org.opensearch.common.blobstore.BlobContainer}.
* All blobs in the container are stored on a file system, the location of which is specified by the {@link BlobPath}.
- *
+ *
* Note that the methods in this implementation of {@link org.opensearch.common.blobstore.BlobContainer} may
* additionally throw a {@link java.lang.SecurityException} if the configured {@link java.lang.SecurityManager}
* does not permit read and/or write access to the underlying files.
@@ -258,7 +258,7 @@ public static String tempBlobName(final String blobName) {
/**
* Returns true if the blob is a leftover temporary blob.
- *
+ *
* The temporary blobs might be left after failed atomic write operation.
*/
public static boolean isTempBlobName(final String blobName) {
diff --git a/server/src/main/java/org/opensearch/common/breaker/ChildMemoryCircuitBreaker.java b/server/src/main/java/org/opensearch/common/breaker/ChildMemoryCircuitBreaker.java
index de4e6ad433c55..c9b498c3ec6fa 100644
--- a/server/src/main/java/org/opensearch/common/breaker/ChildMemoryCircuitBreaker.java
+++ b/server/src/main/java/org/opensearch/common/breaker/ChildMemoryCircuitBreaker.java
@@ -204,7 +204,7 @@ private long limit(long bytes, String label, double overheadConstant, long memor
/**
* Add an exact number of bytes, not checking for tripping the
* circuit breaker. This bypasses the overheadConstant multiplication.
- *
+ *
* Also does not check with the parent breaker to see if the parent limit
* has been exceeded.
*
diff --git a/server/src/main/java/org/opensearch/common/cache/Cache.java b/server/src/main/java/org/opensearch/common/cache/Cache.java
index 0ebef1556424b..0b2b608b55df0 100644
--- a/server/src/main/java/org/opensearch/common/cache/Cache.java
+++ b/server/src/main/java/org/opensearch/common/cache/Cache.java
@@ -403,7 +403,7 @@ private V get(K key, long now, Consumer> onExpiration) {
* If the specified key is not already associated with a value (or is mapped to null), attempts to compute its
* value using the given mapping function and enters it into this map unless null. The load method for a given key
* will be invoked at most once.
- *
+ *
* Use of different {@link CacheLoader} implementations on the same key concurrently may result in only the first
* loader function being called and the second will be returned the result provided by the first including any exceptions
* thrown during the execution of the first.
diff --git a/server/src/main/java/org/opensearch/common/collect/CopyOnWriteHashMap.java b/server/src/main/java/org/opensearch/common/collect/CopyOnWriteHashMap.java
index 5ce77cdc75fe5..de4304f0e1fba 100644
--- a/server/src/main/java/org/opensearch/common/collect/CopyOnWriteHashMap.java
+++ b/server/src/main/java/org/opensearch/common/collect/CopyOnWriteHashMap.java
@@ -49,15 +49,15 @@
/**
* An immutable map whose writes result in a new copy of the map to be created.
- *
+ *
* This is essentially a hash array mapped trie: inner nodes use a bitmap in
* order to map hashes to slots by counting ones. In case of a collision (two
* values having the same 32-bits hash), a leaf node is created which stores
* and searches for values sequentially.
- *
+ *
* Reads and writes both perform in logarithmic time. Null keys and values are
* not supported.
- *
+ *
* This structure might need to perform several object creations per write so
* it is better suited for work-loads that are not too write-intensive.
*
@@ -250,7 +250,7 @@ public static T[] insertElement(final T[] array, final T element, final int
* and use a bitmap in order to associate hashes to them. For example, if
* an inner node contains 5 values, then 5 bits will be set in the bitmap
* and the ordinal of the bit set in this bit map will be the slot number.
- *
+ *
* As a consequence, the number of slots in an inner node is equal to the
* number of one bits in the bitmap.
*
diff --git a/server/src/main/java/org/opensearch/common/geo/GeoShapeType.java b/server/src/main/java/org/opensearch/common/geo/GeoShapeType.java
index 0334d367ffdbc..1622457ba27cc 100644
--- a/server/src/main/java/org/opensearch/common/geo/GeoShapeType.java
+++ b/server/src/main/java/org/opensearch/common/geo/GeoShapeType.java
@@ -221,11 +221,11 @@ void validateLinearRing(CoordinateNode coordinates, boolean coerce) {
@Override
CoordinateNode validate(CoordinateNode coordinates, boolean coerce) {
- /**
- * Per GeoJSON spec (http://geojson.org/geojson-spec.html#linestring)
- * A LinearRing is closed LineString with 4 or more positions. The first and last positions
- * are equivalent (they represent equivalent points). Though a LinearRing is not explicitly
- * represented as a GeoJSON geometry type, it is referred to in the Polygon geometry type definition.
+ /*
+ Per GeoJSON spec (http://geojson.org/geojson-spec.html#linestring)
+ A LinearRing is closed LineString with 4 or more positions. The first and last positions
+ are equivalent (they represent equivalent points). Though a LinearRing is not explicitly
+ represented as a GeoJSON geometry type, it is referred to in the Polygon geometry type definition.
*/
if (coordinates.children == null || coordinates.children.isEmpty()) {
throw new OpenSearchParseException(
diff --git a/server/src/main/java/org/opensearch/common/geo/GeoUtils.java b/server/src/main/java/org/opensearch/common/geo/GeoUtils.java
index 393c238cb3b2f..8c566c4191e4f 100644
--- a/server/src/main/java/org/opensearch/common/geo/GeoUtils.java
+++ b/server/src/main/java/org/opensearch/common/geo/GeoUtils.java
@@ -665,7 +665,7 @@ public static GeoPoint parseFromString(String val) {
/**
* Parse a precision that can be expressed as an integer or a distance measure like "1km", "10m".
- *
+ *
* The precision is expressed as a number between 1 and 12 and indicates the length of geohash
* used to represent geo points.
*
@@ -696,7 +696,7 @@ public static int parsePrecision(XContentParser parser) throws IOException, Open
/**
* Checks that the precision is within range supported by opensearch - between 1 and 12
- *
+ *
* Returns the precision value if it is in the range and throws an IllegalArgumentException if it
* is outside the range.
*/
diff --git a/server/src/main/java/org/opensearch/common/geo/GeometryFormat.java b/server/src/main/java/org/opensearch/common/geo/GeometryFormat.java
index 56146fc8197be..93c7f4b93679a 100644
--- a/server/src/main/java/org/opensearch/common/geo/GeometryFormat.java
+++ b/server/src/main/java/org/opensearch/common/geo/GeometryFormat.java
@@ -63,7 +63,7 @@ public interface GeometryFormat {
/**
* Serializes the geometry into a standard Java object.
- *
+ *
* For example, the GeoJson format returns the geometry as a map, while WKT returns a string.
*/
Object toXContentAsObject(ParsedFormat geometry);
diff --git a/server/src/main/java/org/opensearch/common/geo/builders/PolygonBuilder.java b/server/src/main/java/org/opensearch/common/geo/builders/PolygonBuilder.java
index b436787220eb0..9e118ab2de3a5 100644
--- a/server/src/main/java/org/opensearch/common/geo/builders/PolygonBuilder.java
+++ b/server/src/main/java/org/opensearch/common/geo/builders/PolygonBuilder.java
@@ -177,11 +177,11 @@ public PolygonBuilder close() {
}
private static void validateLinearRing(LineStringBuilder lineString) {
- /**
- * Per GeoJSON spec (http://geojson.org/geojson-spec.html#linestring)
- * A LinearRing is closed LineString with 4 or more positions. The first and last positions
- * are equivalent (they represent equivalent points). Though a LinearRing is not explicitly
- * represented as a GeoJSON geometry type, it is referred to in the Polygon geometry type definition.
+ /*
+ Per GeoJSON spec (http://geojson.org/geojson-spec.html#linestring)
+ A LinearRing is closed LineString with 4 or more positions. The first and last positions
+ are equivalent (they represent equivalent points). Though a LinearRing is not explicitly
+ represented as a GeoJSON geometry type, it is referred to in the Polygon geometry type definition.
*/
List points = lineString.coordinates;
if (points.size() < 4) {
diff --git a/server/src/main/java/org/opensearch/common/geo/parsers/GeoJsonParser.java b/server/src/main/java/org/opensearch/common/geo/parsers/GeoJsonParser.java
index 37d42ce600b6d..8d473ae6721d2 100644
--- a/server/src/main/java/org/opensearch/common/geo/parsers/GeoJsonParser.java
+++ b/server/src/main/java/org/opensearch/common/geo/parsers/GeoJsonParser.java
@@ -52,7 +52,7 @@
/**
* Parses shape geometry represented in geojson
- *
+ *
* complies with geojson specification: https://tools.ietf.org/html/rfc7946
*
* @opensearch.internal
diff --git a/server/src/main/java/org/opensearch/common/geo/parsers/GeoWKTParser.java b/server/src/main/java/org/opensearch/common/geo/parsers/GeoWKTParser.java
index d99d1daf46a2a..b199da0f3691a 100644
--- a/server/src/main/java/org/opensearch/common/geo/parsers/GeoWKTParser.java
+++ b/server/src/main/java/org/opensearch/common/geo/parsers/GeoWKTParser.java
@@ -58,7 +58,7 @@
/**
* Parses shape geometry represented in WKT format
- *
+ *
* complies with OGC® document: 12-063r5 and ISO/IEC 13249-3:2016 standard
* located at http://docs.opengeospatial.org/is/12-063r5/12-063r5.html
*
diff --git a/server/src/main/java/org/opensearch/common/hash/MurmurHash3.java b/server/src/main/java/org/opensearch/common/hash/MurmurHash3.java
index 8ba0bd7ee1be4..e481ffd460798 100644
--- a/server/src/main/java/org/opensearch/common/hash/MurmurHash3.java
+++ b/server/src/main/java/org/opensearch/common/hash/MurmurHash3.java
@@ -93,7 +93,7 @@ protected static long fmix(long k) {
/**
* Compute the hash of the MurmurHash3_x64_128 hashing function.
- *
+ *
* Note, this hashing function might be used to persist hashes, so if the way hashes are computed
* changes for some reason, it needs to be addressed (like in BloomFilter and MurmurHashField).
*/
diff --git a/server/src/main/java/org/opensearch/common/inject/Initializer.java b/server/src/main/java/org/opensearch/common/inject/Initializer.java
index e806eba6df707..b88b01c03c018 100644
--- a/server/src/main/java/org/opensearch/common/inject/Initializer.java
+++ b/server/src/main/java/org/opensearch/common/inject/Initializer.java
@@ -68,9 +68,8 @@ class Initializer {
/**
* Registers an instance for member injection when that step is performed.
*
- * @param instance an instance that optionally has members to be injected (each annotated with
- * @param source the source location that this injection was requested
- * @Inject).
+ * @param instance an instance that optionally has members to be injected (each annotated with {@code @Inject}).
+ * @param source the source location that this injection was requested
*/
public Initializable requestInjection(InjectorImpl injector, T instance, Object source, Set injectionPoints) {
Objects.requireNonNull(source);
diff --git a/server/src/main/java/org/opensearch/common/io/stream/Streamables.java b/server/src/main/java/org/opensearch/common/io/stream/Streamables.java
index fd9ed6e5b18fe..f1e5f5f22d527 100644
--- a/server/src/main/java/org/opensearch/common/io/stream/Streamables.java
+++ b/server/src/main/java/org/opensearch/common/io/stream/Streamables.java
@@ -40,7 +40,7 @@ public static void registerStreamables() {
* Registers writers by class type
*/
private static void registerWriters() {
- /** {@link GeoPoint} */
+ /* {@link GeoPoint} */
WriteableRegistry.registerWriter(GeoPoint.class, (o, v) -> {
o.writeByte((byte) 22);
((GeoPoint) v).writeTo(o);
@@ -53,7 +53,7 @@ private static void registerWriters() {
* NOTE: see {@code StreamOutput#WRITERS} for all registered ordinals
*/
private static void registerReaders() {
- /** {@link GeoPoint} */
+ /* {@link GeoPoint} */
WriteableRegistry.registerReader(Byte.valueOf((byte) 22), GeoPoint::new);
}
}
diff --git a/server/src/main/java/org/opensearch/common/joda/JodaDateMathParser.java b/server/src/main/java/org/opensearch/common/joda/JodaDateMathParser.java
index 0de6dec1c25bd..ae38e9a6a8073 100644
--- a/server/src/main/java/org/opensearch/common/joda/JodaDateMathParser.java
+++ b/server/src/main/java/org/opensearch/common/joda/JodaDateMathParser.java
@@ -46,7 +46,7 @@
/**
* A parser for date/time formatted text with optional date math.
- *
+ *
* The format of the datetime is configurable, and unix timestamps can also be used. Datemath
* is appended to a datetime with the following syntax:
* ||[+-/](\d+)?[yMwdhHms].
diff --git a/server/src/main/java/org/opensearch/common/logging/JsonThrowablePatternConverter.java b/server/src/main/java/org/opensearch/common/logging/JsonThrowablePatternConverter.java
index e259d5d9e3e33..ed324e4e62d8f 100644
--- a/server/src/main/java/org/opensearch/common/logging/JsonThrowablePatternConverter.java
+++ b/server/src/main/java/org/opensearch/common/logging/JsonThrowablePatternConverter.java
@@ -47,7 +47,7 @@
* Outputs the Throwable portion of the LoggingEvent as a Json formatted field with array
* "exception": [ "stacktrace", "lines", "as", "array", "elements" ]
- *
+ *
* Reusing @link org.apache.logging.log4j.core.pattern.ExtendedThrowablePatternConverter which already converts a Throwable from
* LoggingEvent into a multiline string
*
diff --git a/server/src/main/java/org/opensearch/common/lucene/ShardCoreKeyMap.java b/server/src/main/java/org/opensearch/common/lucene/ShardCoreKeyMap.java
index 0ffd633e5a967..17b75ab22f3ed 100644
--- a/server/src/main/java/org/opensearch/common/lucene/ShardCoreKeyMap.java
+++ b/server/src/main/java/org/opensearch/common/lucene/ShardCoreKeyMap.java
@@ -55,7 +55,7 @@
* mappings as segments that were not known before are added and prevents the
* structure from growing indefinitely by registering close listeners on these
* segments so that at any time it only tracks live segments.
- *
+ *
* NOTE: This is heavy. Avoid using this class unless absolutely required.
*
* @opensearch.internal
diff --git a/server/src/main/java/org/opensearch/common/rounding/Rounding.java b/server/src/main/java/org/opensearch/common/rounding/Rounding.java
index 857031bc783f4..41e808b64f7d9 100644
--- a/server/src/main/java/org/opensearch/common/rounding/Rounding.java
+++ b/server/src/main/java/org/opensearch/common/rounding/Rounding.java
@@ -45,7 +45,7 @@
/**
* A strategy for rounding long values.
- *
+ *
* Use the java based Rounding class where applicable
*
* @opensearch.internal
diff --git a/server/src/main/java/org/opensearch/common/settings/AbstractScopedSettings.java b/server/src/main/java/org/opensearch/common/settings/AbstractScopedSettings.java
index 8b7a2a82e5cb1..117ed66fcb451 100644
--- a/server/src/main/java/org/opensearch/common/settings/AbstractScopedSettings.java
+++ b/server/src/main/java/org/opensearch/common/settings/AbstractScopedSettings.java
@@ -254,7 +254,7 @@ public synchronized void addSettingsUpdateConsumer(Setting setting, Consu
/**
* Adds a settings consumer that is only executed if any setting in the supplied list of settings is changed. In that case all the
* settings are specified in the argument are returned.
- *
+ *
* Also automatically adds empty consumers for all settings in order to activate logging
*/
public synchronized void addSettingsUpdateConsumer(Consumer consumer, List> settings) {
@@ -265,7 +265,7 @@ public synchronized void addSettingsUpdateConsumer(Consumer consumer,
* Adds a settings consumer that is only executed if any setting in the supplied list of settings is changed. In that case all the
* settings are specified in the argument are returned. The validator is run across all specified settings before the settings are
* applied.
- *
+ *
* Also automatically adds empty consumers for all settings in order to activate logging
*/
public synchronized void addSettingsUpdateConsumer(
diff --git a/server/src/main/java/org/opensearch/common/settings/KeyStoreWrapper.java b/server/src/main/java/org/opensearch/common/settings/KeyStoreWrapper.java
index f25dd872fc703..1ad3b7ab8875a 100644
--- a/server/src/main/java/org/opensearch/common/settings/KeyStoreWrapper.java
+++ b/server/src/main/java/org/opensearch/common/settings/KeyStoreWrapper.java
@@ -88,7 +88,7 @@
/**
* A disk based container for sensitive settings in OpenSearch.
- *
+ *
* Loading a keystore has 2 phases. First, call {@link #load(Path)}. Then call
* {@link #decrypt(char[])} with the keystore password, or an empty char array if
* {@link #hasPassword()} is {@code false}. Loading and decrypting should happen
@@ -147,7 +147,7 @@ private static class Entry {
/**
* The number of bits for the cipher key.
- *
+ *
* Note: The Oracle JDK 8 ships with a limited JCE policy that restricts key length for AES to 128 bits.
* This can be increased to 256 bits once minimum java 9 is the minimum java version.
* See http://www.oracle.com/technetwork/java/javase/terms/readme/jdk9-readme-3852447.html#jce
@@ -234,7 +234,7 @@ public static KeyStoreWrapper load(Path configDir) throws IOException {
/**
* Loads information about the OpenSearch keystore from the provided config directory.
- *
+ *
* {@link #decrypt(char[])} must be called before reading or writing any entries.
* Returns {@code null} if no keystore exists.
*/
@@ -358,7 +358,7 @@ private Cipher createCipher(int opmode, char[] password, byte[] salt, byte[] iv)
/**
* Decrypts the underlying keystore data.
- *
+ *
* This may only be called once.
*/
public void decrypt(char[] password) throws GeneralSecurityException, IOException {
diff --git a/server/src/main/java/org/opensearch/common/settings/SecureSetting.java b/server/src/main/java/org/opensearch/common/settings/SecureSetting.java
index f2ccc01a4c7e6..1855270b016b3 100644
--- a/server/src/main/java/org/opensearch/common/settings/SecureSetting.java
+++ b/server/src/main/java/org/opensearch/common/settings/SecureSetting.java
@@ -45,7 +45,7 @@
/**
* A secure setting.
- *
+ *
* This class allows access to settings from the OpenSearch keystore.
*
* @opensearch.internal
@@ -152,7 +152,7 @@ public void diff(Settings.Builder builder, Settings source, Settings defaultSett
/**
* A setting which contains a sensitive string.
- *
+ *
* This may be any sensitive string, e.g. a username, a password, an auth token, etc.
*/
public static Setting secureString(String name, Setting fallback, Property... properties) {
@@ -179,7 +179,7 @@ public static Setting insecureString(String name, String secureNam
/**
* A setting which contains a file. Reading the setting opens an input stream to the file.
- *
+ *
* This may be any sensitive file, e.g. a set of credentials normally in plaintext.
*/
public static Setting secureFile(String name, Setting fallback, Property... properties) {
diff --git a/server/src/main/java/org/opensearch/common/settings/Settings.java b/server/src/main/java/org/opensearch/common/settings/Settings.java
index d202feb0786bf..0557884f0f8ad 100644
--- a/server/src/main/java/org/opensearch/common/settings/Settings.java
+++ b/server/src/main/java/org/opensearch/common/settings/Settings.java
@@ -1222,7 +1222,7 @@ public boolean shouldRemoveMissingPlaceholder(String placeholderName) {
/**
* Checks that all settings(except archived settings and wildcards) in the builder start with the specified prefix.
- *
+ *
* If a setting doesn't start with the prefix, the builder appends the prefix to such setting.
*/
public Builder normalizePrefix(String prefix) {
diff --git a/server/src/main/java/org/opensearch/common/time/DateFormatters.java b/server/src/main/java/org/opensearch/common/time/DateFormatters.java
index 6c8b9282d8a77..e74ab687b903b 100644
--- a/server/src/main/java/org/opensearch/common/time/DateFormatters.java
+++ b/server/src/main/java/org/opensearch/common/time/DateFormatters.java
@@ -2172,10 +2172,10 @@ static DateFormatter forPattern(String input) {
* or Instant.from(accessor). This results in a huge performance penalty and should be prevented
* This method prevents exceptions by querying the accessor for certain capabilities
* and then act on it accordingly
- *
+ *
* This action assumes that we can reliably fall back to some defaults if not all parts of a
* zoned date time are set
- *
+ *
* - If a zoned date time is passed, it is returned
* - If no timezone is found, ZoneOffset.UTC is used
* - If we find a time and a date, converting to a ZonedDateTime is straight forward,
diff --git a/server/src/main/java/org/opensearch/common/time/DateMathParser.java b/server/src/main/java/org/opensearch/common/time/DateMathParser.java
index f6573eaa90286..7088d6cb7a498 100644
--- a/server/src/main/java/org/opensearch/common/time/DateMathParser.java
+++ b/server/src/main/java/org/opensearch/common/time/DateMathParser.java
@@ -64,12 +64,12 @@ default Instant parse(String text, LongSupplier now, boolean roundUpProperty, Da
/**
* Parse text, that potentially contains date math into the milliseconds since the epoch
- *
+ *
* Examples are
- *
+ *
* 2014-11-18||-2y subtracts two years from the input date
* now/m rounds the current time to minute granularity
- *
+ *
* Supported rounding units are
* y year
* M month
diff --git a/server/src/main/java/org/opensearch/common/time/DateUtils.java b/server/src/main/java/org/opensearch/common/time/DateUtils.java
index 021b8a3be8b23..7ab395a1117e7 100644
--- a/server/src/main/java/org/opensearch/common/time/DateUtils.java
+++ b/server/src/main/java/org/opensearch/common/time/DateUtils.java
@@ -342,7 +342,7 @@ public static long toMilliSeconds(long nanoSecondsSinceEpoch) {
/**
* Rounds the given utc milliseconds sicne the epoch down to the next unit millis
- *
+ *
* Note: This does not check for correctness of the result, as this only works with units smaller or equal than a day
* In order to ensure the performance of this methods, there are no guards or checks in it
*
diff --git a/server/src/main/java/org/opensearch/common/time/DateUtilsRounding.java b/server/src/main/java/org/opensearch/common/time/DateUtilsRounding.java
index f3459a5857b9e..7fc39e063efb5 100644
--- a/server/src/main/java/org/opensearch/common/time/DateUtilsRounding.java
+++ b/server/src/main/java/org/opensearch/common/time/DateUtilsRounding.java
@@ -32,12 +32,12 @@
* This class has been copied from different locations within the joda time package, as
* these methods fast when used for rounding, as they do not require conversion to java
* time objects
- *
+ *
* This code has been copied from jodatime 2.10.1
* The source can be found at https://github.com/JodaOrg/joda-time/tree/v2.10.1
- *
+ *
* See following methods have been copied (along with required helper variables)
- *
+ *
* - org.joda.time.chrono.GregorianChronology.calculateFirstDayOfYearMillis(int year)
* - org.joda.time.chrono.BasicChronology.getYear(int year)
* - org.joda.time.chrono.BasicGJChronology.getMonthOfYear(long utcMillis, int year)
diff --git a/server/src/main/java/org/opensearch/common/time/JavaDateFormatter.java b/server/src/main/java/org/opensearch/common/time/JavaDateFormatter.java
index 14191357fb8aa..f711b14aeb928 100644
--- a/server/src/main/java/org/opensearch/common/time/JavaDateFormatter.java
+++ b/server/src/main/java/org/opensearch/common/time/JavaDateFormatter.java
@@ -275,7 +275,7 @@ public TemporalAccessor parse(String input) {
* it will continue iterating if the previous parser failed. The pattern must fully match, meaning whole input was used.
* This also means that this method depends on DateTimeFormatter.ClassicFormat.parseObject
* which does not throw exceptions when parsing failed.
- *
+ *
* The approach with collection of parsers was taken because java-time requires ordering on optional (composite)
* patterns. Joda does not suffer from this.
* https://bugs.openjdk.java.net/browse/JDK-8188771
diff --git a/server/src/main/java/org/opensearch/common/time/JavaDateMathParser.java b/server/src/main/java/org/opensearch/common/time/JavaDateMathParser.java
index 0536324b6516b..340901e7ac8e2 100644
--- a/server/src/main/java/org/opensearch/common/time/JavaDateMathParser.java
+++ b/server/src/main/java/org/opensearch/common/time/JavaDateMathParser.java
@@ -51,7 +51,7 @@
/**
* A parser for date/time formatted text with optional date math.
- *
+ *
* The format of the datetime is configurable, and unix timestamps can also be used. Datemath
* is appended to a datetime with the following syntax:
* ||[+-/](\d+)?[yMwdhHms].
diff --git a/server/src/main/java/org/opensearch/common/util/BinarySearcher.java b/server/src/main/java/org/opensearch/common/util/BinarySearcher.java
index ca63c170c0ccd..e4315f8699206 100644
--- a/server/src/main/java/org/opensearch/common/util/BinarySearcher.java
+++ b/server/src/main/java/org/opensearch/common/util/BinarySearcher.java
@@ -34,14 +34,14 @@
/**
* Performs binary search on an arbitrary data structure.
- *
+ *
* To do a search, create a subclass and implement custom {@link #compare(int)} and {@link #distance(int)} methods.
- *
+ *
* {@link BinarySearcher} knows nothing about the value being searched for or the underlying data structure.
* These things should be determined by the subclass in its overridden methods.
- *
+ *
* Refer to {@link BigArrays.DoubleBinarySearcher} for an example.
- *
+ *
* NOTE: this class is not thread safe
*
* @opensearch.internal
@@ -74,7 +74,7 @@ private int getClosestIndex(int index1, int index2) {
/**
* Uses a binary search to determine the index of the element within the index range {from, ... , to} that is
* closest to the search value.
- *
+ *
* Unlike most binary search implementations, the value being searched for is not an argument to search method.
* Rather, this value should be stored by the subclass along with the underlying array.
*
diff --git a/server/src/main/java/org/opensearch/common/util/CancellableThreads.java b/server/src/main/java/org/opensearch/common/util/CancellableThreads.java
index 8bc3ca3affb12..67dd4b848f4c0 100644
--- a/server/src/main/java/org/opensearch/common/util/CancellableThreads.java
+++ b/server/src/main/java/org/opensearch/common/util/CancellableThreads.java
@@ -45,7 +45,7 @@
* A utility class for multi threaded operation that needs to be cancellable via interrupts. Every cancellable operation should be
* executed via {@link #execute(Interruptible)}, which will capture the executing thread and make sure it is interrupted in the case
* of cancellation.
- *
+ *
* Cancellation policy: This class does not support external interruption via Thread#interrupt(). Always use #cancel() instead.
*
* @opensearch.internal
diff --git a/server/src/main/java/org/opensearch/common/util/CuckooFilter.java b/server/src/main/java/org/opensearch/common/util/CuckooFilter.java
index 0c792b37ccfa9..28b55f70855d6 100644
--- a/server/src/main/java/org/opensearch/common/util/CuckooFilter.java
+++ b/server/src/main/java/org/opensearch/common/util/CuckooFilter.java
@@ -46,33 +46,33 @@
/**
* An approximate set membership datastructure
- *
+ *
* CuckooFilters are similar to Bloom Filters in usage; values are inserted, and the Cuckoo
* can be asked if it has seen a particular value before. Because the structure is approximate,
* it can return false positives (says it has seen an item when it has not). False negatives
* are not possible though; if the structure says it _has not_ seen an item, that can be
* trusted.
- *
+ *
* The filter can "saturate" at which point the map has hit it's configured load factor (or near enough
* that a large number of evictions are not able to find a free slot) and will refuse to accept
* any new insertions.
- *
+ *
* NOTE: this version does not support deletions, and as such does not save duplicate
* fingerprints (e.g. when inserting, if the fingerprint is already present in the
* candidate buckets, it is not inserted). By not saving duplicates, the CuckooFilter
* loses the ability to delete values. But not by allowing deletions, we can save space
* (do not need to waste slots on duplicate fingerprints), and we do not need to worry
* about inserts "overflowing" a bucket because the same item has been repeated repeatedly
- *
+ *
* NOTE: this CuckooFilter exposes a number of Expert APIs which assume the caller has
* intimate knowledge about how the algorithm works. It is recommended to use
* {@link SetBackedScalingCuckooFilter} instead.
- *
+ *
* Based on the paper:
- *
+ *
* Fan, Bin, et al. "Cuckoo filter: Practically better than bloom."
* Proceedings of the 10th ACM International on Conference on emerging Networking Experiments and Technologies. ACM, 2014.
- *
+ *
* https://www.cs.cmu.edu/~dga/papers/cuckoo-conext2014.pdf
*
* @opensearch.internal
@@ -200,7 +200,7 @@ public int getCount() {
/**
* Returns the number of buckets that has been chosen based
* on the initial configuration
- *
+ *
* Expert-level API
*/
int getNumBuckets() {
@@ -209,7 +209,7 @@ int getNumBuckets() {
/**
* Returns the number of bits used per entry
- *
+ *
* Expert-level API
*/
int getBitsPerEntry() {
@@ -220,7 +220,7 @@ int getBitsPerEntry() {
* Returns the cached fingerprint mask. This is simply a mask for the
* first bitsPerEntry bits, used by {@link CuckooFilter#fingerprint(int, int, int)}
* to generate the fingerprint of a hash
- *
+ *
* Expert-level API
*/
int getFingerprintMask() {
@@ -230,7 +230,7 @@ int getFingerprintMask() {
/**
* Returns an iterator that returns the long[] representation of each bucket. The value
* inside each long will be a fingerprint (or 0L, representing empty).
- *
+ *
* Expert-level API
*/
Iterator getBuckets() {
@@ -267,7 +267,7 @@ boolean mightContain(long hash) {
/**
* Returns true if the bucket or it's alternate bucket contains the fingerprint.
- *
+ *
* Expert-level API, use {@link CuckooFilter#mightContain(long)} to check if
* a value is in the filter.
*/
@@ -307,7 +307,7 @@ boolean add(long hash) {
/**
* Attempts to merge the fingerprint into the specified bucket or it's alternate bucket.
* Returns true if the insertion was successful, false if the filter is saturated.
- *
+ *
* Expert-level API, use {@link CuckooFilter#add(long)} to insert
* values into the filter
*/
@@ -351,7 +351,7 @@ boolean mergeFingerprint(int bucket, int fingerprint) {
* Low-level insert method. Attempts to write the fingerprint into an empty entry
* at this bucket's position. Returns true if that was sucessful, false if all entries
* were occupied.
- *
+ *
* If the fingerprint already exists in one of the entries, it will not duplicate the
* fingerprint like the original paper. This means the filter _cannot_ support deletes,
* but is not sensitive to "overflowing" buckets with repeated inserts
@@ -376,10 +376,10 @@ private boolean tryInsert(int bucket, int fingerprint) {
/**
* Converts a hash into a bucket index (primary or alternate).
- *
+ *
* If the hash is negative, this flips the bits. The hash is then modulo numBuckets
* to get the final index.
- *
+ *
* Expert-level API
*/
static int hashToIndex(int hash, int numBuckets) {
@@ -388,16 +388,16 @@ static int hashToIndex(int hash, int numBuckets) {
/**
* Calculates the alternate bucket for a given bucket:fingerprint tuple
- *
+ *
* The alternate bucket is the fingerprint multiplied by a mixing constant,
* then xor'd against the bucket. This new value is modulo'd against
* the buckets via {@link CuckooFilter#hashToIndex(int, int)} to get the final
* index.
- *
+ *
* Note that the xor makes this operation reversible as long as we have the
* fingerprint and current bucket (regardless of if that bucket was the primary
* or alternate).
- *
+ *
* Expert-level API
*/
static int alternateIndex(int bucket, int fingerprint, int numBuckets) {
@@ -424,10 +424,10 @@ private int getOffset(int bucket, int position) {
/**
* Calculates the fingerprint for a given hash.
- *
+ *
* The fingerprint is simply the first `bitsPerEntry` number of bits that are non-zero.
* If the entire hash is zero, `(int) 1` is used
- *
+ *
* Expert-level API
*/
static int fingerprint(int hash, int bitsPerEntry, int fingerprintMask) {
@@ -501,7 +501,7 @@ private double getLoadFactor(int b) {
* Calculates the optimal number of buckets for this filter. The xor used in the bucketing
* algorithm requires this to be a power of two, so the optimal number of buckets will
* be rounded to the next largest power of two where applicable.
- *
+ *
* TODO: there are schemes to avoid powers of two, might want to investigate those
*/
private int getNumBuckets(long capacity, double loadFactor, int b) {
diff --git a/server/src/main/java/org/opensearch/common/util/SetBackedScalingCuckooFilter.java b/server/src/main/java/org/opensearch/common/util/SetBackedScalingCuckooFilter.java
index e99eb751babe8..a635160844159 100644
--- a/server/src/main/java/org/opensearch/common/util/SetBackedScalingCuckooFilter.java
+++ b/server/src/main/java/org/opensearch/common/util/SetBackedScalingCuckooFilter.java
@@ -75,7 +75,7 @@ public class SetBackedScalingCuckooFilter implements Writeable {
* This set is used to track the insertions before we convert over to an approximate
* filter. This gives us 100% accuracy for small cardinalities. This will be null
* if isSetMode = false;
- *
+ *
* package-private for testing
*/
Set hashes;
@@ -178,7 +178,7 @@ public void writeTo(StreamOutput out) throws IOException {
/**
* Registers a circuit breaker with the datastructure.
- *
+ *
* CuckooFilter's can "saturate" and refuse to accept any new values. When this happens,
* the datastructure scales by adding a new filter. This new filter's bytes will be tracked
* in the registered breaker when configured.
diff --git a/server/src/main/java/org/opensearch/common/util/TokenBucket.java b/server/src/main/java/org/opensearch/common/util/TokenBucket.java
index d2e7e836bf07f..a9ebb86eed8a2 100644
--- a/server/src/main/java/org/opensearch/common/util/TokenBucket.java
+++ b/server/src/main/java/org/opensearch/common/util/TokenBucket.java
@@ -20,7 +20,7 @@
public class TokenBucket {
/**
* Defines a monotonically increasing counter.
- *
+ *
* Usage examples:
* 1. clock = System::nanoTime can be used to perform rate-limiting per unit time
* 2. clock = AtomicLong::get can be used to perform rate-limiting per unit number of operations
diff --git a/server/src/main/java/org/opensearch/common/util/URIPattern.java b/server/src/main/java/org/opensearch/common/util/URIPattern.java
index a3c385e5ea660..49e4b53e20740 100644
--- a/server/src/main/java/org/opensearch/common/util/URIPattern.java
+++ b/server/src/main/java/org/opensearch/common/util/URIPattern.java
@@ -39,9 +39,9 @@
/**
* URI Pattern matcher
- *
+ *
* The pattern is URI in which authority, path, query and fragment can be replace with simple pattern.
- *
+ *
* For example: foobar://*.local/some_path/*?*#* will match all uris with schema foobar in local domain
* with any port, with path that starts some_path and with any query and fragment.
*
diff --git a/server/src/main/java/org/opensearch/common/util/concurrent/ListenableFuture.java b/server/src/main/java/org/opensearch/common/util/concurrent/ListenableFuture.java
index b1f4714a90e8e..4357254176358 100644
--- a/server/src/main/java/org/opensearch/common/util/concurrent/ListenableFuture.java
+++ b/server/src/main/java/org/opensearch/common/util/concurrent/ListenableFuture.java
@@ -73,7 +73,7 @@ public void addListener(ActionListener listener, ExecutorService executor) {
* notified of a response or exception in a runnable submitted to the ExecutorService provided.
* If the future has completed, the listener will be notified immediately without forking to
* a different thread.
- *
+ *
* It will apply the provided ThreadContext (if not null) when executing the listening.
*/
public void addListener(ActionListener listener, ExecutorService executor, ThreadContext threadContext) {
diff --git a/server/src/main/java/org/opensearch/common/util/concurrent/PrioritizedOpenSearchThreadPoolExecutor.java b/server/src/main/java/org/opensearch/common/util/concurrent/PrioritizedOpenSearchThreadPoolExecutor.java
index b4673d9534922..95df4486b9d7b 100644
--- a/server/src/main/java/org/opensearch/common/util/concurrent/PrioritizedOpenSearchThreadPoolExecutor.java
+++ b/server/src/main/java/org/opensearch/common/util/concurrent/PrioritizedOpenSearchThreadPoolExecutor.java
@@ -118,8 +118,9 @@ private void addPending(List runnables, List pending, boolean
TieBreakingPrioritizedRunnable t = (TieBreakingPrioritizedRunnable) runnable;
Runnable innerRunnable = t.runnable;
if (innerRunnable != null) {
- /** innerRunnable can be null if task is finished but not removed from executor yet,
- * see {@link TieBreakingPrioritizedRunnable#run} and {@link TieBreakingPrioritizedRunnable#runAndClean}
+ /*
+ innerRunnable can be null if task is finished but not removed from executor yet,
+ see {@link TieBreakingPrioritizedRunnable#run} and {@link TieBreakingPrioritizedRunnable#runAndClean}
*/
pending.add(new Pending(super.unwrap(innerRunnable), t.priority(), t.insertionOrder, executing));
}
diff --git a/server/src/main/java/org/opensearch/common/util/concurrent/ThreadContext.java b/server/src/main/java/org/opensearch/common/util/concurrent/ThreadContext.java
index 4888d25e4a640..fc2e4217bae79 100644
--- a/server/src/main/java/org/opensearch/common/util/concurrent/ThreadContext.java
+++ b/server/src/main/java/org/opensearch/common/util/concurrent/ThreadContext.java
@@ -143,10 +143,10 @@ public void unregisterThreadContextStatePropagator(final ThreadContextStatePropa
*/
public StoredContext stashContext() {
final ThreadContextStruct context = threadLocal.get();
- /**
- * X-Opaque-ID should be preserved in a threadContext in order to propagate this across threads.
- * This is needed so the DeprecationLogger in another thread can see the value of X-Opaque-ID provided by a user.
- * Otherwise when context is stash, it should be empty.
+ /*
+ X-Opaque-ID should be preserved in a threadContext in order to propagate this across threads.
+ This is needed so the DeprecationLogger in another thread can see the value of X-Opaque-ID provided by a user.
+ Otherwise when context is stash, it should be empty.
*/
ThreadContextStruct threadContextStruct = DEFAULT_CONTEXT.putPersistent(context.persistentHeaders);
diff --git a/server/src/main/java/org/opensearch/common/xcontent/LoggingDeprecationHandler.java b/server/src/main/java/org/opensearch/common/xcontent/LoggingDeprecationHandler.java
index 06d139fa93195..05fc968737394 100644
--- a/server/src/main/java/org/opensearch/common/xcontent/LoggingDeprecationHandler.java
+++ b/server/src/main/java/org/opensearch/common/xcontent/LoggingDeprecationHandler.java
@@ -54,7 +54,7 @@ public class LoggingDeprecationHandler implements DeprecationHandler {
public static final LoggingDeprecationHandler INSTANCE = new LoggingDeprecationHandler();
/**
* The logger to which to send deprecation messages.
- *
+ *
* This uses ParseField's logger because that is the logger that
* we have been using for many releases for deprecated fields.
* Changing that will require some research to make super duper
diff --git a/server/src/main/java/org/opensearch/common/xcontent/XContentHelper.java b/server/src/main/java/org/opensearch/common/xcontent/XContentHelper.java
index 798a58551457f..17bb0a1de267b 100644
--- a/server/src/main/java/org/opensearch/common/xcontent/XContentHelper.java
+++ b/server/src/main/java/org/opensearch/common/xcontent/XContentHelper.java
@@ -494,7 +494,7 @@ public static BytesReference toXContent(ToXContent toXContent, XContentType xCon
/**
* Returns the contents of an object as an unparsed BytesReference
- *
+ *
* This is useful for things like mappings where we're copying bytes around but don't
* actually need to parse their contents, and so avoids building large maps of maps
* unnecessarily
diff --git a/server/src/main/java/org/opensearch/common/xcontent/support/XContentMapValues.java b/server/src/main/java/org/opensearch/common/xcontent/support/XContentMapValues.java
index adfa871cbfcbe..a87edbb949d39 100644
--- a/server/src/main/java/org/opensearch/common/xcontent/support/XContentMapValues.java
+++ b/server/src/main/java/org/opensearch/common/xcontent/support/XContentMapValues.java
@@ -117,12 +117,11 @@ private static void extractRawValues(List values, List