diff --git a/pom.xml b/pom.xml index eec7c5fd..bd798610 100644 --- a/pom.xml +++ b/pom.xml @@ -45,6 +45,37 @@ 1.21.4 + + + + maven-javadoc-plugin + 3.12.0 + + UTF-8 + UTF-8 + UTF-8 + + + + opensearch.api + a + OpenSearch API: + + + opensearch.internal + a + OpenSearch internal: + + + opensearch.experimental + a + OpenSearch experimental: + + + + + + maven-compiler-plugin @@ -160,12 +191,6 @@ maven-javadoc-plugin - 3.12.0 - - UTF-8 - UTF-8 - UTF-8 - attach-javadocs diff --git a/src/main/java/org/codelibs/fesen/opensearch/ExceptionsHelper.java b/src/main/java/org/codelibs/fesen/opensearch/ExceptionsHelper.java index 5b47fbde..33e112d0 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/ExceptionsHelper.java +++ b/src/main/java/org/codelibs/fesen/opensearch/ExceptionsHelper.java @@ -243,7 +243,7 @@ public static T useOrSuppress(T first, T second) { /** * Looks at the given Throwable and its cause(s) and returns the first Throwable that is of one of the given classes or {@code null} - * if no matching Throwable is found. Unlike {@link #unwrapCorruption} this method does only check the given Throwable and its causes + * if no matching Throwable is found. Unlike {@code #unwrapCorruption} this method does only check the given Throwable and its causes * but does not look at any suppressed exceptions. * @param t Throwable * @param clazzes Classes to look for diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/CompositeIndicesRequest.java b/src/main/java/org/codelibs/fesen/opensearch/action/CompositeIndicesRequest.java index d22d2978..e1d8dbb0 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/CompositeIndicesRequest.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/CompositeIndicesRequest.java @@ -35,8 +35,8 @@ /** * Marker interface that needs to be implemented by all {@link org.codelibs.fesen.opensearch.action.ActionRequest} subclasses that are composed of * multiple sub-requests which relate to one or more indices. A composite request is executed by its own transport action class - * (e.g. {@link org.codelibs.fesen.opensearch.action.search.TransportMultiSearchAction}), which goes through all sub-requests and delegates their - * execution to the appropriate transport action (e.g. {@link org.codelibs.fesen.opensearch.action.search.TransportSearchAction}) for each single item. + * (e.g. {@code org.codelibs.fesen.opensearch.action.search.TransportMultiSearchAction}), which goes through all sub-requests and delegates their + * execution to the appropriate transport action (e.g. {@code org.codelibs.fesen.opensearch.action.search.TransportSearchAction}) for each single item. * * @opensearch.internal */ diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/alias/IndicesAliasesRequest.java b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/alias/IndicesAliasesRequest.java index 601b2b2a..a85b4285 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/alias/IndicesAliasesRequest.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/alias/IndicesAliasesRequest.java @@ -150,21 +150,21 @@ public static Type fromValue(byte value) { } /** - * Build a new {@link AliasAction} to add aliases. + * Build a new {@code AliasAction} to add aliases. */ public static AliasActions add() { return new AliasActions(AliasActions.Type.ADD); } /** - * Build a new {@link AliasAction} to remove aliases. + * Build a new {@code AliasAction} to remove aliases. */ public static AliasActions remove() { return new AliasActions(AliasActions.Type.REMOVE); } /** - * Build a new {@link AliasAction} to remove an index. + * Build a new {@code AliasAction} to remove an index. */ public static AliasActions removeIndex() { return new AliasActions(AliasActions.Type.REMOVE_INDEX); @@ -225,7 +225,7 @@ private static ObjectParser parser(String name, Supplier PARSER = new ConstructingObjectParser<>("alias_action", a -> { // Take the first action and complain if there are more than one actions diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/create/CreateIndexRequest.java b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/create/CreateIndexRequest.java index 96647174..dd30cbf8 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/create/CreateIndexRequest.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/create/CreateIndexRequest.java @@ -75,12 +75,11 @@ import static org.codelibs.fesen.opensearch.common.settings.Settings.writeSettingsToStream; /** - * A request to create an index. Best created with {@link Requests#createIndexRequest(String)}. + * A request to create an index. Best created with {@code Requests#createIndexRequest(String)}. *

* The index created can optionally be created with {@link #settings(org.codelibs.fesen.opensearch.common.settings.Settings)}. * * @see IndicesAdminClient#create(CreateIndexRequest) - * @see Requests#createIndexRequest(String) * @see CreateIndexResponse * * @opensearch.api diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/delete/DeleteIndexRequest.java b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/delete/DeleteIndexRequest.java index de1c539a..51ae63f0 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/delete/DeleteIndexRequest.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/delete/DeleteIndexRequest.java @@ -46,7 +46,7 @@ import static org.codelibs.fesen.opensearch.action.ValidateActions.addValidationError; /** - * A request to delete an index. Best created with {@link Requests#deleteIndexRequest(String)}. + * A request to delete an index. Best created with {@code Requests#deleteIndexRequest(String)}. * * @opensearch.api */ diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/flush/FlushRequest.java b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/flush/FlushRequest.java index df00407a..32830887 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/flush/FlushRequest.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/flush/FlushRequest.java @@ -48,9 +48,8 @@ * by flushing data to the index storage and clearing the internal transaction log. By default, OpenSearch uses * memory heuristics in order to automatically trigger flush operations as required in order to clear memory. *

- * Best created with {@link Requests#flushRequest(String...)}. + * Best created with {@code Requests#flushRequest(String...)}. * - * @see Requests#flushRequest(String...) * @see IndicesAdminClient#flush(FlushRequest) * @see FlushResponse * diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/forcemerge/ForceMergeRequest.java b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/forcemerge/ForceMergeRequest.java index e18fa013..75189c22 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/forcemerge/ForceMergeRequest.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/forcemerge/ForceMergeRequest.java @@ -47,11 +47,10 @@ * A request to force merging the segments of one or more indices. In order to * run a merge on all the indices, pass an empty array or {@code null} for the * indices. - * {@link #maxNumSegments(int)} allows to control the number of segments + * {@code #maxNumSegments(int)} allows to control the number of segments * to force merge down to. Defaults to simply checking if a merge needs * to execute, and if so, executes it * - * @see Requests#forceMergeRequest(String...) * @see IndicesAdminClient#forceMerge(ForceMergeRequest) * @see ForceMergeResponse * diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/forcemerge/ForceMergeRequestBuilder.java b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/forcemerge/ForceMergeRequestBuilder.java index 428683e1..911a5bc3 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/forcemerge/ForceMergeRequestBuilder.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/forcemerge/ForceMergeRequestBuilder.java @@ -39,7 +39,7 @@ /** * A request to force merge one or more indices. In order to force merge all * indices, pass an empty array or {@code null} for the indices. - * {@link #setMaxNumSegments(int)} allows to control the number of segments to force + * {@code #setMaxNumSegments(int)} allows to control the number of segments to force * merge down to. By default, will cause the force merge process to merge down * to half the configured number of segments. * diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/mapping/put/PutMappingRequest.java b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/mapping/put/PutMappingRequest.java index 651086b7..2b7d9139 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/mapping/put/PutMappingRequest.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/mapping/put/PutMappingRequest.java @@ -68,12 +68,11 @@ /** * Puts mapping definition into one or more indices. Best created with - * {@link Requests#putMappingRequest(String...)}. + * {@code Requests#putMappingRequest(String...)}. *

* If the mappings already exists, the new mappings will be merged with the new one. If there are elements * that can't be merged are detected, the request will be rejected. * - * @see Requests#putMappingRequest(String...) * @see IndicesAdminClient#putMapping(PutMappingRequest) * @see AcknowledgedResponse * diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/refresh/RefreshRequest.java b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/refresh/RefreshRequest.java index 2306ab9f..b286935c 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/refresh/RefreshRequest.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/refresh/RefreshRequest.java @@ -44,7 +44,6 @@ * capabilities depends on the index engine used. For example, the internal one requires refresh to be called, but by * default a refresh is scheduled periodically. * - * @see Requests#refreshRequest(String...) * @see IndicesAdminClient#refresh(RefreshRequest) * @see RefreshResponse * diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/settings/get/GetSettingsResponse.java b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/settings/get/GetSettingsResponse.java index 1d0d4a6b..dd59bb7a 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/settings/get/GetSettingsResponse.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/settings/get/GetSettingsResponse.java @@ -76,7 +76,7 @@ public GetSettingsResponse(StreamInput in) throws IOException { /** * Returns a map of index name to {@link Settings} object. The returned {@link Settings} * objects contain only those settings explicitly set on a given index. Any settings - * taking effect as defaults must be accessed via {@link #getIndexToDefaultSettings()}. + * taking effect as defaults must be accessed via {@code #getIndexToDefaultSettings()}. */ public Map getIndexToSettings() { return indexToSettings; diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/shards/IndicesShardStoresAction.java b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/shards/IndicesShardStoresAction.java index 4e0d5349..2c196849 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/shards/IndicesShardStoresAction.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/shards/IndicesShardStoresAction.java @@ -35,7 +35,7 @@ import org.codelibs.fesen.opensearch.action.ActionType; /** - * ActionType for {@link TransportIndicesShardStoresAction} + * ActionType for {@code TransportIndicesShardStoresAction} * * Exposes shard store information for requested indices. * Shard store information reports which nodes hold shard copies, how recent they are diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/stats/IndicesStatsRequest.java b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/stats/IndicesStatsRequest.java index ccd3be8d..b4354e2f 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/stats/IndicesStatsRequest.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/stats/IndicesStatsRequest.java @@ -44,7 +44,7 @@ *

* By default, all statistics are enabled. *

- * All the stats to be returned can be cleared using {@link #clear()}, at which point, specific + * All the stats to be returned can be cleared using {@code #clear()}, at which point, specific * stats can be enabled. * * @opensearch.api diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/stats/IndicesStatsRequestBuilder.java b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/stats/IndicesStatsRequestBuilder.java index 342fefb8..0908f34b 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/stats/IndicesStatsRequestBuilder.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/stats/IndicesStatsRequestBuilder.java @@ -40,10 +40,10 @@ /** * A request to get indices level stats. Allow to enable different stats to be returned. *

- * By default, the {@link #setDocs(boolean)}, {@link #setStore(boolean)}, {@link #setIndexing(boolean)} + * By default, the {@code #setDocs(boolean)}, {@code #setStore(boolean)}, {@code #setIndexing(boolean)} * are enabled. Other stats can be enabled as well. *

- * All the stats to be returned can be cleared using {@link #clear()}, at which point, specific + * All the stats to be returned can be cleared using {@code #clear()}, at which point, specific * stats can be enabled. * * @opensearch.api diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/upgrade/post/UpgradeRequest.java b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/upgrade/post/UpgradeRequest.java index 5b09815e..60709b2a 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/upgrade/post/UpgradeRequest.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/admin/indices/upgrade/post/UpgradeRequest.java @@ -43,7 +43,6 @@ /** * A request to upgrade one or more indices. In order to update all indices, pass an empty array or * {@code null} for the indices. - * @see Requests#upgradeRequest(String...) * @see IndicesAdminClient#upgrade(UpgradeRequest) * @see UpgradeResponse * diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/bulk/BulkRequest.java b/src/main/java/org/codelibs/fesen/opensearch/action/bulk/BulkRequest.java index 92a83955..2fd65b47 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/bulk/BulkRequest.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/bulk/BulkRequest.java @@ -202,9 +202,9 @@ public RefreshPolicy getRefreshPolicy() { *

* - {@link BulkRequest#add(IndexRequest)} * - {@link BulkRequest#add(UpdateRequest)} - * - {@link BulkRequest#add(DocWriteRequest)} - * - {@link BulkRequest#add(DocWriteRequest[])} )} - * - {@link BulkRequest#add(Iterable)} + * - {@code BulkRequest#add(DocWriteRequest)} + * - {@code BulkRequest#add(DocWriteRequest[])} )} + * - {@code BulkRequest#add(Iterable)} * @param globalPipeline the global default setting * @return Bulk request with global setting set */ @@ -219,9 +219,9 @@ public final BulkRequest pipeline(String globalPipeline) { *

- {@link BulkRequest#add(IndexRequest)} - {@link BulkRequest#add(UpdateRequest)} - - {@link BulkRequest#add(DocWriteRequest)} - - {@link BulkRequest#add(DocWriteRequest[])} )} - - {@link BulkRequest#add(Iterable)} + - {@code BulkRequest#add(DocWriteRequest)} + - {@code BulkRequest#add(DocWriteRequest[])} )} + - {@code BulkRequest#add(Iterable)} * @param globalRouting the global default setting * @return Bulk request with global setting set */ @@ -252,9 +252,9 @@ public Boolean requireAlias() { *

* - {@link BulkRequest#add(IndexRequest)} * - {@link BulkRequest#add(UpdateRequest)} - * - {@link BulkRequest#add(DocWriteRequest)} - * - {@link BulkRequest#add(DocWriteRequest[])} )} - * - {@link BulkRequest#add(Iterable)} + * - {@code BulkRequest#add(DocWriteRequest)} + * - {@code BulkRequest#add(DocWriteRequest[])} )} + * - {@code BulkRequest#add(Iterable)} * @param globalRequireAlias the global default setting * @return Bulk request with global setting set */ diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/delete/DeleteRequest.java b/src/main/java/org/codelibs/fesen/opensearch/action/delete/DeleteRequest.java index 3d6baa3c..41f42fe6 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/delete/DeleteRequest.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/delete/DeleteRequest.java @@ -57,14 +57,13 @@ /** * A request to delete a document from an index based on its type and id. Best created using - * {@link Requests#deleteRequest(String)}. + * {@code Requests#deleteRequest(String)}. *

* The operation requires the {@link #index()}, and {@link #id(String)} to * be set. * * @see DeleteResponse * @see Client#delete(DeleteRequest) - * @see Requests#deleteRequest(String) * * @opensearch.api */ diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/fieldcaps/FieldCapabilitiesIndexResponse.java b/src/main/java/org/codelibs/fesen/opensearch/action/fieldcaps/FieldCapabilitiesIndexResponse.java index ee934de5..931bc732 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/fieldcaps/FieldCapabilitiesIndexResponse.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/fieldcaps/FieldCapabilitiesIndexResponse.java @@ -42,7 +42,7 @@ import java.util.Objects; /** - * Response for {@link TransportFieldCapabilitiesIndexAction}. + * Response for {@code TransportFieldCapabilitiesIndexAction}. * * @opensearch.internal */ diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/get/GetRequest.java b/src/main/java/org/codelibs/fesen/opensearch/action/get/GetRequest.java index cbf484a4..47ffbd7a 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/get/GetRequest.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/get/GetRequest.java @@ -55,13 +55,12 @@ /** * A request to get a document (its source) from an index based on its id. Best created using - * {@link Requests#getRequest(String)}. + * {@code Requests#getRequest(String)}. *

* The operation requires the {@link #index()}} and {@link #id(String)} * to be set. * * @see GetResponse - * @see Requests#getRequest(String) * @see Client#get(GetRequest) * * @opensearch.api diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/index/IndexRequest.java b/src/main/java/org/codelibs/fesen/opensearch/action/index/IndexRequest.java index 02d02155..cdd3af10 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/index/IndexRequest.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/index/IndexRequest.java @@ -75,19 +75,18 @@ /** * Index request to index a typed JSON document into a specific index and make it searchable. Best - * created using {@link Requests#indexRequest(String)}. + * created using {@code Requests#indexRequest(String)}. *

* The index requires the {@link #index()}, {@link #id(String)} and - * {@link #source(byte[], MediaType)} to be set. + * {@code #source(byte[], MediaType)} to be set. *

- * The source (content to index) can be set in its bytes form using ({@link #source(byte[], MediaType)}), + * The source (content to index) can be set in its bytes form using ({@code #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 - * @see Requests#indexRequest(String) * @see Client#index(IndexRequest) * * @opensearch.api @@ -128,7 +127,7 @@ public class IndexRequest extends ReplicatedWriteRequest implement private boolean requireAlias; /** - * Value for {@link #getAutoGeneratedTimestamp()} if the document has an external + * Value for {@code #getAutoGeneratedTimestamp()} if the document has an external * provided ID. */ public static final long UNSET_AUTO_GENERATED_TIMESTAMP = -1L; @@ -183,7 +182,7 @@ public IndexRequest() { /** * Constructs a new index request against the specific index. The - * {@link #source(byte[], MediaType)} must be set. + * {@code #source(byte[], MediaType)} must be set. */ public IndexRequest(String index) { super(NO_SHARD_ID); @@ -324,7 +323,7 @@ public BytesReference source() { } /** - * Index the Map in {@link Requests#INDEX_CONTENT_TYPE} format + * Index the Map in {@code Requests#INDEX_CONTENT_TYPE} format * * @param source The map to index */ @@ -351,7 +350,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)}. + * or using the {@code #source(byte[], MediaType)}. */ public IndexRequest source(String source, MediaType mediaType) { return source(new BytesArray(source), mediaType); @@ -365,7 +364,7 @@ public IndexRequest source(XContentBuilder sourceBuilder) { } /** - * Sets the content source to index using the default content type ({@link Requests#INDEX_CONTENT_TYPE}) + * Sets the content source to index using the default content type ({@code Requests#INDEX_CONTENT_TYPE}) *

* Note: the number of objects passed to this method must be an even * number. Also the first argument in each pair (the field name) must have a diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/index/IndexRequestBuilder.java b/src/main/java/org/codelibs/fesen/opensearch/action/index/IndexRequestBuilder.java index 4e262d2d..6fd4e36a 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/index/IndexRequestBuilder.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/index/IndexRequestBuilder.java @@ -96,7 +96,7 @@ public IndexRequestBuilder setSource(Map source, MediaType contentTyp * Sets the document source to index. *

* Note, its preferable to either set it using {@link #setSource(XContentBuilder)} - * or using the {@link #setSource(byte[], MediaType)}. + * or using the {@code #setSource(byte[], MediaType)}. */ public IndexRequestBuilder setSource(String source, MediaType mediaType) { request.source(source, mediaType); diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/search/SearchRequest.java b/src/main/java/org/codelibs/fesen/opensearch/action/search/SearchRequest.java index 9f9dbe02..8c6c5fc3 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/search/SearchRequest.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/search/SearchRequest.java @@ -66,13 +66,12 @@ /** * A request to execute search against one or more indices (or all). Best created using - * {@link Requests#searchRequest(String...)}. + * {@code Requests#searchRequest(String...)}. *

* Note, the search {@link #source(org.codelibs.fesen.opensearch.search.builder.SearchSourceBuilder)} * is required. The search source is the different search options, including aggregations and such. *

* - * @see Requests#searchRequest(String...) * @see Client#search(SearchRequest) * @see SearchResponse * diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/search/SearchRequestBuilder.java b/src/main/java/org/codelibs/fesen/opensearch/action/search/SearchRequestBuilder.java index bb8d37b2..62ae376a 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/search/SearchRequestBuilder.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/search/SearchRequestBuilder.java @@ -274,7 +274,7 @@ public SearchRequestBuilder highlighter(HighlightBuilder highlightBuilder) { /** * Clears all rescorers on the builder and sets the first one. To use multiple rescore windows use - * {@link #addRescorer(org.codelibs.fesen.opensearch.search.rescore.RescorerBuilder, int)}. + * {@code #addRescorer(org.codelibs.fesen.opensearch.search.rescore.RescorerBuilder, int)}. * * @param rescorer rescorer configuration * @param window rescore window diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/support/nodes/BaseNodesResponse.java b/src/main/java/org/codelibs/fesen/opensearch/action/support/nodes/BaseNodesResponse.java index 4a26ac9a..9c210b72 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/support/nodes/BaseNodesResponse.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/support/nodes/BaseNodesResponse.java @@ -91,7 +91,6 @@ public List failures() { * Get the successful node responses. * * @return Never {@code null}. Can be empty. - * @see #hasFailures() */ public List getNodes() { return nodes; diff --git a/src/main/java/org/codelibs/fesen/opensearch/action/support/replication/ReplicatedWriteRequest.java b/src/main/java/org/codelibs/fesen/opensearch/action/support/replication/ReplicatedWriteRequest.java index 3b0f7f4d..49adb8d9 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/action/support/replication/ReplicatedWriteRequest.java +++ b/src/main/java/org/codelibs/fesen/opensearch/action/support/replication/ReplicatedWriteRequest.java @@ -44,7 +44,7 @@ /** * Requests that are both {@linkplain ReplicationRequest}s (run on a shard's primary first, then the replica) and {@linkplain WriteRequest} - * (modify documents on a shard), for example {@link BulkShardRequest}, {@link IndexRequest}, and {@link DeleteRequest}. + * (modify documents on a shard), for example {@code BulkShardRequest}, {@link IndexRequest}, and {@link DeleteRequest}. * * @opensearch.internal */ diff --git a/src/main/java/org/codelibs/fesen/opensearch/cluster/ClusterInfo.java b/src/main/java/org/codelibs/fesen/opensearch/cluster/ClusterInfo.java index 01e9f594..53909b05 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/cluster/ClusterInfo.java +++ b/src/main/java/org/codelibs/fesen/opensearch/cluster/ClusterInfo.java @@ -86,7 +86,6 @@ protected ClusterInfo() { * @param shardSizes a shardkey to size in bytes mapping per shard. * @param routingToDataPath the shard routing to datapath mapping * @param reservedSpace reserved space per shard broken down by node and data path - * @see #shardIdentifierFromRouting */ public ClusterInfo( final Map leastAvailableSpaceUsage, diff --git a/src/main/java/org/codelibs/fesen/opensearch/cluster/block/ClusterBlocks.java b/src/main/java/org/codelibs/fesen/opensearch/cluster/block/ClusterBlocks.java index fdfb3ac0..2afbff59 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/cluster/block/ClusterBlocks.java +++ b/src/main/java/org/codelibs/fesen/opensearch/cluster/block/ClusterBlocks.java @@ -140,13 +140,6 @@ public boolean hasGlobalBlockWithStatus(final RestStatus status) { return false; } - /** - * Returns true iff non of the given have a {@link ClusterBlockLevel#METADATA_WRITE} in place where the - * {@link ClusterBlock#isAllowReleaseResources()} returns false. This is used in places where resources will be released - * like the deletion of an index to free up resources on nodes. - * @param indices the indices to check - */ - @Override public String toString() { if (global.isEmpty() && indices().isEmpty()) { diff --git a/src/main/java/org/codelibs/fesen/opensearch/cluster/metadata/IndexMetadata.java b/src/main/java/org/codelibs/fesen/opensearch/cluster/metadata/IndexMetadata.java index 3cf2b6d1..43980126 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/cluster/metadata/IndexMetadata.java +++ b/src/main/java/org/codelibs/fesen/opensearch/cluster/metadata/IndexMetadata.java @@ -2369,7 +2369,7 @@ public static Version indexCreated(final Settings indexSettings) { /** * Returns the number of shards that should be used for routing. This basically defines the hash space we use in - * {@link org.codelibs.fesen.opensearch.cluster.routing.OperationRouting#generateShardId(IndexMetadata, String, String)} to route documents + * {@code org.codelibs.fesen.opensearch.cluster.routing.OperationRouting#generateShardId(IndexMetadata, String, String)} to route documents * to shards based on their ID or their specific routing value. The default value is {@link #getNumberOfShards()}. This value only * changes if and index is shrunk. */ @@ -2380,7 +2380,7 @@ public int getRoutingNumShards() { /** * Returns the routing factor for and shrunk index with the given number of target shards. * This factor is used in the hash function in - * {@link org.codelibs.fesen.opensearch.cluster.routing.OperationRouting#generateShardId(IndexMetadata, String, String)} to guarantee consistent + * {@code org.codelibs.fesen.opensearch.cluster.routing.OperationRouting#generateShardId(IndexMetadata, String, String)} to guarantee consistent * hashing / routing of documents even if the number of shards changed (ie. a shrunk index). * * @param sourceNumberOfShards the total number of shards in the source index diff --git a/src/main/java/org/codelibs/fesen/opensearch/cluster/metadata/RepositoryMetadata.java b/src/main/java/org/codelibs/fesen/opensearch/cluster/metadata/RepositoryMetadata.java index 764f7935..d62cd15e 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/cluster/metadata/RepositoryMetadata.java +++ b/src/main/java/org/codelibs/fesen/opensearch/cluster/metadata/RepositoryMetadata.java @@ -138,7 +138,7 @@ public CryptoMetadata cryptoMetadata() { /** * Returns the safe repository generation. the repository data for this generation is assumed to exist in the repository. * All operations on the repository must be based on the the repository data at this generation. - * See package level documentation for the blob store based repositories {@link org.codelibs.fesen.opensearch.repositories.blobstore} for details + * See package level documentation for the blob store based repositories {@code org.codelibs.fesen.opensearch.repositories.blobstore} for details * on how this value is used during snapshots. * @return safe repository generation */ @@ -150,7 +150,7 @@ public long generation() { * Returns the pending repository generation. the repository data for this generation and all generations down to the safe * generation {@link #generation} may exist in the repository and should not be reused for writing new the repository data to the * repository. - * See package level documentation for the blob store based repositories {@link org.codelibs.fesen.opensearch.repositories.blobstore} for details + * See package level documentation for the blob store based repositories {@code org.codelibs.fesen.opensearch.repositories.blobstore} for details * on how this value is used during snapshots. * * @return highest pending repository generation diff --git a/src/main/java/org/codelibs/fesen/opensearch/cluster/routing/RoutingNodes.java b/src/main/java/org/codelibs/fesen/opensearch/cluster/routing/RoutingNodes.java index beab06d9..af8c5b9d 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/cluster/routing/RoutingNodes.java +++ b/src/main/java/org/codelibs/fesen/opensearch/cluster/routing/RoutingNodes.java @@ -73,10 +73,10 @@ *

* The main methods used to update routing entries are: *

    - *
  • {@link #initializeShard} initializes an unassigned shard. - *
  • {@link #startShard} starts an initializing shard / completes relocation of a shard. - *
  • {@link #relocateShard} starts relocation of a started shard. - *
  • {@link #failShard} fails/cancels an assigned shard. + *
  • {@code #initializeShard} initializes an unassigned shard. + *
  • {@code #startShard} starts an initializing shard / completes relocation of a shard. + *
  • {@code #relocateShard} starts relocation of a started shard. + *
  • {@code #failShard} fails/cancels an assigned shard. *
* * @opensearch.api @@ -353,8 +353,8 @@ public ShardRouting next() { /** * Unsupported operation, just there for the interface. Use - * {@link #removeAndIgnore(AllocationStatus, RoutingChangesObserver)} or - * {@link #initialize(String, String, long, RoutingChangesObserver)}. + * {@code #removeAndIgnore(AllocationStatus, RoutingChangesObserver)} or + * {@code #initialize(String, String, long, RoutingChangesObserver)}. */ @Override public void remove() { diff --git a/src/main/java/org/codelibs/fesen/opensearch/cluster/routing/WeightedRoutingStats.java b/src/main/java/org/codelibs/fesen/opensearch/cluster/routing/WeightedRoutingStats.java index ade539df..5a3800b7 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/cluster/routing/WeightedRoutingStats.java +++ b/src/main/java/org/codelibs/fesen/opensearch/cluster/routing/WeightedRoutingStats.java @@ -20,7 +20,7 @@ import java.util.concurrent.atomic.AtomicInteger; /** - * Captures weighted shard routing stats per node. See {@link WeightedRoutingService} for more details. + * Captures weighted shard routing stats per node. See {@code WeightedRoutingService} for more details. * * @opensearch.internal */ diff --git a/src/main/java/org/codelibs/fesen/opensearch/cluster/routing/allocation/MoveDecision.java b/src/main/java/org/codelibs/fesen/opensearch/cluster/routing/allocation/MoveDecision.java index 5c097cef..e3532fe0 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/cluster/routing/allocation/MoveDecision.java +++ b/src/main/java/org/codelibs/fesen/opensearch/cluster/routing/allocation/MoveDecision.java @@ -140,7 +140,7 @@ public boolean canRemain() { /** * Gets the current ranking of the node to which the shard is currently assigned, relative to the * other nodes in the cluster as reported in {@link NodeAllocationResult#getWeightRanking()}. The - * ranking will only return a meaningful positive integer if {@link #getClusterRebalanceDecision()} returns + * ranking will only return a meaningful positive integer if {@code #getClusterRebalanceDecision()} returns * a non-null value; otherwise, 0 will be returned. If {@link #isDecisionTaken()} returns * {@code false}, then invoking this method will throw an {@code IllegalStateException}. */ diff --git a/src/main/java/org/codelibs/fesen/opensearch/cluster/routing/allocation/ShardAllocationDecision.java b/src/main/java/org/codelibs/fesen/opensearch/cluster/routing/allocation/ShardAllocationDecision.java index a8592212..0da4e068 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/cluster/routing/allocation/ShardAllocationDecision.java +++ b/src/main/java/org/codelibs/fesen/opensearch/cluster/routing/allocation/ShardAllocationDecision.java @@ -43,15 +43,15 @@ /** * Represents the decision taken for the allocation of a single shard. If - * the shard is unassigned, {@link #getAllocateDecision()} will return an + * the shard is unassigned, {@code #getAllocateDecision()} will return an * object containing the decision and its explanation, and {@link #getMoveDecision()} * will return an object for which {@link MoveDecision#isDecisionTaken()} returns * {@code false}. If the shard is in the started state, then {@link #getMoveDecision()} * will return an object containing the decision to move/rebalance the shard, and - * {@link #getAllocateDecision()} will return an object for which + * {@code #getAllocateDecision()} will return an object for which * {@link AllocateUnassignedDecision#isDecisionTaken()} returns {@code false}. If * the shard is neither unassigned nor started (i.e. it is initializing or relocating), - * then both {@link #getAllocateDecision()} and {@link #getMoveDecision()} will return + * then both {@code #getAllocateDecision()} and {@link #getMoveDecision()} will return * objects whose {@code isDecisionTaken()} method returns {@code false}. * * @opensearch.api diff --git a/src/main/java/org/codelibs/fesen/opensearch/cluster/routing/allocation/decider/Decision.java b/src/main/java/org/codelibs/fesen/opensearch/cluster/routing/allocation/decider/Decision.java index dd05a6b4..bf7937a3 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/cluster/routing/allocation/decider/Decision.java +++ b/src/main/java/org/codelibs/fesen/opensearch/cluster/routing/allocation/decider/Decision.java @@ -53,8 +53,6 @@ * This abstract class defining basic {@link Decision} used during shard * allocation process. * - * @see AllocationDecider - * * @opensearch.api */ @PublicApi(since = "1.0.0") diff --git a/src/main/java/org/codelibs/fesen/opensearch/common/Booleans.java b/src/main/java/org/codelibs/fesen/opensearch/common/Booleans.java index 9492bdd0..e1d45f00 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/common/Booleans.java +++ b/src/main/java/org/codelibs/fesen/opensearch/common/Booleans.java @@ -137,7 +137,7 @@ public static boolean parseBoolean(String value) { * Parses a string representation of a boolean value to boolean. * Note the subtle difference between this and {@link #parseBoolean(char[], int, int, boolean)}; this returns the * default value even when the value is non-zero length containing all whitespaces (possibly overlooked, but - * preserving this behavior for compatibility reasons). Use {@link #parseBooleanStrict(String, boolean)} instead. + * preserving this behavior for compatibility reasons). Use {@code #parseBooleanStrict(String, boolean)} instead. * * @param value text to parse. * @param defaultValue The default value to return if the provided value is null or blank. diff --git a/src/main/java/org/codelibs/fesen/opensearch/common/inject/Provider.java b/src/main/java/org/codelibs/fesen/opensearch/common/inject/Provider.java index d2e3ba7d..a367d776 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/common/inject/Provider.java +++ b/src/main/java/org/codelibs/fesen/opensearch/common/inject/Provider.java @@ -43,10 +43,10 @@ * instances, instances you wish to safely mutate and discard, instances which are out of scope * (e.g. using a {@code @RequestScoped} object from within a {@code @SessionScoped} object), or * instances that will be initialized lazily. - *
  • A custom {@link Scope} is implemented as a decorator of {@code Provider}, which decides + *
  • A custom {@code Scope} is implemented as a decorator of {@code Provider}, which decides * when to delegate to the backing provider and when to provide the instance some other way. - *
  • The {@link Injector} offers access to the {@code Provider} it uses to fulfill requests - * for a given key, via the {@link Injector#getProvider} methods. + *
  • The {@code Injector} offers access to the {@code Provider} it uses to fulfill requests + * for a given key, via the {@code Injector#getProvider} methods. * * * @param the type of object this provides @@ -60,10 +60,10 @@ public interface Provider { /** * Provides an instance of {@code T}. Must never return {@code null}. * - * @throws OutOfScopeException when an attempt is made to access a scoped object while the scope - * in question is not currently active - * @throws ProvisionException if an instance cannot be provided. Such exceptions include messages - * and throwables to describe why provision failed. + *

    Throws {@code OutOfScopeException} when an attempt is made to access a scoped object + * while the scope in question is not currently active, and {@code ProvisionException} if an + * instance cannot be provided. Such exceptions include messages and throwables to describe + * why provision failed. */ T get(); } diff --git a/src/main/java/org/codelibs/fesen/opensearch/common/logging/DeprecationLogger.java b/src/main/java/org/codelibs/fesen/opensearch/common/logging/DeprecationLogger.java index eef0769a..35b8f9ce 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/common/logging/DeprecationLogger.java +++ b/src/main/java/org/codelibs/fesen/opensearch/common/logging/DeprecationLogger.java @@ -44,10 +44,10 @@ * deprecation logger defined in log4j2.properties. *

    * Logs are emitted at the custom {@link #DEPRECATION} level, and routed wherever they need to go using log4j. For example, - * to disk using a rolling file appender, or added as a response header using {@link HeaderWarningAppender}. + * to disk using a rolling file appender, or added as a response header using {@code HeaderWarningAppender}. *

    * Deprecation messages include a key, which is used for rate-limiting purposes. The log4j configuration - * uses {@link RateLimitingFilter} to prevent the same message being logged repeatedly in a short span of time. This + * uses {@code RateLimitingFilter} to prevent the same message being logged repeatedly in a short span of time. This * key is combined with the X-Opaque-Id request header value, if supplied, which allows for per-client * message limiting. * diff --git a/src/main/java/org/codelibs/fesen/opensearch/common/settings/SecureSettings.java b/src/main/java/org/codelibs/fesen/opensearch/common/settings/SecureSettings.java index ae170f00..0f8b1eb6 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/common/settings/SecureSettings.java +++ b/src/main/java/org/codelibs/fesen/opensearch/common/settings/SecureSettings.java @@ -42,7 +42,7 @@ import java.util.Set; /** - * An accessor for settings which are securely stored. See {@link SecureSetting}. + * An accessor for settings which are securely stored. See {@code SecureSetting}. * * @opensearch.api */ diff --git a/src/main/java/org/codelibs/fesen/opensearch/common/settings/SettingsFilter.java b/src/main/java/org/codelibs/fesen/opensearch/common/settings/SettingsFilter.java index b466e330..c89906b6 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/common/settings/SettingsFilter.java +++ b/src/main/java/org/codelibs/fesen/opensearch/common/settings/SettingsFilter.java @@ -71,7 +71,6 @@ public SettingsFilter(Collection patterns) { /** * Returns true iff the given string is either a valid settings key pattern or a simple regular expression * @see Regex - * @see AbstractScopedSettings#isValidKey(String) */ public static boolean isValidPattern(String pattern) { return pattern != null || Regex.isSimpleMatchPattern(pattern); diff --git a/src/main/java/org/codelibs/fesen/opensearch/common/unit/DistanceUnit.java b/src/main/java/org/codelibs/fesen/opensearch/common/unit/DistanceUnit.java index bb4b38ff..983f8355 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/common/unit/DistanceUnit.java +++ b/src/main/java/org/codelibs/fesen/opensearch/common/unit/DistanceUnit.java @@ -42,7 +42,7 @@ /** * The DistanceUnit enumerates several units for measuring distances. These units * provide methods for converting strings and methods to convert units among each - * others. Some methods like {@link DistanceUnit#getEarthCircumference} refer to + * others. Some methods like {@code DistanceUnit#getEarthCircumference} refer to * the earth ellipsoid defined in {@link GeoUtils}. The default unit used within * this project is METERS which is defined by DEFAULT * diff --git a/src/main/java/org/codelibs/fesen/opensearch/common/util/BinarySearcher.java b/src/main/java/org/codelibs/fesen/opensearch/common/util/BinarySearcher.java index fe9c95d1..c3cf752e 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/common/util/BinarySearcher.java +++ b/src/main/java/org/codelibs/fesen/opensearch/common/util/BinarySearcher.java @@ -40,7 +40,7 @@ * {@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. + * Refer to {@code BigArrays.DoubleBinarySearcher} for an example. *

    * NOTE: this class is not thread safe * diff --git a/src/main/java/org/codelibs/fesen/opensearch/common/util/concurrent/OpenSearchThreadPoolExecutor.java b/src/main/java/org/codelibs/fesen/opensearch/common/util/concurrent/OpenSearchThreadPoolExecutor.java index 87aeb2fc..844f038c 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/common/util/concurrent/OpenSearchThreadPoolExecutor.java +++ b/src/main/java/org/codelibs/fesen/opensearch/common/util/concurrent/OpenSearchThreadPoolExecutor.java @@ -209,7 +209,7 @@ protected Runnable unwrap(Runnable runnable) { /** * Returns the cumulative wait time of the ThreadPool. If the ThreadPool does not support tracking the cumulative pool wait time * then this should return -1 which will prevent the value from showing up in {@link org.codelibs.fesen.opensearch.threadpool.ThreadPoolStats}. - * ThreadPools that do support this metric should override this method. For example, {@link QueueResizingOpenSearchThreadPoolExecutor} + * ThreadPools that do support this metric should override this method. For example, {@code QueueResizingOpenSearchThreadPoolExecutor} * does so using the {@link TimedRunnable} to get the difference between Runnable creation and execution. * */ diff --git a/src/main/java/org/codelibs/fesen/opensearch/common/util/concurrent/ThreadContext.java b/src/main/java/org/codelibs/fesen/opensearch/common/util/concurrent/ThreadContext.java index 9df951da..42a771ee 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/common/util/concurrent/ThreadContext.java +++ b/src/main/java/org/codelibs/fesen/opensearch/common/util/concurrent/ThreadContext.java @@ -77,7 +77,7 @@ * Consumers of ThreadContext usually don't need to interact with adding or stashing contexts. Every opensearch thread is managed by * a thread pool or executor being responsible for stashing and restoring the threads context. For instance if a network request is * received, all headers are deserialized from the network and directly added as the headers of the threads {@link ThreadContext} - * (see {@link #readHeaders(StreamInput)}. In order to not modify the context that is currently active on this thread the network code + * (see {@code #readHeaders(StreamInput)}. In order to not modify the context that is currently active on this thread the network code * uses a try/with pattern to stash it's current context, read headers into a fresh one and once the request is handled or a handler thread * is forked (which in turn inherits the context) it restores the previous context. For instance: *

    diff --git a/src/main/java/org/codelibs/fesen/opensearch/common/util/io/IOUtils.java b/src/main/java/org/codelibs/fesen/opensearch/common/util/io/IOUtils.java index 23eaa782..ed91ab03 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/common/util/io/IOUtils.java +++ b/src/main/java/org/codelibs/fesen/opensearch/common/util/io/IOUtils.java @@ -70,7 +70,6 @@ private IOUtils() { } /** - * @see #close(Closeable...) */ public static void close(@Nullable Closeable closeable) throws IOException { if (closeable != null) { @@ -110,7 +109,6 @@ public static void close(final Iterable objects) throws IOE * @param ex existing Exception to add exceptions occurring during close to * @param objects objects to close * - * @see #close(Closeable...) */ public static void close(final Exception ex, final Iterable objects) throws IOException { Exception firstException = ex; @@ -137,7 +135,6 @@ public static void close(final Exception ex, final Iterable } /** - * @see #closeWhileHandlingException(Closeable...) */ public static void closeWhileHandlingException(final Closeable closeable) { // noinspection EmptyCatchBlock diff --git a/src/main/java/org/codelibs/fesen/opensearch/common/xcontent/XContentHelper.java b/src/main/java/org/codelibs/fesen/opensearch/common/xcontent/XContentHelper.java index 320d1438..65a97eff 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/common/xcontent/XContentHelper.java +++ b/src/main/java/org/codelibs/fesen/opensearch/common/xcontent/XContentHelper.java @@ -290,7 +290,7 @@ private static String toJsonString(boolean prettyPrint, XContentParser parser) t /** * Writes a "raw" (bytes) field, handling cases where the bytes are compressed, and tries to optimize writing using * {@link XContentBuilder#rawField(String, InputStream)}. - * @deprecated use {@link #writeRawField(String, BytesReference, XContentType, XContentBuilder, Params)} to avoid content type + * @deprecated use {@code #writeRawField(String, BytesReference, XContentType, XContentBuilder, Params)} to avoid content type * auto-detection */ @Deprecated diff --git a/src/main/java/org/codelibs/fesen/opensearch/core/xcontent/NamedXContentRegistry.java b/src/main/java/org/codelibs/fesen/opensearch/core/xcontent/NamedXContentRegistry.java index 3784603c..626ba8f8 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/core/xcontent/NamedXContentRegistry.java +++ b/src/main/java/org/codelibs/fesen/opensearch/core/xcontent/NamedXContentRegistry.java @@ -79,7 +79,7 @@ public static class Entry { /** * Creates a new entry which can be stored by the registry. - * Prefer {@link Entry#Entry(Class, ParseField, CheckedFunction)} unless you need a context to carry around while parsing. + * Prefer {@code Entry#Entry(Class, ParseField, CheckedFunction)} unless you need a context to carry around while parsing. */ public Entry(Class categoryClass, ParseField name, ContextParser parser) { this.categoryClass = Objects.requireNonNull(categoryClass); diff --git a/src/main/java/org/codelibs/fesen/opensearch/index/query/GeoShapeQueryBuilder.java b/src/main/java/org/codelibs/fesen/opensearch/index/query/GeoShapeQueryBuilder.java index e5e17080..56e203c8 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/index/query/GeoShapeQueryBuilder.java +++ b/src/main/java/org/codelibs/fesen/opensearch/index/query/GeoShapeQueryBuilder.java @@ -52,7 +52,7 @@ /** * Derived {@link AbstractGeometryQueryBuilder} that builds a lat, lon GeoShape Query. It - * can be applied to any {@link MappedFieldType} that implements {@link GeoShapeQueryable}. + * can be applied to any {@code MappedFieldType} that implements {@code GeoShapeQueryable}. *

    * GeoJson and WKT shape definitions are supported * diff --git a/src/main/java/org/codelibs/fesen/opensearch/index/query/Rewriteable.java b/src/main/java/org/codelibs/fesen/opensearch/index/query/Rewriteable.java index 501ca1ba..51e5449f 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/index/query/Rewriteable.java +++ b/src/main/java/org/codelibs/fesen/opensearch/index/query/Rewriteable.java @@ -71,7 +71,7 @@ static > T rewrite(T original, QueryRewriteContext cont /** * Rewrites the given {@link Rewriteable} into its primitive form. Rewriteables that for instance fetch resources from remote hosts or * can simplify / optimize itself should do their heavy lifting during - * {@link #rewriteAndFetch(Rewriteable, QueryRewriteContext, ActionListener)} (QueryRewriteContext)}. This method rewrites the + * {@code #rewriteAndFetch(Rewriteable, QueryRewriteContext, ActionListener)} (QueryRewriteContext)}. This method rewrites the * rewriteable until it doesn't change anymore. * @param original the original rewriteable to rewrite * @param context the rewrite context to use diff --git a/src/main/java/org/codelibs/fesen/opensearch/index/reindex/AbstractBulkByScrollRequest.java b/src/main/java/org/codelibs/fesen/opensearch/index/reindex/AbstractBulkByScrollRequest.java index b953a086..2f90a4d2 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/index/reindex/AbstractBulkByScrollRequest.java +++ b/src/main/java/org/codelibs/fesen/opensearch/index/reindex/AbstractBulkByScrollRequest.java @@ -277,7 +277,7 @@ public ActiveShardCount getWaitForActiveShards() { /** * Sets the number of shard copies that must be active before proceeding with the write. - * See {@link ReplicationRequest#waitForActiveShards(ActiveShardCount)} for details. + * See {@code ReplicationRequest#waitForActiveShards(ActiveShardCount)} for details. */ public Self setWaitForActiveShards(ActiveShardCount activeShardCount) { this.activeShardCount = activeShardCount; diff --git a/src/main/java/org/codelibs/fesen/opensearch/index/reindex/BulkByScrollTask.java b/src/main/java/org/codelibs/fesen/opensearch/index/reindex/BulkByScrollTask.java index 6395c4c2..65dc5212 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/index/reindex/BulkByScrollTask.java +++ b/src/main/java/org/codelibs/fesen/opensearch/index/reindex/BulkByScrollTask.java @@ -77,12 +77,12 @@ * When the request is not sliced, this task is the only task created, and starts an action to perform search requests. *

    * When the request is sliced, this task can either represent a coordinating task (using - * {@link BulkByScrollTask#setWorkerCount(int)}) or a worker task that performs search queries (using - * {@link BulkByScrollTask#setWorker(float, Integer)}). + * {@code BulkByScrollTask#setWorkerCount(int)}) or a worker task that performs search queries (using + * {@code BulkByScrollTask#setWorker(float, Integer)}). *

    * We don't always know if this task will be a leader or worker task when it's created, because if slices is set to "auto" it may * be either depending on the number of shards in the source indices. We figure that out when the request is handled and set it on this - * class with {@link #setWorkerCount(int)} or {@link #setWorker(float, Integer)}. + * class with {@code #setWorkerCount(int)} or {@code #setWorker(float, Integer)}. * * @opensearch.internal */ diff --git a/src/main/java/org/codelibs/fesen/opensearch/index/remote/RemoteSegmentTransferTracker.java b/src/main/java/org/codelibs/fesen/opensearch/index/remote/RemoteSegmentTransferTracker.java index d1bfd36d..72a09d5d 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/index/remote/RemoteSegmentTransferTracker.java +++ b/src/main/java/org/codelibs/fesen/opensearch/index/remote/RemoteSegmentTransferTracker.java @@ -34,7 +34,7 @@ /** - * Keeps track of remote refresh which happens in {@link org.codelibs.fesen.opensearch.index.shard.RemoteStoreRefreshListener}. This consist of multiple critical metrics. + * Keeps track of remote refresh which happens in {@code org.codelibs.fesen.opensearch.index.shard.RemoteStoreRefreshListener}. This consist of multiple critical metrics. * * @opensearch.api */ diff --git a/src/main/java/org/codelibs/fesen/opensearch/index/store/remote/filecache/AggregateFileCacheStats.java b/src/main/java/org/codelibs/fesen/opensearch/index/store/remote/filecache/AggregateFileCacheStats.java index 9f2ffb89..1ba996ad 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/index/store/remote/filecache/AggregateFileCacheStats.java +++ b/src/main/java/org/codelibs/fesen/opensearch/index/store/remote/filecache/AggregateFileCacheStats.java @@ -21,7 +21,7 @@ /** * Statistics for the file cache system that tracks memory usage and performance metrics. - * {@link FileCache} internally uses a {@link org.codelibs.fesen.opensearch.index.store.remote.utils.cache.SegmentedCache} + * {@code FileCache} internally uses a {@code org.codelibs.fesen.opensearch.index.store.remote.utils.cache.SegmentedCache} * to manage cached file data in memory segments. * This class aggregates statistics across all cache segments including: * - Memory usage (total, active, used) diff --git a/src/main/java/org/codelibs/fesen/opensearch/ingest/IngestDocument.java b/src/main/java/org/codelibs/fesen/opensearch/ingest/IngestDocument.java index 870c680b..4f012279 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/ingest/IngestDocument.java +++ b/src/main/java/org/codelibs/fesen/opensearch/ingest/IngestDocument.java @@ -83,7 +83,7 @@ public IngestDocument(Map sourceAndMetadata, Map } /** - * Does the same thing as {@link #extractMetadata} but does not mutate the map. + * Does the same thing as {@code #extractMetadata} but does not mutate the map. */ public Map getMetadata() { Map metadataMap = new EnumMap<>(Metadata.class); @@ -95,16 +95,16 @@ public Map getMetadata() { /** * Returns the available ingest metadata fields, by default only timestamp, but it is possible to set additional ones. - * Use only for reading values, modify them instead using {@link #setFieldValue(String, Object)} and {@link #removeField(String)} + * Use only for reading values, modify them instead using {@code #setFieldValue(String, Object)} and {@code #removeField(String)} */ public Map getIngestMetadata() { return this.ingestMetadata; } /** - * Returns the document including its metadata fields, unless {@link #extractMetadata()} has been called, in which case the + * Returns the document including its metadata fields, unless {@code #extractMetadata()} has been called, in which case the * metadata fields will not be present anymore. - * Modify the document instead using {@link #setFieldValue(String, Object)} and {@link #removeField(String)} + * Modify the document instead using {@code #setFieldValue(String, Object)} and {@code #removeField(String)} */ public Map getSourceAndMetadata() { return this.sourceAndMetadata; diff --git a/src/main/java/org/codelibs/fesen/opensearch/plugins/BlockCacheStats.java b/src/main/java/org/codelibs/fesen/opensearch/plugins/BlockCacheStats.java index ca18d1ec..714b5451 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/plugins/BlockCacheStats.java +++ b/src/main/java/org/codelibs/fesen/opensearch/plugins/BlockCacheStats.java @@ -18,7 +18,7 @@ import java.io.IOException; /** - * Point-in-time snapshot of {@link BlockCache} counters. + * Point-in-time snapshot of {@code BlockCache} counters. * *

    Emitted for node-stats reporting and merging into * {@link org.codelibs.fesen.opensearch.index.store.remote.filecache.AggregateFileCacheStats}. diff --git a/src/main/java/org/codelibs/fesen/opensearch/script/ScriptContext.java b/src/main/java/org/codelibs/fesen/opensearch/script/ScriptContext.java index 0f7c4577..d1bdcb65 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/script/ScriptContext.java +++ b/src/main/java/org/codelibs/fesen/opensearch/script/ScriptContext.java @@ -42,14 +42,14 @@ * The information necessary to compile and run a script. *

    * A {@link ScriptContext} contains the information related to a single use case and the interfaces - * and methods necessary for a {@link ScriptEngine} to implement. + * and methods necessary for a {@code ScriptEngine} to implement. *

    * There are at least two (and optionally a third) related classes which must be defined. *

    * The InstanceType is a class which users of the script api call to execute a script. It * may be stateful. Instances of * the InstanceType may be executed multiple times by a caller with different arguments. This - * class must have an abstract method named {@code execute} which {@link ScriptEngine} implementations + * class must have an abstract method named {@code execute} which {@code ScriptEngine} implementations * will define. *

    * The FactoryType is a factory class returned by the {@link ScriptService} when compiling diff --git a/src/main/java/org/codelibs/fesen/opensearch/script/ScriptType.java b/src/main/java/org/codelibs/fesen/opensearch/script/ScriptType.java index 43483766..0e5962aa 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/script/ScriptType.java +++ b/src/main/java/org/codelibs/fesen/opensearch/script/ScriptType.java @@ -55,7 +55,7 @@ public enum ScriptType implements Writeable { * INLINE scripts are specified in numerous queries and compiled on-the-fly. * They will be cached based on the lang and code of the script. * They are turned off by default because most languages are insecure - * (Groovy and others), but can be overridden by the specific {@link ScriptEngine} + * (Groovy and others), but can be overridden by the specific {@code ScriptEngine} * if the language is naturally secure (Painless, Mustache, and Expressions). */ INLINE(0, new ParseField("source", "inline")), @@ -64,7 +64,7 @@ public enum ScriptType implements Writeable { * STORED scripts are saved as part of the {@link org.codelibs.fesen.opensearch.cluster.ClusterState} * based on user requests. They will be cached when they are first used in a query. * They are turned off by default because most languages are insecure - * (Groovy and others), but can be overridden by the specific {@link ScriptEngine} + * (Groovy and others), but can be overridden by the specific {@code ScriptEngine} * if the language is naturally secure (Painless, Mustache, and Expressions). */ STORED(1, new ParseField("id", "stored")); diff --git a/src/main/java/org/codelibs/fesen/opensearch/script/StoredScriptSource.java b/src/main/java/org/codelibs/fesen/opensearch/script/StoredScriptSource.java index 60bf7749..6be45044 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/script/StoredScriptSource.java +++ b/src/main/java/org/codelibs/fesen/opensearch/script/StoredScriptSource.java @@ -207,7 +207,7 @@ private StoredScriptSource build(boolean ignoreEmpty) { * } *

    * The above format requires the lang to be specified using the deprecated stored script namespace - * (as a url parameter during a put request). See {@link ScriptMetadata} for more information about + * (as a url parameter during a put request). See {@code ScriptMetadata} for more information about * the stored script namespaces. *

    * The complex script format using the new stored script namespace diff --git a/src/main/java/org/codelibs/fesen/opensearch/search/SearchExtBuilder.java b/src/main/java/org/codelibs/fesen/opensearch/search/SearchExtBuilder.java index 5ed53515..f5406087 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/search/SearchExtBuilder.java +++ b/src/main/java/org/codelibs/fesen/opensearch/search/SearchExtBuilder.java @@ -51,9 +51,7 @@ * the incoming request from the REST layer into the proper {@link SearchExtBuilder} subclass. *

    * {@link #getWriteableName()} must return the same name as the one used for the registration - * of the {@link SearchExtSpec}. - * - * @see SearchExtSpec + * of the {@code SearchExtSpec}. * * @opensearch.api */ diff --git a/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/AggregationBuilder.java b/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/AggregationBuilder.java index 0941efb2..9700f814 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/AggregationBuilder.java +++ b/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/AggregationBuilder.java @@ -153,7 +153,7 @@ protected AggregationBuilder doRewrite(QueryRewriteContext queryShardContext) th * by this builder will contain per parent bucket used to validate sorts * and pipeline aggregations. Just "zero", "one", and "many". *

    - * Unlike {@link CardinalityUpperBound} which is total + * Unlike {@code CardinalityUpperBound} which is total * instead of per parent bucket. * * @opensearch.api diff --git a/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/BucketOrder.java b/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/BucketOrder.java index bca8e016..a24cbd5e 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/BucketOrder.java +++ b/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/BucketOrder.java @@ -49,7 +49,7 @@ * {@link Bucket} ordering strategy. Buckets can be order either as * "complete" buckets using {@link #comparator()} or against a combination * of the buckets internals with its ordinal with - * {@link #partiallyBuiltBucketComparator(ToLongFunction, Aggregator)}. + * {@code #partiallyBuiltBucketComparator(ToLongFunction, Aggregator)}. * * @opensearch.internal */ diff --git a/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/InternalAggregations.java b/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/InternalAggregations.java index aa5c5577..0502c615 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/InternalAggregations.java +++ b/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/InternalAggregations.java @@ -127,7 +127,7 @@ public double sortValue(AggregationPath.PathElement head, Iterator aggregationsList, ReduceContext context) { if (aggregationsList.isEmpty()) { diff --git a/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/bucket/composite/DateHistogramValuesSourceBuilder.java b/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/bucket/composite/DateHistogramValuesSourceBuilder.java index aee9cf10..abbfb938 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/bucket/composite/DateHistogramValuesSourceBuilder.java +++ b/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/bucket/composite/DateHistogramValuesSourceBuilder.java @@ -57,7 +57,7 @@ import org.codelibs.fesen.opensearch.search.aggregations.support.CoreValuesSourceType; /** - * A {@link CompositeValuesSourceBuilder} that builds a {@link RoundingValuesSource} from a {@link Script} or + * A {@link CompositeValuesSourceBuilder} that builds a {@code RoundingValuesSource} from a {@link Script} or * a field name using the provided interval. * * @opensearch.internal diff --git a/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/bucket/composite/HistogramValuesSourceBuilder.java b/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/bucket/composite/HistogramValuesSourceBuilder.java index 4e446e1b..b1b81315 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/bucket/composite/HistogramValuesSourceBuilder.java +++ b/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/bucket/composite/HistogramValuesSourceBuilder.java @@ -48,7 +48,7 @@ import org.codelibs.fesen.opensearch.search.aggregations.support.CoreValuesSourceType; /** - * A {@link CompositeValuesSourceBuilder} that builds a {@link HistogramValuesSource} from another numeric values source + * A {@link CompositeValuesSourceBuilder} that builds a {@code HistogramValuesSource} from another numeric values source * using the provided interval. * * @opensearch.internal diff --git a/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/metrics/GeoCentroid.java b/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/metrics/GeoCentroid.java index ff0971f4..b5601859 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/metrics/GeoCentroid.java +++ b/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/metrics/GeoCentroid.java @@ -36,7 +36,7 @@ import org.codelibs.fesen.opensearch.search.aggregations.Aggregation; /** - * Interface for {@link GeoCentroidAggregator} + * Interface for {@code GeoCentroidAggregator} * * @opensearch.internal */ diff --git a/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/metrics/ParsedGeoCentroid.java b/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/metrics/ParsedGeoCentroid.java index 2275bec6..e8fa3d1a 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/metrics/ParsedGeoCentroid.java +++ b/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/metrics/ParsedGeoCentroid.java @@ -42,7 +42,7 @@ import java.io.IOException; /** - * Serialization and merge logic for {@link GeoCentroidAggregator}. + * Serialization and merge logic for {@code GeoCentroidAggregator}. * * @opensearch.internal */ diff --git a/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/pipeline/BucketMetricsParser.java b/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/pipeline/BucketMetricsParser.java index 1d352652..787cefb0 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/pipeline/BucketMetricsParser.java +++ b/src/main/java/org/codelibs/fesen/opensearch/search/aggregations/pipeline/BucketMetricsParser.java @@ -44,7 +44,7 @@ import java.util.Map; /** - * A parser for parsing requests for a {@link BucketMetricsPipelineAggregator} + * A parser for parsing requests for a {@code BucketMetricsPipelineAggregator} * * @opensearch.internal */ diff --git a/src/main/java/org/codelibs/fesen/opensearch/search/builder/SearchSourceBuilder.java b/src/main/java/org/codelibs/fesen/opensearch/search/builder/SearchSourceBuilder.java index fe77f047..e4b7fda4 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/search/builder/SearchSourceBuilder.java +++ b/src/main/java/org/codelibs/fesen/opensearch/search/builder/SearchSourceBuilder.java @@ -89,7 +89,7 @@ /** * A search source builder allowing to easily build search source. Simple * construction using - * {@link org.codelibs.fesen.opensearch.search.builder.SearchSourceBuilder#searchSource()}. + * {@code org.codelibs.fesen.opensearch.search.builder.SearchSourceBuilder#searchSource()}. * * @see org.codelibs.fesen.opensearch.action.search.SearchRequest#source(SearchSourceBuilder) * @@ -746,14 +746,14 @@ public SearchSourceBuilder pointInTimeBuilder(PointInTimeBuilder builder) { } /** - * @return a search pipeline defined within the search source (see {@link org.codelibs.fesen.opensearch.search.pipeline.SearchPipelineService}) + * @return a search pipeline defined within the search source (see {@code org.codelibs.fesen.opensearch.search.pipeline.SearchPipelineService}) */ public Map searchPipelineSource() { return searchPipelineSource; } /** - * Define a search pipeline to process this search request and/or its response. See {@link org.codelibs.fesen.opensearch.search.pipeline.SearchPipelineService}. + * Define a search pipeline to process this search request and/or its response. See {@code org.codelibs.fesen.opensearch.search.pipeline.SearchPipelineService}. */ public SearchSourceBuilder searchPipelineSource(Map searchPipelineSource) { this.searchPipelineSource = searchPipelineSource; @@ -857,7 +857,7 @@ private SearchSourceBuilder shallowCopy( /** * Parse some xContent into this SearchSourceBuilder, overwriting any values specified in the xContent. Use this if you need to set up - * different defaults than a regular SearchSourceBuilder would have and use {@link #fromXContent(XContentParser, boolean)} if you have + * different defaults than a regular SearchSourceBuilder would have and use {@code #fromXContent(XContentParser, boolean)} if you have * normal defaults. * * @param parser The xContent parser. diff --git a/src/main/java/org/codelibs/fesen/opensearch/search/fetch/subphase/highlight/HighlightBuilder.java b/src/main/java/org/codelibs/fesen/opensearch/search/fetch/subphase/highlight/HighlightBuilder.java index 94218a53..b28fd7a1 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/search/fetch/subphase/highlight/HighlightBuilder.java +++ b/src/main/java/org/codelibs/fesen/opensearch/search/fetch/subphase/highlight/HighlightBuilder.java @@ -65,8 +65,6 @@ * A builder for search highlighting. Settings can control how large fields * are summarized to show only selected snippets ("fragments") containing search terms. * - * @see org.codelibs.fesen.opensearch.search.builder.SearchSourceBuilder#highlight() - * * @opensearch.api */ @PublicApi(since = "1.0.0") diff --git a/src/main/java/org/codelibs/fesen/opensearch/search/slice/SliceBuilder.java b/src/main/java/org/codelibs/fesen/opensearch/search/slice/SliceBuilder.java index 239f81d8..601bd05f 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/search/slice/SliceBuilder.java +++ b/src/main/java/org/codelibs/fesen/opensearch/search/slice/SliceBuilder.java @@ -56,14 +56,14 @@ /** * A slice builder allowing to split a scroll in multiple partitions. - * If the provided field is the "_uid" it uses a {@link org.codelibs.fesen.opensearch.search.slice.TermsSliceQuery} + * If the provided field is the "_uid" it uses a {@code org.codelibs.fesen.opensearch.search.slice.TermsSliceQuery} * to do the slicing. The slicing is done at the shard level first and then each shard is split into multiple slices. * For instance if the number of shards is equal to 2 and the user requested 4 slices * then the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard. * This way the total number of bitsets that we need to build on each shard is bounded by the number of slices * (instead of {@code numShards*numSlices}). * Otherwise the provided field must be a numeric and doc_values must be enabled. In that case a - * {@link org.codelibs.fesen.opensearch.search.slice.DocValuesSliceQuery} is used to filter the results. + * {@code org.codelibs.fesen.opensearch.search.slice.DocValuesSliceQuery} is used to filter the results. * * @opensearch.api */ diff --git a/src/main/java/org/codelibs/fesen/opensearch/search/suggest/completion/CompletionSuggestionBuilder.java b/src/main/java/org/codelibs/fesen/opensearch/search/suggest/completion/CompletionSuggestionBuilder.java index f150e64d..0c5e5a25 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/search/suggest/completion/CompletionSuggestionBuilder.java +++ b/src/main/java/org/codelibs/fesen/opensearch/search/suggest/completion/CompletionSuggestionBuilder.java @@ -189,8 +189,8 @@ public CompletionSuggestionBuilder regex(String regex, RegexOptions regexOptions /** * Sets query contexts for completion * @param queryContexts named query contexts - * see {@link org.codelibs.fesen.opensearch.search.suggest.completion.context.CategoryQueryContext} - * and {@link org.codelibs.fesen.opensearch.search.suggest.completion.context.GeoQueryContext} + * see {@code org.codelibs.fesen.opensearch.search.suggest.completion.context.CategoryQueryContext} + * and {@code org.codelibs.fesen.opensearch.search.suggest.completion.context.GeoQueryContext} */ public CompletionSuggestionBuilder contexts(Map> queryContexts) { Objects.requireNonNull(queryContexts, "contexts must not be null"); diff --git a/src/main/java/org/codelibs/fesen/opensearch/tasks/TaskResult.java b/src/main/java/org/codelibs/fesen/opensearch/tasks/TaskResult.java index b3b1b8b7..1d8f49d7 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/tasks/TaskResult.java +++ b/src/main/java/org/codelibs/fesen/opensearch/tasks/TaskResult.java @@ -60,8 +60,8 @@ import static org.codelibs.fesen.opensearch.core.xcontent.ConstructingObjectParser.optionalConstructorArg; /** - * Information about a running task or a task that stored its result. Running tasks just have a {@link #getTask()} while - * tasks with stored result will have either a {@link #getError()} or {@link #getResponse()}. + * Information about a running task or a task that stored its result. Running tasks just have a {@code #getTask()} while + * tasks with stored result will have either a {@code #getError()} or {@code #getResponse()}. * * @opensearch.api */ @@ -100,7 +100,7 @@ public void writeTo(StreamOutput out) throws IOException { } /** - * Convert {@link #getError()} from XContent to a Map for easy processing. Will return an empty map if the task didn't finish with an + * Convert {@code #getError()} from XContent to a Map for easy processing. Will return an empty map if the task didn't finish with an * error, hasn't yet finished, or didn't store its result. */ public Map getErrorAsMap() { @@ -111,7 +111,7 @@ public Map getErrorAsMap() { } /** - * Convert {@link #getResponse()} from XContent to a Map for easy processing. Will return an empty map if the task was finished with an + * Convert {@code #getResponse()} from XContent to a Map for easy processing. Will return an empty map if the task was finished with an * error, hasn't yet finished, or didn't store its result. */ public Map getResponseAsMap() { diff --git a/src/main/java/org/codelibs/fesen/opensearch/transport/client/Client.java b/src/main/java/org/codelibs/fesen/opensearch/transport/client/Client.java index 06023c15..7c7a360f 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/transport/client/Client.java +++ b/src/main/java/org/codelibs/fesen/opensearch/transport/client/Client.java @@ -103,8 +103,6 @@ *

    * A client can be retrieved from a started {@link org.codelibs.fesen.opensearch.node.Node}. * - * @see org.codelibs.fesen.opensearch.node.Node#client() - * * @opensearch.api */ @PublicApi(since = "1.0.0") @@ -132,7 +130,6 @@ public interface Client extends OpenSearchClient, Releasable { * * @param request The index request * @return The result future - * @see Requests#indexRequest(String) */ ActionFuture index(IndexRequest request); @@ -143,7 +140,6 @@ public interface Client extends OpenSearchClient, Releasable { * * @param request The index request * @param listener A listener to be notified with a result - * @see Requests#indexRequest(String) */ void index(IndexRequest request, ActionListener listener); @@ -194,7 +190,6 @@ public interface Client extends OpenSearchClient, Releasable { * * @param request The delete request * @return The result future - * @see Requests#deleteRequest(String) */ ActionFuture delete(DeleteRequest request); @@ -203,7 +198,6 @@ public interface Client extends OpenSearchClient, Releasable { * * @param request The delete request * @param listener A listener to be notified with a result - * @see Requests#deleteRequest(String) */ void delete(DeleteRequest request, ActionListener listener); @@ -225,7 +219,6 @@ public interface Client extends OpenSearchClient, Releasable { * * @param request The bulk request * @return The result future - * @see Requests#bulkRequest() */ ActionFuture bulk(BulkRequest request); @@ -234,7 +227,6 @@ public interface Client extends OpenSearchClient, Releasable { * * @param request The bulk request * @param listener A listener to be notified with a result - * @see Requests#bulkRequest() */ void bulk(BulkRequest request, ActionListener listener); @@ -253,7 +245,6 @@ public interface Client extends OpenSearchClient, Releasable { * * @param request The get request * @return The result future - * @see Requests#getRequest(String) */ ActionFuture get(GetRequest request); @@ -262,7 +253,6 @@ public interface Client extends OpenSearchClient, Releasable { * * @param request The get request * @param listener A listener to be notified with a result - * @see Requests#getRequest(String) */ void get(GetRequest request, ActionListener listener); @@ -296,7 +286,6 @@ public interface Client extends OpenSearchClient, Releasable { * * @param request The search request * @return The result future - * @see Requests#searchRequest(String...) */ ActionFuture search(SearchRequest request); @@ -305,7 +294,6 @@ public interface Client extends OpenSearchClient, Releasable { * * @param request The search request * @param listener A listener to be notified of the result - * @see Requests#searchRequest(String...) */ void search(SearchRequest request, ActionListener listener); @@ -324,7 +312,6 @@ public interface Client extends OpenSearchClient, Releasable { * * @param request The search scroll request * @return The result future - * @see Requests#searchScrollRequest(String) */ ActionFuture searchScroll(SearchScrollRequest request); @@ -333,7 +320,6 @@ public interface Client extends OpenSearchClient, Releasable { * * @param request The search scroll request * @param listener A listener to be notified of the result - * @see Requests#searchScrollRequest(String) */ void searchScroll(SearchScrollRequest request, ActionListener listener); diff --git a/src/main/java/org/codelibs/fesen/opensearch/transport/client/ClusterAdminClient.java b/src/main/java/org/codelibs/fesen/opensearch/transport/client/ClusterAdminClient.java index 2201298c..9b8a57ab 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/transport/client/ClusterAdminClient.java +++ b/src/main/java/org/codelibs/fesen/opensearch/transport/client/ClusterAdminClient.java @@ -149,7 +149,6 @@ public interface ClusterAdminClient extends OpenSearchClient { * * @param request The cluster state request * @return The result future - * @see Requests#clusterHealthRequest(String...) */ ActionFuture health(ClusterHealthRequest request); @@ -158,7 +157,6 @@ public interface ClusterAdminClient extends OpenSearchClient { * * @param request The cluster state request * @param listener A listener to be notified with a result - * @see Requests#clusterHealthRequest(String...) */ void health(ClusterHealthRequest request, ActionListener listener); @@ -172,7 +170,6 @@ public interface ClusterAdminClient extends OpenSearchClient { * * @param request The cluster state request. * @return The result future - * @see Requests#clusterStateRequest() */ ActionFuture state(ClusterStateRequest request); @@ -181,7 +178,6 @@ public interface ClusterAdminClient extends OpenSearchClient { * * @param request The cluster state request. * @param listener A listener to be notified with a result - * @see Requests#clusterStateRequest() */ void state(ClusterStateRequest request, ActionListener listener); @@ -225,7 +221,6 @@ public interface ClusterAdminClient extends OpenSearchClient { * * @param request The nodes info request * @return The result future - * @see Requests#nodesInfoRequest(String...) */ ActionFuture nodesInfo(NodesInfoRequest request); @@ -234,7 +229,6 @@ public interface ClusterAdminClient extends OpenSearchClient { * * @param request The nodes info request * @param listener A listener to be notified with a result - * @see Requests#nodesInfoRequest(String...) */ void nodesInfo(NodesInfoRequest request, ActionListener listener); @@ -248,7 +242,6 @@ public interface ClusterAdminClient extends OpenSearchClient { * * @param request The cluster stats request * @return The result future - * @see Requests#clusterStatsRequest */ ActionFuture clusterStats(ClusterStatsRequest request); @@ -257,7 +250,6 @@ public interface ClusterAdminClient extends OpenSearchClient { * * @param request The cluster stats request * @param listener A listener to be notified with a result - * @see Requests#clusterStatsRequest() */ void clusterStats(ClusterStatsRequest request, ActionListener listener); @@ -268,7 +260,6 @@ public interface ClusterAdminClient extends OpenSearchClient { * * @param request The nodes stats request * @return The result future - * @see Requests#nodesStatsRequest(String...) */ ActionFuture nodesStats(NodesStatsRequest request); @@ -277,7 +268,6 @@ public interface ClusterAdminClient extends OpenSearchClient { * * @param request The nodes info request * @param listener A listener to be notified with a result - * @see Requests#nodesStatsRequest(String...) */ void nodesStats(NodesStatsRequest request, ActionListener listener); @@ -309,7 +299,6 @@ public interface ClusterAdminClient extends OpenSearchClient { * @param request * The nodes usage request * @return The result future - * @see Requests#nodesUsageRequest(String...) */ ActionFuture nodesUsage(NodesUsageRequest request); @@ -320,7 +309,6 @@ public interface ClusterAdminClient extends OpenSearchClient { * The nodes usage request * @param listener * A listener to be notified with a result - * @see Requests#nodesUsageRequest(String...) */ void nodesUsage(NodesUsageRequest request, ActionListener listener); @@ -353,7 +341,6 @@ public interface ClusterAdminClient extends OpenSearchClient { * * @param request The nodes tasks request * @return The result future - * @see Requests#listTasksRequest() */ ActionFuture listTasks(ListTasksRequest request); @@ -362,7 +349,6 @@ public interface ClusterAdminClient extends OpenSearchClient { * * @param request The nodes tasks request * @param listener A listener to be notified with a result - * @see Requests#listTasksRequest() */ void listTasks(ListTasksRequest request, ActionListener listener); @@ -376,7 +362,6 @@ public interface ClusterAdminClient extends OpenSearchClient { * * @param request the request * @return the result future - * @see Requests#getTaskRequest() */ ActionFuture getTask(GetTaskRequest request); @@ -385,7 +370,6 @@ public interface ClusterAdminClient extends OpenSearchClient { * * @param request the request * @param listener A listener to be notified with the result - * @see Requests#getTaskRequest() */ void getTask(GetTaskRequest request, ActionListener listener); @@ -404,7 +388,6 @@ public interface ClusterAdminClient extends OpenSearchClient { * * @param request The nodes tasks request * @return The result future - * @see Requests#cancelTasksRequest() */ ActionFuture cancelTasks(CancelTasksRequest request); @@ -413,7 +396,6 @@ public interface ClusterAdminClient extends OpenSearchClient { * * @param request The nodes tasks request * @param listener A listener to be notified with a result - * @see Requests#cancelTasksRequest() */ void cancelTasks(CancelTasksRequest request, ActionListener listener); diff --git a/src/main/java/org/codelibs/fesen/opensearch/transport/client/IndicesAdminClient.java b/src/main/java/org/codelibs/fesen/opensearch/transport/client/IndicesAdminClient.java index 4b7f0665..bd2f9ad5 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/transport/client/IndicesAdminClient.java +++ b/src/main/java/org/codelibs/fesen/opensearch/transport/client/IndicesAdminClient.java @@ -153,7 +153,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The indices exists request * @return The result future - * @see Requests#indicesExistsRequest(String...) */ ActionFuture exists(IndicesExistsRequest request); @@ -162,7 +161,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The indices status request * @param listener A listener to be notified with a result - * @see Requests#indicesExistsRequest(String...) */ void exists(IndicesExistsRequest request, ActionListener listener); @@ -221,7 +219,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The indices segments request * @return The result future - * @see Requests#indicesSegmentsRequest(String...) */ ActionFuture segments(IndicesSegmentsRequest request); @@ -230,7 +227,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The indices segments request * @param listener A listener to be notified with a result - * @see Requests#indicesSegmentsRequest(String...) */ void segments(IndicesSegmentsRequest request, ActionListener listener); @@ -244,7 +240,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The indices shard stores request * @return The result future - * @see Requests#indicesShardStoresRequest(String...) */ ActionFuture shardStores(IndicesShardStoresRequest request); @@ -253,7 +248,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The indices shard stores request * @param listener A listener to be notified with a result - * @see Requests#indicesShardStoresRequest(String...) */ void shardStores(IndicesShardStoresRequest request, ActionListener listener); @@ -267,7 +261,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The create index request * @return The result future - * @see Requests#createIndexRequest(String) */ ActionFuture create(CreateIndexRequest request); @@ -276,7 +269,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The create index request * @param listener A listener to be notified with a result - * @see Requests#createIndexRequest(String) */ void create(CreateIndexRequest request, ActionListener listener); @@ -292,7 +284,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The delete index request * @return The result future - * @see Requests#deleteIndexRequest(String) */ ActionFuture delete(DeleteIndexRequest request); @@ -301,7 +292,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The delete index request * @param listener A listener to be notified with a result - * @see Requests#deleteIndexRequest(String) */ void delete(DeleteIndexRequest request, ActionListener listener); @@ -317,7 +307,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The close index request * @return The result future - * @see Requests#closeIndexRequest(String) */ ActionFuture close(CloseIndexRequest request); @@ -326,7 +315,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The close index request * @param listener A listener to be notified with a result - * @see Requests#closeIndexRequest(String) */ void close(CloseIndexRequest request, ActionListener listener); @@ -342,7 +330,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The close index request * @return The result future - * @see Requests#openIndexRequest(String) */ ActionFuture open(OpenIndexRequest request); @@ -351,7 +338,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The close index request * @param listener A listener to be notified with a result - * @see Requests#openIndexRequest(String) */ void open(OpenIndexRequest request, ActionListener listener); @@ -367,7 +353,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The refresh request * @return The result future - * @see Requests#refreshRequest(String...) */ ActionFuture refresh(RefreshRequest request); @@ -376,7 +361,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The refresh request * @param listener A listener to be notified with a result - * @see Requests#refreshRequest(String...) */ void refresh(RefreshRequest request, ActionListener listener); @@ -390,7 +374,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The flush request * @return A result future - * @see Requests#flushRequest(String...) */ ActionFuture flush(FlushRequest request); @@ -399,7 +382,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The flush request * @param listener A listener to be notified with a result - * @see Requests#flushRequest(String...) */ void flush(FlushRequest request, ActionListener listener); @@ -413,7 +395,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The optimize request * @return A result future - * @see Requests#forceMergeRequest(String...) */ ActionFuture forceMerge(ForceMergeRequest request); @@ -422,7 +403,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The force merge request * @param listener A listener to be notified with a result - * @see Requests#forceMergeRequest(String...) */ void forceMerge(ForceMergeRequest request, ActionListener listener); @@ -436,7 +416,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The upgrade request * @return A result future - * @see Requests#upgradeRequest(String...) */ ActionFuture upgrade(UpgradeRequest request); @@ -445,7 +424,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The upgrade request * @param listener A listener to be notified with a result - * @see Requests#upgradeRequest(String...) */ void upgrade(UpgradeRequest request, ActionListener listener); @@ -459,7 +437,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The upgrade request * @return A result future - * @see Requests#upgradeRequest(String...) */ ActionFuture upgradeStatus(UpgradeStatusRequest request); @@ -468,7 +445,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The upgrade request * @param listener A listener to be notified with a result - * @see Requests#upgradeRequest(String...) */ void upgradeStatus(UpgradeStatusRequest request, ActionListener listener); @@ -512,7 +488,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The create mapping request * @return A result future - * @see Requests#putMappingRequest(String...) */ ActionFuture putMapping(PutMappingRequest request); @@ -521,7 +496,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The create mapping request * @param listener A listener to be notified with a result - * @see Requests#putMappingRequest(String...) */ void putMapping(PutMappingRequest request, ActionListener listener); @@ -535,7 +509,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The index aliases request * @return The result future - * @see Requests#indexAliasesRequest() */ ActionFuture aliases(IndicesAliasesRequest request); @@ -544,7 +517,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The index aliases request * @param listener A listener to be notified with a result - * @see Requests#indexAliasesRequest() */ void aliases(IndicesAliasesRequest request, ActionListener listener); @@ -598,7 +570,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The clear indices cache request * @return The result future - * @see Requests#clearIndicesCacheRequest(String...) */ ActionFuture clearCache(ClearIndicesCacheRequest request); @@ -607,7 +578,6 @@ public interface IndicesAdminClient extends OpenSearchClient { * * @param request The clear indices cache request * @param listener A listener to be notified with a result - * @see Requests#clearIndicesCacheRequest(String...) */ void clearCache(ClearIndicesCacheRequest request, ActionListener listener); diff --git a/src/main/java/org/codelibs/fesen/opensearch/wlm/tracker/NativeMemoryUsageCalculator.java b/src/main/java/org/codelibs/fesen/opensearch/wlm/tracker/NativeMemoryUsageCalculator.java index 9147ec71..f2eed643 100644 --- a/src/main/java/org/codelibs/fesen/opensearch/wlm/tracker/NativeMemoryUsageCalculator.java +++ b/src/main/java/org/codelibs/fesen/opensearch/wlm/tracker/NativeMemoryUsageCalculator.java @@ -17,7 +17,7 @@ * *

    Workload Management does not account native (off-heap) memory per workload group — that * live usage is reported by native backends (e.g. DataFusion) via the search backpressure - * {@code NativeMemoryUsageTracker}. The enum entry exists so {@link + * {@code NativeMemoryUsageTracker}. The enum entry exists so {@code * org.codelibs.fesen.opensearch.search.backpressure.trackers.NodeDuressTrackers} can route native-memory * duress through the same {@code ResourceType} keyed map as CPU and heap; this calculator * simply returns zero for any task or task list so WLM surfaces that accidentally iterate it