apply spotless formatting

Author: garaud

build.gradle

@@ -9,11 +9,26 @@ buildscript {
     }
 }
 
+// the spotless plugin is dedicated to format the code
+plugins {
+  id("com.diffplug.spotless") version "7.0.4"
+}
+
 repositories {
     mavenLocal()
     mavenCentral()
 }
 
+// add -Xlint:deprecation to check the Elasticsearch deprecation warning at compile-time
+allprojects {
+    gradle.projectsEvaluated {
+        tasks.withType(JavaCompile) {
+            options.compilerArgs << "-Xlint:deprecation"
+            options.compilerArgs << "-Xlint:unchecked"
+        }
+    }
+}
+
 group = 'org.elasticsearch.plugin'
 version = "${plugin_version}"
 
@@ -24,6 +39,17 @@ apply plugin: 'idea'
 apply plugin: 'elasticsearch.esplugin'
 apply plugin: 'elasticsearch.yaml-rest-test'
 
+// automatic formatting configuration (the same configuration as elasticsearch)
+spotless {
+    java {
+        importOrderFile('config/elastic.importorder') // import order file as exported from elastic
+        eclipse().configFile('config/formatterConfig.xml')
+        trimTrailingWhitespace()
+        target 'src/**/*.java'
+    }
+}
+
+check.dependsOn spotlessCheck
 
 esplugin {
     name 'pathhierarchy-aggregation'

src/main/java/org/opendatasoft/elasticsearch/plugin/PathHierarchyAggregation.java

@@ -14,20 +14,18 @@ public class PathHierarchyAggregation extends Plugin implements SearchPlugin {
     public ArrayList<SearchPlugin.AggregationSpec> getAggregations() {
         ArrayList<SearchPlugin.AggregationSpec> r = new ArrayList<>();
         r.add(
-                new AggregationSpec(
-                        PathHierarchyAggregationBuilder.NAME,
-                        PathHierarchyAggregationBuilder::new,
-                        PathHierarchyAggregationBuilder.PARSER)
-                        .addResultReader(InternalPathHierarchy::new)
-                        .setAggregatorRegistrar(PathHierarchyAggregationBuilder::registerAggregators)
+            new AggregationSpec(
+                PathHierarchyAggregationBuilder.NAME,
+                PathHierarchyAggregationBuilder::new,
+                PathHierarchyAggregationBuilder.PARSER
+            ).addResultReader(InternalPathHierarchy::new).setAggregatorRegistrar(PathHierarchyAggregationBuilder::registerAggregators)
         );
         r.add(
-                new AggregationSpec(
-                        DateHierarchyAggregationBuilder.NAME,
-                        DateHierarchyAggregationBuilder::new,
-                        DateHierarchyAggregationBuilder.PARSER)
-                        .addResultReader(InternalDateHierarchy::new)
-                        .setAggregatorRegistrar(DateHierarchyAggregationBuilder::registerAggregators)
+            new AggregationSpec(
+                DateHierarchyAggregationBuilder.NAME,
+                DateHierarchyAggregationBuilder::new,
+                DateHierarchyAggregationBuilder.PARSER
+            ).addResultReader(InternalDateHierarchy::new).setAggregatorRegistrar(DateHierarchyAggregationBuilder::registerAggregators)
         );
         return r;
     }

src/main/java/org/opendatasoft/elasticsearch/search/aggregations/bucket/DateHierarchyAggregationBuilder.java

@@ -1,29 +1,29 @@
 package org.opendatasoft.elasticsearch.search.aggregations.bucket;
 
 import org.elasticsearch.Version;
-import org.elasticsearch.xcontent.ParseField;
 import org.elasticsearch.common.Rounding;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
 import org.elasticsearch.common.io.stream.Writeable;
 import org.elasticsearch.common.time.DateFormatter;
-import org.elasticsearch.xcontent.ObjectParser;
-import org.elasticsearch.xcontent.XContentBuilder;
-import org.elasticsearch.xcontent.XContentParser;
 import org.elasticsearch.index.mapper.DateFieldMapper;
-import org.elasticsearch.search.aggregations.support.AggregationContext;
 import org.elasticsearch.search.DocValueFormat;
 import org.elasticsearch.search.aggregations.AggregationBuilder;
 import org.elasticsearch.search.aggregations.AggregatorFactories.Builder;
 import org.elasticsearch.search.aggregations.AggregatorFactory;
 import org.elasticsearch.search.aggregations.BucketOrder;
 import org.elasticsearch.search.aggregations.InternalOrder;
+import org.elasticsearch.search.aggregations.support.AggregationContext;
 import org.elasticsearch.search.aggregations.support.CoreValuesSourceType;
 import org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder;
 import org.elasticsearch.search.aggregations.support.ValuesSourceAggregatorFactory;
 import org.elasticsearch.search.aggregations.support.ValuesSourceConfig;
 import org.elasticsearch.search.aggregations.support.ValuesSourceRegistry;
 import org.elasticsearch.search.aggregations.support.ValuesSourceType;
+import org.elasticsearch.xcontent.ObjectParser;
+import org.elasticsearch.xcontent.ParseField;
+import org.elasticsearch.xcontent.XContentBuilder;
+import org.elasticsearch.xcontent.XContentParser;
 
 import java.io.IOException;
 import java.time.ZoneId;
@@ -36,23 +36,20 @@
 
 import static java.util.Collections.unmodifiableMap;
 
-
 /**
  * The builder of the aggregatorFactory. Also implements the parsing of the request.
  */
 public class DateHierarchyAggregationBuilder extends ValuesSourceAggregationBuilder<DateHierarchyAggregationBuilder> {
     public static final String NAME = "date_hierarchy";
     public static final ValuesSourceRegistry.RegistryKey<DateHierarchyAggregationSupplier> REGISTRY_KEY =
-            new ValuesSourceRegistry.RegistryKey<>(NAME, DateHierarchyAggregationSupplier.class);
-
+        new ValuesSourceRegistry.RegistryKey<>(NAME, DateHierarchyAggregationSupplier.class);
 
     public static final ParseField INTERVAL_FIELD = new ParseField("interval");
     public static final ParseField ORDER_FIELD = new ParseField("order");
     public static final ParseField SIZE_FIELD = new ParseField("size");
     public static final ParseField SHARD_SIZE_FIELD = new ParseField("shard_size");
     public static final ParseField MIN_DOC_COUNT_FIELD = new ParseField("min_doc_count");
 
-
     public static final Map<String, IntervalConfig> INTERVAL_CONFIG;
     static {
         Map<String, IntervalConfig> dateFieldUnits = new LinkedHashMap<>();
@@ -88,13 +85,19 @@ public PreparedRounding(RoundingInfo roundingInfo, Rounding.Prepared prepared) {
     public List<PreparedRounding> buildRoundings() {
         List<PreparedRounding> roundings = new ArrayList<>();
 
-        ZoneId timeZone = timeZone() == null ? ZoneOffset.UTC: timeZone();
+        ZoneId timeZone = timeZone() == null ? ZoneOffset.UTC : timeZone();
 
         long now = System.currentTimeMillis();
         for (String interval : INTERVAL_CONFIG.keySet()) {
-            RoundingInfo ri = new RoundingInfo(interval, createRounding(INTERVAL_CONFIG.get(interval).dateTimeUnit),
-                    new DocValueFormat.DateTime(DateFormatter.forPattern(INTERVAL_CONFIG.get(interval).format), timeZone,
-                            DateFieldMapper.Resolution.MILLISECONDS));
+            RoundingInfo ri = new RoundingInfo(
+                interval,
+                createRounding(INTERVAL_CONFIG.get(interval).dateTimeUnit),
+                new DocValueFormat.DateTime(
+                    DateFormatter.forPattern(INTERVAL_CONFIG.get(interval).format),
+                    timeZone,
+                    DateFieldMapper.Resolution.MILLISECONDS
+                )
+            );
             roundings.add(new PreparedRounding(ri, ri.rounding.prepareForUnknown()));
 
             if (interval.equals(interval())) {
@@ -112,7 +115,7 @@ public static class RoundingInfo implements Writeable {
 
         public RoundingInfo(String interval, Rounding rounding, DocValueFormat docValueFormat) {
             this.interval = interval;
-            this.rounding =  rounding;
+            this.rounding = rounding;
             this.format = docValueFormat;
         }
 
@@ -130,10 +133,12 @@ public void writeTo(StreamOutput out) throws IOException {
         }
     }
 
-    public static final DateHierarchyAggregator.BucketCountThresholds DEFAULT_BUCKET_COUNT_THRESHOLDS = new
-            DateHierarchyAggregator.BucketCountThresholds(10, -1);
-    public static final ObjectParser<DateHierarchyAggregationBuilder, String> PARSER =
-            ObjectParser.fromBuilder(NAME, DateHierarchyAggregationBuilder::new);
+    public static final DateHierarchyAggregator.BucketCountThresholds DEFAULT_BUCKET_COUNT_THRESHOLDS =
+        new DateHierarchyAggregator.BucketCountThresholds(10, -1);
+    public static final ObjectParser<DateHierarchyAggregationBuilder, String> PARSER = ObjectParser.fromBuilder(
+        NAME,
+        DateHierarchyAggregationBuilder::new
+    );
     static {
 
         ValuesSourceAggregationBuilder.declareFields(PARSER, true, true, true);
@@ -151,8 +156,7 @@ public void writeTo(StreamOutput out) throws IOException {
         PARSER.declareInt(DateHierarchyAggregationBuilder::size, SIZE_FIELD);
         PARSER.declareLong(DateHierarchyAggregationBuilder::minDocCount, MIN_DOC_COUNT_FIELD);
         PARSER.declareInt(DateHierarchyAggregationBuilder::shardSize, SHARD_SIZE_FIELD);
-        PARSER.declareObjectArray(DateHierarchyAggregationBuilder::order, (p, c) -> InternalOrder.Parser.parseOrderParam(p),
-                ORDER_FIELD);
+        PARSER.declareObjectArray(DateHierarchyAggregationBuilder::order, (p, c) -> InternalOrder.Parser.parseOrderParam(p), ORDER_FIELD);
     }
 
     public static AggregationBuilder parse(String aggregationName, XContentParser parser) throws IOException {
@@ -168,8 +172,8 @@ public static void registerAggregators(ValuesSourceRegistry.Builder builder) {
     private String interval = "years";
     private BucketOrder order = BucketOrder.compound(BucketOrder.count(false)); // automatically adds tie-breaker key asc order
     private DateHierarchyAggregator.BucketCountThresholds bucketCountThresholds = new DateHierarchyAggregator.BucketCountThresholds(
-            DEFAULT_BUCKET_COUNT_THRESHOLDS);
-
+        DEFAULT_BUCKET_COUNT_THRESHOLDS
+    );
 
     private DateHierarchyAggregationBuilder(String name) {
         super(name);
@@ -193,8 +197,7 @@ public DateHierarchyAggregationBuilder(StreamInput in) throws IOException {
         timeZone = in.readOptionalZoneId();
     }
 
-    private DateHierarchyAggregationBuilder(DateHierarchyAggregationBuilder clone, Builder factoriesBuilder,
-                                            Map<String, Object> metaData) {
+    private DateHierarchyAggregationBuilder(DateHierarchyAggregationBuilder clone, Builder factoriesBuilder, Map<String, Object> metaData) {
         super(clone, factoriesBuilder, metaData);
         order = clone.order;
         minDocCount = clone.minDocCount;
@@ -275,7 +278,7 @@ private DateHierarchyAggregationBuilder order(BucketOrder order) {
         if (order == null) {
             throw new IllegalArgumentException("[order] must not be null: [" + name + "]");
         }
-        if(order instanceof InternalOrder.CompoundOrder || InternalOrder.isKeyOrder(order)) {
+        if (order instanceof InternalOrder.CompoundOrder || InternalOrder.isKeyOrder(order)) {
             this.order = order; // if order already contains a tie-breaker we are good to go
         } else { // otherwise add a tie-breaker by using a compound order
             this.order = BucketOrder.compound(order);
@@ -292,7 +295,6 @@ private DateHierarchyAggregationBuilder order(List<BucketOrder> orders) {
         return this;
     }
 
-
     /**
      * Sets the size - indicating how many term buckets should be returned
      * (defaults to 10)
@@ -310,7 +312,8 @@ public DateHierarchyAggregationBuilder size(int size) {
     public DateHierarchyAggregationBuilder minDocCount(long minDocCount) {
         if (minDocCount < 0) {
             throw new IllegalArgumentException(
-                    "[minDocCount] must be greater than or equal to 0. Found [" + minDocCount + "] in [" + name + "]");
+                "[minDocCount] must be greater than or equal to 0. Found [" + minDocCount + "] in [" + name + "]"
+            );
         }
         this.minDocCount = minDocCount;
         return this;
@@ -336,8 +339,7 @@ public BucketCardinality bucketCardinality() {
      */
     public DateHierarchyAggregationBuilder shardSize(int shardSize) {
         if (shardSize <= 0) {
-            throw new IllegalArgumentException(
-                    "[shardSize] must be greater than 0. Found [" + shardSize + "] in [" + name + "]");
+            throw new IllegalArgumentException("[shardSize] must be greater than 0. Found [" + shardSize + "] in [" + name + "]");
         }
         bucketCountThresholds.setShardSize(shardSize);
         return this;
@@ -351,25 +353,27 @@ public int shardSize() {
     }
 
     @Override
-    protected ValuesSourceAggregatorFactory innerBuild(AggregationContext context,
-                                                       ValuesSourceConfig config,
-                                                       AggregatorFactory parent,
-                                                       Builder subFactoriesBuilder) throws IOException {
-
+    protected ValuesSourceAggregatorFactory innerBuild(
+        AggregationContext context,
+        ValuesSourceConfig config,
+        AggregatorFactory parent,
+        Builder subFactoriesBuilder
+    ) throws IOException {
 
         final List<PreparedRounding> preparedRoundings = buildRoundings();
 
         return new DateHierarchyAggregatorFactory(
-                name,
-                config,
-                order,
-                preparedRoundings,
-                minDocCount,
-                bucketCountThresholds,
-                context,
-                parent,
-                subFactoriesBuilder,
-                metadata);
+            name,
+            config,
+            order,
+            preparedRoundings,
+            minDocCount,
+            bucketCountThresholds,
+            context,
+            parent,
+            subFactoriesBuilder,
+            metadata
+        );
     }
 
     @Override
@@ -398,10 +402,10 @@ public boolean equals(Object obj) {
         if (!super.equals(obj)) return false;
         DateHierarchyAggregationBuilder other = (DateHierarchyAggregationBuilder) obj;
         return Objects.equals(interval, other.interval)
-                && Objects.equals(order, other.order)
-                && Objects.equals(minDocCount, other.minDocCount)
-                && Objects.equals(bucketCountThresholds, other.bucketCountThresholds)
-                && Objects.equals(timeZone, other.timeZone);
+            && Objects.equals(order, other.order)
+            && Objects.equals(minDocCount, other.minDocCount)
+            && Objects.equals(bucketCountThresholds, other.bucketCountThresholds)
+            && Objects.equals(timeZone, other.timeZone);
     }
 
     @Override
@@ -410,6 +414,7 @@ public String getType() {
     }
 
     @Override
-    protected ValuesSourceRegistry.RegistryKey<?> getRegistryKey() { return REGISTRY_KEY; }
+    protected ValuesSourceRegistry.RegistryKey<?> getRegistryKey() {
+        return REGISTRY_KEY;
+    }
 }
-

src/main/java/org/opendatasoft/elasticsearch/search/aggregations/bucket/DateHierarchyAggregationSupplier.java

@@ -13,15 +13,17 @@
 
 @FunctionalInterface
 public interface DateHierarchyAggregationSupplier {
-    Aggregator build(String name,
-                     AggregatorFactories factories,
-                     BucketOrder order,
-                     List<DateHierarchyAggregationBuilder.RoundingInfo> roundingsInfo,
-                     long minDocCount,
-                     DateHierarchyAggregator.BucketCountThresholds bucketCountThresholds,
-                     ValuesSourceConfig valuesSourceConfig,
-                     SearchContext aggregationContext,
-                     Aggregator parent,
-                     CardinalityUpperBound cardinality,
-                     Map<String, Object> metadata) throws IOException;
+    Aggregator build(
+        String name,
+        AggregatorFactories factories,
+        BucketOrder order,
+        List<DateHierarchyAggregationBuilder.RoundingInfo> roundingsInfo,
+        long minDocCount,
+        DateHierarchyAggregator.BucketCountThresholds bucketCountThresholds,
+        ValuesSourceConfig valuesSourceConfig,
+        SearchContext aggregationContext,
+        Aggregator parent,
+        CardinalityUpperBound cardinality,
+        Map<String, Object> metadata
+    ) throws IOException;
 }