Fix split package org.elasticsearch.common.xcontent

[ChrisHegarty]

Fix the split package org.elasticsearch.common.xcontent, between server and the x-content lib. Move the x-content lib exported package from org.elasticsearch.common.xcontent to org.elasticsearch.xcontent ( following the naming convention of similar libraries ). Removing split packages is a prerequisite to modularization.

Much of the changes in this PR are to import statements. In some areas spotlessApply fixes up the order of import statements, in other area not so, but equally the order does not cause issues for the build. If this is deemed significant, then the imports can be reordered after this PR is merged.

relates #78166

[ChrisHegarty]

Note to reviewers. Much of the changes are related to the shimmer in package and import statements. To more easily see changes not related to the aforementioned shimmer, one can run a cross branch diff, see below.

Highlights:

1. remove related split package ignores from server/build.gradle
2. fix-up javadoc links
3. make a couple of accessor methods in XContentBuilder public, for test access.

$ git diff -w master..xcontent_split | egrep -v '^(\s|diff|rename|similarity|index\s[a-z0-9]{11}\.\.[a-z0-9]{11}|@@|---|\+\+\+)' | egrep -v '^[\+|-]{1}[import|package]{1}'
-     * {@link org.elasticsearch.common.xcontent.ContextParser#parse(XContentParser, Object)}
+     * {@link org.elasticsearch.xcontent.ContextParser#parse(XContentParser, Object)}
-     * Use {@link org.elasticsearch.common.xcontent.ObjectPath} to navigate through the data
+     * Use {@link org.elasticsearch.xcontent.ObjectPath} to navigate through the data
-    static void ensureNameNotNull(String name) {
+    public static void ensureNameNotNull(String name) {
-    static void ensureNotNull(Object value, String message) {
+    public static void ensureNotNull(Object value, String message) {
- * A one stop to use {@link org.elasticsearch.common.xcontent.XContent} and {@link XContentBuilder}.
+ * A one stop to use {@link org.elasticsearch.xcontent.XContent} and {@link XContentBuilder}.
-    static final int GUESS_HEADER_LENGTH = 20;
+    public static final int GUESS_HEADER_LENGTH = 20;
-     * Returns a content builder using JSON format ({@link org.elasticsearch.common.xcontent.XContentType#JSON}.
+     * Returns a content builder using JSON format ({@link org.elasticsearch.xcontent.XContentType#JSON}.
-     * Returns a content builder using SMILE format ({@link org.elasticsearch.common.xcontent.XContentType#SMILE}.
+     * Returns a content builder using SMILE format ({@link org.elasticsearch.xcontent.XContentType#SMILE}.
-     * Returns a content builder using YAML format ({@link org.elasticsearch.common.xcontent.XContentType#YAML}.
+     * Returns a content builder using YAML format ({@link org.elasticsearch.xcontent.XContentType#YAML}.
-     * Returns a content builder using CBOR format ({@link org.elasticsearch.common.xcontent.XContentType#CBOR}.
+     * Returns a content builder using CBOR format ({@link org.elasticsearch.xcontent.XContentType#CBOR}.
-     * Returns the {@link org.elasticsearch.common.xcontent.XContent} for the provided content type.
+     * Returns the {@link org.elasticsearch.xcontent.XContent} for the provided content type.
- * The content type of {@link org.elasticsearch.common.xcontent.XContent}.
+ * The content type of {@link org.elasticsearch.xcontent.XContent}.
-    static final FilterPath EMPTY = new FilterPath();
+    public static final FilterPath EMPTY = new FilterPath();
-    boolean isDoubleWildcard() {
+    public boolean isDoubleWildcard() {
-    boolean isSimpleWildcard() {
+    public boolean isSimpleWildcard() {
-    String getSegment() {
+    public String getSegment() {
-    FilterPath getNext() {
+    public FilterPath getNext() {
-    // xcontent should not have common, all it's common packages should be renamed to xcontent
-    'org.elasticsearch.common.xcontent.*',
-    'org.elasticsearch.common.xcontent.support.XContentMapValues',
-
- * its string form ({@link #source(String, XContentType)}) or using a {@link org.elasticsearch.common.xcontent.XContentBuilder}
- * ({@link #source(org.elasticsearch.common.xcontent.XContentBuilder)}).
+ * its string form ({@link #source(String, XContentType)}) or using a {@link org.elasticsearch.xcontent.XContentBuilder}
+ * ({@link #source(org.elasticsearch.xcontent.XContentBuilder)}).
-     * the alias filter via {@link org.elasticsearch.common.xcontent.XContentParser},
+     * the alias filter via {@link org.elasticsearch.xcontent.XContentParser},
-     * {@link org.elasticsearch.common.xcontent.XContentParser.Token#START_OBJECT}.
+     * {@link org.elasticsearch.xcontent.XContentParser.Token#START_OBJECT}.
- * Defines a query parser that is able to parse {@link QueryBuilder}s from {@link org.elasticsearch.common.xcontent.XContent}.
+ * Defines a query parser that is able to parse {@link QueryBuilder}s from {@link org.elasticsearch.xcontent.XContent}.
-     * Parses a retention lease from {@link org.elasticsearch.common.xcontent.XContent}. This method assumes that the retention lease was
-     * converted to {@link org.elasticsearch.common.xcontent.XContent} via {@link #toXContent(XContentBuilder, Params)}.
+     * Parses a retention lease from {@link org.elasticsearch.xcontent.XContent}. This method assumes that the retention lease was
+     * converted to {@link org.elasticsearch.xcontent.XContent} via {@link #toXContent(XContentBuilder, Params)}.
-     * Converts the retention lease stats to {@link org.elasticsearch.common.xcontent.XContent} using the specified builder and pararms.
+     * Converts the retention lease stats to {@link org.elasticsearch.xcontent.XContent} using the specified builder and pararms.
-     * @return the builder that this retention lease collection was converted to {@link org.elasticsearch.common.xcontent.XContent} into
+     * @return the builder that this retention lease collection was converted to {@link org.elasticsearch.xcontent.XContent} into
-     * Parses a retention leases collection from {@link org.elasticsearch.common.xcontent.XContent}. This method assumes that the retention
-     * leases were converted to {@link org.elasticsearch.common.xcontent.XContent} via {@link #toXContent(XContentBuilder, Params)}.
+     * Parses a retention leases collection from {@link org.elasticsearch.xcontent.XContent}. This method assumes that the retention
+     * leases were converted to {@link org.elasticsearch.xcontent.XContent} via {@link #toXContent(XContentBuilder, Params)}.
-     * {@link #toInnerXContent(XContentBuilder, org.elasticsearch.common.xcontent.ToXContent.Params)}
+     * {@link #toInnerXContent(XContentBuilder, org.elasticsearch.xcontent.ToXContent.Params)}
-            org.elasticsearch.common.xcontent.ObjectParser.ValueType.INT
+            org.elasticsearch.xcontent.ObjectParser.ValueType.INT
-            org.elasticsearch.common.xcontent.ObjectParser.ValueType.OBJECT
+            org.elasticsearch.xcontent.ObjectParser.ValueType.OBJECT
-     * {@link org.elasticsearch.common.xcontent.XContent} format.
+     * {@link org.elasticsearch.xcontent.XContent} format.
-     * {@link org.elasticsearch.common.xcontent.XContent} format.
+     * {@link org.elasticsearch.xcontent.XContent} format.
-     * {@link org.elasticsearch.common.xcontent.XContent} format.
+     * {@link org.elasticsearch.xcontent.XContent} format.
-     * {@link org.elasticsearch.common.xcontent.XContent} format.
+     * {@link org.elasticsearch.xcontent.XContent} format.
-     * Whether or not to assert equivalence of the {@link org.elasticsearch.common.xcontent.XContent} of the test instance and the instance
-     * parsed from the {@link org.elasticsearch.common.xcontent.XContent} of the test instance.
+     * Whether or not to assert equivalence of the {@link org.elasticsearch.xcontent.XContent} of the test instance and the instance
+     * parsed from the {@link org.elasticsearch.xcontent.XContent} of the test instance.
-     * via {@link org.elasticsearch.common.xcontent.ToXContent#toXContent(XContentBuilder, ToXContent.Params)} and parsed back via
-     * {@link org.elasticsearch.common.xcontent.XContentParser#objectText()}.
+     * via {@link ToXContent#toXContent(XContentBuilder, ToXContent.Params)} and parsed back via
+     * {@link org.elasticsearch.xcontent.XContentParser#objectText()}.
-     * via {@link org.elasticsearch.common.xcontent.ToXContent#toXContent(XContentBuilder, ToXContent.Params)} and parsed back via
-     * {@link org.elasticsearch.common.xcontent.XContentParser#objectText()}.
+     * via {@link ToXContent#toXContent(XContentBuilder, ToXContent.Params)} and parsed back via
+     * {@link org.elasticsearch.xcontent.XContentParser#objectText()}.
-     * {@link org.elasticsearch.common.xcontent.ToXContent#toXContent(XContentBuilder, ToXContent.Params)} hold the same content.
+     * {@link ToXContent#toXContent(XContentBuilder, ToXContent.Params)} hold the same content.
- * It allows to transfer the allocation information to {@link org.elasticsearch.common.xcontent.XContent} using
+ * It allows to transfer the allocation information to {@link org.elasticsearch.xcontent.XContent} using
-     * {@link org.elasticsearch.common.xcontent.ContextParser#parse(XContentParser, Object)}
+     * {@link ContextParser#parse(XContentParser, Object)}
-     * This is needed because {@link SqlQueryRequest#toXContent(XContentBuilder, org.elasticsearch.common.xcontent.ToXContent.Params)}
+     * This is needed because {@link SqlQueryRequest#toXContent(XContentBuilder, ToXContent.Params)}
-                containsString("at org.elasticsearch.common.xcontent.ObjectParser.getParser(ObjectParser.java:346)"));
+                containsString("at org.elasticsearch.xcontent.ObjectParser.getParser(ObjectParser.java:346)"));

[rjernst]

If this is deemed significant, then the imports can be reordered after this PR is merged

I wouldn't worry about it, the imports will be fixed up when spotless is turned on for the entire codebase.

[mark-vieira]

@elasticmachine retest this please

[mark-vieira]

@elasticmachine run elasticsearch-ci/packaging-tests-unix-sample

[ChrisHegarty]

I'll sync up with master once this set of tests complete.

[nik9000]

Files changed 4,955

Good luck!

[mark-vieira]

GitHub really does not handle large PRs like this well at all. Fortunately, IntelliJ GitHub integration handles this just fine. The build file changes look fine so I don't have any concerns here.

[ChrisHegarty]

@elasticmachine retest this please

[ChrisHegarty]

@elasticmachine retest this please