gh-194: Migrate koryphe to Java 11. (#239)

* gh-194: Migrate koryphe to Java 11. * gh-194: Fix imports and change usages of requireNonNullOrElseGet to requireNonNullElse. * gh-194: Fix headers. Co-authored-by: t511203 <[email protected]> Co-authored-by: t92549 <[email protected]>
gchq · Feb 10, 2022 · e04797e · e04797e
1 parent 88d8b1c
commit e04797e
Show file tree

Hide file tree

Showing 191 changed files with 952 additions and 309 deletions.
diff --git a/.github/workflows/continuous-integration.yaml b/.github/workflows/continuous-integration.yaml
@@ -19,7 +19,7 @@ jobs:
       uses: actions/setup-java@v2
       with:
         distribution: 'zulu'
-        java-version: '8'
+        java-version: '11'
 
     - name: Cache dependencies
       uses: actions/cache@v2

diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -22,7 +22,7 @@ jobs:
       uses: actions/setup-java@v2
       with:
         distribution: 'zulu'
-        java-version: '8'
+        java-version: '11'
 
     - name: Checkout master
       uses: actions/checkout@v2
@@ -91,7 +91,7 @@ jobs:
       uses: actions/setup-java@v2
       with:
         distribution: 'zulu'
-        java-version: '8'
+        java-version: '11'
 
     - name: Merge release into develop
       run: |
@@ -155,7 +155,7 @@ jobs:
       uses: actions/setup-java@v2
       with:
         distribution: 'zulu'
-        java-version: '8'
+        java-version: '11'
 
     - name: Set version
       run: echo "RELEASE_VERSION=$(echo ${{ github.event.milestone.title }} | cut -c 2-)" >> $GITHUB_ENV
@@ -183,7 +183,7 @@ jobs:
       uses: actions/setup-java@v2
       with:
         distribution: 'zulu'
-        java-version: '8'
+        java-version: '11'
 
     - name: Checkout master
       uses: actions/checkout@v2

diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,4 @@
-# Copyright 2017 Crown Copyright
+# Copyright 2017-2020 Crown Copyright
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/NOTICES b/NOTICES
@@ -1,4 +1,4 @@
-Copyright 2017-2020 Crown Copyright
+Copyright 2017-2022 Crown Copyright
 
 Koryphe is built using maven. This process will automatically pull in dependencies. We list Koryphe's dependencies,
 and their licenses, below. For information on the dependencies of these dependencies, see the websites of the

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-Copyright 2017-2020 Crown Copyright
+Copyright 2017-2022 Crown Copyright
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -26,7 +26,7 @@ Koryphe is an extensible functions library for filtering, aggregating and transf
 
 ## Context adapted functions
 
-Koryphe allows any Java 8 Function, BinaryOperator or Predicate to be adapted and applied to the values contained within a complex object such as a Tuple.
+Koryphe allows any Java 11 Function, BinaryOperator or Predicate to be adapted and applied to the values contained within a complex object such as a Tuple.
 
 ## Function composition
 

diff --git a/code-style/checkstyle.xml b/code-style/checkstyle.xml
@@ -3,7 +3,7 @@
         "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
         "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
 <!--
-  ~ Copyright 2016-2020 Crown Copyright
+  ~ Copyright 2016-2022 Crown Copyright
   ~
   ~ Licensed under the Apache License, Version 2.0 (the "License");
   ~ you may not use this file except in compliance with the License.
@@ -17,7 +17,6 @@
   ~ See the License for the specific language governing permissions and
   ~ limitations under the License.
   -->
-
 <module name="Checker">
     <module name="Translation"/>
     <module name="FileLength"/>
@@ -38,14 +37,10 @@
     </module>
 
     <module name="TreeWalker">
-        <property name="cacheFile" value="${checkstyle.cache.file}"/>
-
         <module name="SuppressWarningsHolder"/>
 
         <module name="AtclauseOrder"/>
-        <module name="JavadocMethod">
-            <property name="allowMissingJavadoc" value="true"/>
-        </module>
+        <module name="JavadocMethod"/>
         <module name="JavadocStyle">
             <property name="checkFirstSentence" value="false"/>
         </module>
@@ -88,7 +83,6 @@
         <module name="WhitespaceAround"/>
 
         <module name="ModifierOrder"/>
-        <module name="RedundantModifier"/>
 
         <module name="AvoidNestedBlocks"/>
         <module name="LeftCurly"/>

diff --git a/code-style/spotbugs-exclude.xml b/code-style/spotbugs-exclude.xml
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Copyright 2022 Crown Copyright
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~     http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+<FindBugsFilter xmlns="https://github.com/spotbugs/filter/3.0.0"
+                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                xsi:schemaLocation="https://github.com/spotbugs/filter/3.0.0 https://raw.githubusercontent.com/spotbugs/spotbugs/3.1.0/spotbugs/etc/findbugsfilter.xsd">
+    <Match>
+        <Bug code="EI,EI2"/>
+    </Match>
+</FindBugsFilter>
diff --git a/core/src/main/java/uk/gov/gchq/koryphe/adapted/Adapted.java b/core/src/main/java/uk/gov/gchq/koryphe/adapted/Adapted.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 Crown Copyright
+ * Copyright 2017-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -55,7 +55,7 @@ public BiFunction<C, AO, O> getOutputAdapter() {
         return outputAdapter;
     }
 
-    @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "class")
+    @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, property = "class")
     public void setOutputAdapter(final BiFunction<C, AO, O> outputAdapter) {
         this.outputAdapter = outputAdapter;
     }

diff --git a/core/src/main/java/uk/gov/gchq/koryphe/adapted/InputAdapted.java b/core/src/main/java/uk/gov/gchq/koryphe/adapted/InputAdapted.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 Crown Copyright
+ * Copyright 2017-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -48,7 +48,7 @@ public Function<I, AI> getInputAdapter() {
         return inputAdapter;
     }
 
-    @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "class")
+    @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, property = "class")
     public void setInputAdapter(final Function<I, AI> inputAdapter) {
         this.inputAdapter = inputAdapter;
     }

diff --git a/core/src/main/java/uk/gov/gchq/koryphe/adapted/StateAgnosticOutputAdapter.java b/core/src/main/java/uk/gov/gchq/koryphe/adapted/StateAgnosticOutputAdapter.java
@@ -36,7 +36,7 @@
 @Since("1.11.0")
 @Summary("Adapts an output without considering the state")
 public class StateAgnosticOutputAdapter<T, U, R> implements BiFunction<T, U, R> {
-    @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "class")
+    @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, property = "class")
     private Function<U, R> adapter;
 
     public StateAgnosticOutputAdapter() {

diff --git a/core/src/main/java/uk/gov/gchq/koryphe/binaryoperator/AdaptedBinaryOperator.java b/core/src/main/java/uk/gov/gchq/koryphe/binaryoperator/AdaptedBinaryOperator.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 Crown Copyright
+ * Copyright 2017-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -81,7 +81,7 @@ public BinaryOperator<OT> getBinaryOperator() {
         return binaryOperator;
     }
 
-    @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "class")
+    @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, property = "class")
     public void setBinaryOperator(final BinaryOperator<OT> binaryOperator) {
         this.binaryOperator = binaryOperator;
     }

diff --git a/core/src/main/java/uk/gov/gchq/koryphe/binaryoperator/BinaryOperatorMap.java b/core/src/main/java/uk/gov/gchq/koryphe/binaryoperator/BinaryOperatorMap.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 Crown Copyright
+ * Copyright 2017-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -33,7 +33,7 @@
 @Since("1.0.0")
 @Summary("Merges 2 maps by applying a binary operator to each of the values")
 public class BinaryOperatorMap<K, T> extends KorypheBinaryOperator<Map<K, T>> {
-    @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "class")
+    @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, property = "class")
     private BinaryOperator<? super T> binaryOperator;
 
     /**

diff --git a/core/src/main/java/uk/gov/gchq/koryphe/binaryoperator/KorypheBinaryOperator.java b/core/src/main/java/uk/gov/gchq/koryphe/binaryoperator/KorypheBinaryOperator.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 Crown Copyright
+ * Copyright 2017-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,7 +25,7 @@
  *
  * @param <T> Input/Output type
  */
-@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "class")
+@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, property = "class")
 public abstract class KorypheBinaryOperator<T> implements BinaryOperator<T> {
     /**
      * Apply the operator after completing null checks.

diff --git a/core/src/main/java/uk/gov/gchq/koryphe/composite/Composite.java b/core/src/main/java/uk/gov/gchq/koryphe/composite/Composite.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 Crown Copyright
+ * Copyright 2017-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -40,7 +40,7 @@ public Composite(final List<C> components) {
         this.components = components;
     }
 
-    @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "class")
+    @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, property = "class")
     public List<C> getComponents() {
         return components;
     }

diff --git a/core/src/main/java/uk/gov/gchq/koryphe/function/AdaptedFunction.java b/core/src/main/java/uk/gov/gchq/koryphe/function/AdaptedFunction.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 Crown Copyright
+ * Copyright 2017-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -34,7 +34,7 @@
  * @param <O>  Output type
  */
 public abstract class AdaptedFunction<I, FI, FO, O> extends Adapted<I, FI, FO, O, I> implements Function<I, O> {
-    @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "class")
+    @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, property = "class")
     protected Function<FI, FO> function;
 
     /**

diff --git a/core/src/main/java/uk/gov/gchq/koryphe/function/FunctionMap.java b/core/src/main/java/uk/gov/gchq/koryphe/function/FunctionMap.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 Crown Copyright
+ * Copyright 2017-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -35,7 +35,7 @@
 @Since("1.0.0")
 @Summary("Applies a function to each value in a map")
 public class FunctionMap<K, I, O> extends KorypheFunction<Map<K, I>, Map<K, O>> {
-    @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "class")
+    @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, property = "class")
     private Function<I, O> function;
 
     /**

diff --git a/core/src/main/java/uk/gov/gchq/koryphe/function/KorypheFunction.java b/core/src/main/java/uk/gov/gchq/koryphe/function/KorypheFunction.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 Crown Copyright
+ * Copyright 2017-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,7 +26,7 @@
  * @param <I> Input type
  * @param <O> Output type
  */
-@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "class")
+@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, property = "class")
 public abstract class KorypheFunction<I, O> implements Function<I, O> {
     @Override
     public boolean equals(final Object obj) {

diff --git a/core/src/main/java/uk/gov/gchq/koryphe/impl/binaryoperator/And.java b/core/src/main/java/uk/gov/gchq/koryphe/impl/binaryoperator/And.java
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package uk.gov.gchq.koryphe.impl.binaryoperator;
 
 import org.apache.commons.lang3.builder.ToStringBuilder;

diff --git a/core/src/main/java/uk/gov/gchq/koryphe/impl/binaryoperator/StringDeduplicateConcat.java b/core/src/main/java/uk/gov/gchq/koryphe/impl/binaryoperator/StringDeduplicateConcat.java
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package uk.gov.gchq.koryphe.impl.binaryoperator;
 
 import org.apache.commons.lang3.StringUtils;

diff --git a/core/src/main/java/uk/gov/gchq/koryphe/impl/function/ApplyBiFunction.java b/core/src/main/java/uk/gov/gchq/koryphe/impl/function/ApplyBiFunction.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2020 Crown Copyright
+ * Copyright 2019-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -38,7 +38,7 @@
  * @param <U> Type of second input
  * @param <R> Type of output
  */
-@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "class")
+@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, property = "class")
 @Since("1.8.0")
 @Summary("Applies the given BiFunction")
 public class ApplyBiFunction<T, U, R> extends KorypheFunction2<T, U, R> implements WrappedBiFunction<T, U, R> {
@@ -57,7 +57,7 @@ public R apply(final T t, final U u) {
     }
 
     @Override
-    @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "class")
+    @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, property = "class")
     public BiFunction<T, U, R> getFunction() {
         return function;
     }

diff --git a/core/src/main/java/uk/gov/gchq/koryphe/impl/function/CreateObject.java b/core/src/main/java/uk/gov/gchq/koryphe/impl/function/CreateObject.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2020 Crown Copyright
+ * Copyright 2019-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -56,8 +56,8 @@ public Object apply(final Object value) {
 
         if (isNull(value)) {
             try {
-                return objectClass.newInstance();
-            } catch (final InstantiationException | IllegalAccessException e) {
+                return objectClass.getDeclaredConstructor().newInstance();
+            } catch (final InstantiationException | IllegalAccessException | NoSuchMethodException | InvocationTargetException e) {
                 throw new RuntimeException("Unable to create a new instance of " + objectClass.getName() + " using the no-arg constructor", e);
             }
         }

diff --git a/core/src/main/java/uk/gov/gchq/koryphe/impl/function/CsvLinesToMaps.java b/core/src/main/java/uk/gov/gchq/koryphe/impl/function/CsvLinesToMaps.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2020 Crown Copyright
+ * Copyright 2019-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -96,11 +96,12 @@ private CSVRecord parseCsv(final String csv) {
     }
 
     private CSVFormat getCsvFormat() {
-        CSVFormat format = CSVFormat.DEFAULT.withDelimiter(delimiter);
+        final CSVFormat.Builder formatBuilder = CSVFormat.DEFAULT.builder().setDelimiter(delimiter);
         if (quoted) {
-            format = format.withQuote(quoteChar);
+            formatBuilder.setQuote(quoteChar);
         }
-        return format;
+
+        return formatBuilder.build();
     }
 
     public List<String> getHeader() {

diff --git a/core/src/main/java/uk/gov/gchq/koryphe/impl/function/CsvToMaps.java b/core/src/main/java/uk/gov/gchq/koryphe/impl/function/CsvToMaps.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2020 Crown Copyright
+ * Copyright 2019-2022 Crown Copyright
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -82,11 +82,11 @@ private Map<String, Object> extractMap(final CSVRecord csvRecord) {
     }
 
     private CSVFormat getCsvFormat() {
-        CSVFormat format = CSVFormat.DEFAULT.withDelimiter(delimiter);
+        final CSVFormat.Builder formatBuilder = CSVFormat.DEFAULT.builder().setDelimiter(delimiter);
         if (quoted) {
-            format = format.withQuote(quoteChar);
+            formatBuilder.setQuote(quoteChar);
         }
-        return format;
+        return formatBuilder.build();
     }
 
     public List<String> getHeader() {