[CALCITE-4431] Use requireNonNull(var, "var") instead of requireNonNu…

…ll(var) for better error messages

This makes it easier to understand the reason for the failure, especially
when multiple requireNonNull lines go side-by-side.

The added AutoStyle configuration ensures the label does not go out-of-sync

build.gradle.kts

@@ -514,6 +514,7 @@ allprojects {
                     replaceRegex("@Override should not be on its own line", "(@Override)\\s{2,}", "\$1 ")
                     replaceRegex("@Test should not be on its own line", "(@Test)\\s{2,}", "\$1 ")
                     replaceRegex("Newline in string should be at end of line", """\\n" *\+""", "\\n\"\n  +")
+                    replaceRegex("require message for requireNonNull", """(?<!#)requireNonNull\(\s*(\w+)\s*(?:,\s*"(?!\1")\w+"\s*)?\)""", "requireNonNull($1, \"$1\")")
                     // (?-m) disables multiline, so $ matches the very end of the file rather than end of line
                     replaceRegex("Remove '// End file.java' trailer", "(?-m)\n// End [^\n]+\\.\\w+\\s*$", "")
                     replaceRegex("<p> should not be placed a the end of the line", "(?-m)\\s*+<p> *+\n \\* ", "\n *\n * <p>")

core/src/main/java/org/apache/calcite/adapter/enumerable/RexToLixTranslator.java

@@ -155,12 +155,12 @@ private RexToLixTranslator(@Nullable RexProgram program,
       SqlConformance conformance,
       @Nullable Function1<String, InputGetter> correlates) {
     this.program = program; // may be null
-    this.typeFactory = requireNonNull(typeFactory);
-    this.conformance = requireNonNull(conformance);
-    this.root = requireNonNull(root);
+    this.typeFactory = requireNonNull(typeFactory, "typeFactory");
+    this.conformance = requireNonNull(conformance, "conformance");
+    this.root = requireNonNull(root, "root");
     this.inputGetter = inputGetter;
-    this.list = requireNonNull(list);
-    this.builder = requireNonNull(builder);
+    this.list = requireNonNull(list, "list");
+    this.builder = requireNonNull(builder, "builder");
     this.correlates = correlates; // may be null
   }
 

core/src/main/java/org/apache/calcite/adapter/jdbc/JdbcCatalogSchema.java

@@ -68,9 +68,9 @@ public class JdbcCatalogSchema extends AbstractSchema {
   /** Creates a JdbcCatalogSchema. */
   public JdbcCatalogSchema(DataSource dataSource, SqlDialect dialect,
       JdbcConvention convention, String catalog) {
-    this.dataSource = requireNonNull(dataSource);
-    this.dialect = requireNonNull(dialect);
-    this.convention = requireNonNull(convention);
+    this.dataSource = requireNonNull(dataSource, "dataSource");
+    this.dialect = requireNonNull(dialect, "dialect");
+    this.convention = requireNonNull(convention, "convention");
     this.catalog = catalog;
   }
 

core/src/main/java/org/apache/calcite/adapter/jdbc/JdbcTable.java

@@ -86,11 +86,11 @@ public class JdbcTable extends AbstractQueryableTable
       String jdbcSchemaName, String jdbcTableName,
       Schema.TableType jdbcTableType) {
     super(Object[].class);
-    this.jdbcSchema = requireNonNull(jdbcSchema);
+    this.jdbcSchema = requireNonNull(jdbcSchema, "jdbcSchema");
     this.jdbcCatalogName = jdbcCatalogName;
     this.jdbcSchemaName = jdbcSchemaName;
-    this.jdbcTableName = requireNonNull(jdbcTableName);
-    this.jdbcTableType = requireNonNull(jdbcTableType);
+    this.jdbcTableName = requireNonNull(jdbcTableName, "jdbcTableName");
+    this.jdbcTableType = requireNonNull(jdbcTableType, "jdbcTableType");
   }
 
   @Override public String toString() {

core/src/main/java/org/apache/calcite/adapter/jdbc/JdbcTableScan.java

@@ -41,7 +41,7 @@ protected JdbcTableScan(
       JdbcTable jdbcTable,
       JdbcConvention jdbcConvention) {
     super(cluster, cluster.traitSetOf(jdbcConvention), ImmutableList.of(), table);
-    this.jdbcTable = Objects.requireNonNull(jdbcTable);
+    this.jdbcTable = Objects.requireNonNull(jdbcTable, "jdbcTable");
   }
 
   @Override public RelNode copy(RelTraitSet traitSet, List<RelNode> inputs) {

core/src/main/java/org/apache/calcite/config/Lex.java

@@ -87,9 +87,9 @@ public enum Lex {
       Casing quotedCasing,
       boolean caseSensitive,
       CharLiteralStyle... charLiteralStyles) {
-    this.quoting = Objects.requireNonNull(quoting);
-    this.unquotedCasing = Objects.requireNonNull(unquotedCasing);
-    this.quotedCasing = Objects.requireNonNull(quotedCasing);
+    this.quoting = Objects.requireNonNull(quoting, "quoting");
+    this.unquotedCasing = Objects.requireNonNull(unquotedCasing, "unquotedCasing");
+    this.quotedCasing = Objects.requireNonNull(quotedCasing, "quotedCasing");
     this.caseSensitive = caseSensitive;
     this.charLiteralStyles = ImmutableSet.copyOf(charLiteralStyles);
   }

core/src/main/java/org/apache/calcite/interpreter/Bindables.java

@@ -214,8 +214,8 @@ public static class BindableTableScan
         RelOptTable table, ImmutableList<RexNode> filters,
         ImmutableIntList projects) {
       super(cluster, traitSet, ImmutableList.of(), table);
-      this.filters = Objects.requireNonNull(filters);
-      this.projects = Objects.requireNonNull(projects);
+      this.filters = Objects.requireNonNull(filters, "filters");
+      this.projects = Objects.requireNonNull(projects, "projects");
       Preconditions.checkArgument(canHandle(table));
     }
 

core/src/main/java/org/apache/calcite/interpreter/Interpreter.java

@@ -87,7 +87,7 @@ public class Interpreter extends AbstractEnumerable<@Nullable Object[]>
 
   /** Creates an Interpreter. */
   public Interpreter(DataContext dataContext, RelNode rootRel) {
-    this.dataContext = requireNonNull(dataContext);
+    this.dataContext = requireNonNull(dataContext, "dataContext");
     final RelNode rel = optimize(rootRel);
     final CompilerImpl compiler =
         new Nodes.CoreCompiler(this, rootRel.getCluster());
@@ -280,7 +280,7 @@ private static class EnumeratorSource implements Source {
     private final Enumerator<Row> enumerator;
 
     EnumeratorSource(final Enumerator<Row> enumerator) {
-      this.enumerator = requireNonNull(enumerator);
+      this.enumerator = requireNonNull(enumerator, "enumerator");
     }
 
     @Override public @Nullable Row receive() {

core/src/main/java/org/apache/calcite/jdbc/CalciteConnectionImpl.java

@@ -509,7 +509,7 @@ static class ContextImpl implements CalcitePrepare.Context {
     private final CalciteSchema rootSchema;
 
     ContextImpl(CalciteConnectionImpl connection) {
-      this.connection = requireNonNull(connection);
+      this.connection = requireNonNull(connection, "connection");
       long now = System.currentTimeMillis();
       SchemaVersion schemaVersion = new LongSchemaVersion(now);
       this.mutableRootSchema = connection.rootSchema;
@@ -601,7 +601,7 @@ static class CalciteServerStatementImpl
     private final AtomicBoolean cancelFlag = new AtomicBoolean();
 
     CalciteServerStatementImpl(CalciteConnectionImpl connection) {
-      this.connection = requireNonNull(connection);
+      this.connection = requireNonNull(connection, "connection");
     }
 
     @Override public Context createPrepareContext() {

core/src/main/java/org/apache/calcite/jdbc/CalciteMetaImpl.java

@@ -165,7 +165,7 @@ public static Pattern likeToRegex(Pat pattern) {
 
   private <E> MetaResultSet createResultSet(Enumerable<E> enumerable,
       Class clazz, String... names) {
-    requireNonNull(names);
+    requireNonNull(names, "names");
     final List<ColumnMetaData> columns = new ArrayList<>(names.length);
     final List<Field> fields = new ArrayList<>(names.length);
     final List<String> fieldNames = new ArrayList<>(names.length);
@@ -752,7 +752,7 @@ private static class CalciteMetaTable extends MetaTable {
         String tableSchem, String tableName) {
       super(tableCat, tableSchem, tableName,
           calciteTable.getJdbcTableType().jdbcName);
-      this.calciteTable = requireNonNull(calciteTable);
+      this.calciteTable = requireNonNull(calciteTable, "calciteTable");
     }
   }
 

core/src/main/java/org/apache/calcite/jdbc/CalciteSchema.java

@@ -90,17 +90,17 @@ protected CalciteSchema(@Nullable CalciteSchema parent, Schema schema,
     if (tableMap == null) {
       this.tableMap = new NameMap<>();
     } else {
-      this.tableMap = Objects.requireNonNull(tableMap);
+      this.tableMap = Objects.requireNonNull(tableMap, "tableMap");
     }
     if (latticeMap == null) {
       this.latticeMap = new NameMap<>();
     } else {
-      this.latticeMap = Objects.requireNonNull(latticeMap);
+      this.latticeMap = Objects.requireNonNull(latticeMap, "latticeMap");
     }
     if (subSchemaMap == null) {
       this.subSchemaMap = new NameMap<>();
     } else {
-      this.subSchemaMap = Objects.requireNonNull(subSchemaMap);
+      this.subSchemaMap = Objects.requireNonNull(subSchemaMap, "subSchemaMap");
     }
     if (functionMap == null) {
       this.functionMap = new NameMultimap<>();
@@ -109,14 +109,14 @@ protected CalciteSchema(@Nullable CalciteSchema parent, Schema schema,
     } else {
       // If you specify functionMap, you must also specify functionNames and
       // nullaryFunctionMap.
-      this.functionMap = Objects.requireNonNull(functionMap);
-      this.functionNames = Objects.requireNonNull(functionNames);
-      this.nullaryFunctionMap = Objects.requireNonNull(nullaryFunctionMap);
+      this.functionMap = Objects.requireNonNull(functionMap, "functionMap");
+      this.functionNames = Objects.requireNonNull(functionNames, "functionNames");
+      this.nullaryFunctionMap = Objects.requireNonNull(nullaryFunctionMap, "nullaryFunctionMap");
     }
     if (typeMap == null) {
       this.typeMap = new NameMap<>();
     } else {
-      this.typeMap = Objects.requireNonNull(typeMap);
+      this.typeMap = Objects.requireNonNull(typeMap, "typeMap");
     }
     this.path = path;
   }
@@ -568,8 +568,8 @@ public abstract static class Entry {
     public final String name;
 
     protected Entry(CalciteSchema schema, String name) {
-      this.schema = Objects.requireNonNull(schema);
-      this.name = Objects.requireNonNull(name);
+      this.schema = Objects.requireNonNull(schema, "schema");
+      this.name = Objects.requireNonNull(name, "name");
     }
 
     /** Returns this object's path. For example ["hr", "emps"]. */
@@ -585,7 +585,7 @@ public abstract static class TableEntry extends Entry {
     protected TableEntry(CalciteSchema schema, String name,
         ImmutableList<String> sqls) {
       super(schema, name);
-      this.sqls = Objects.requireNonNull(sqls);
+      this.sqls = Objects.requireNonNull(sqls, "sqls");
     }
 
     public abstract Table getTable();
@@ -754,7 +754,7 @@ public static class TableEntryImpl extends TableEntry {
     public TableEntryImpl(CalciteSchema schema, String name, Table table,
         ImmutableList<String> sqls) {
       super(schema, name, sqls);
-      this.table = Objects.requireNonNull(table);
+      this.table = Objects.requireNonNull(table, "table");
     }
 
     @Override public Table getTable() {

core/src/main/java/org/apache/calcite/jdbc/JavaRecordType.java

@@ -36,7 +36,7 @@ public class JavaRecordType extends RelRecordType {
 
   public JavaRecordType(List<RelDataTypeField> fields, Class clazz) {
     super(fields);
-    this.clazz = Objects.requireNonNull(clazz);
+    this.clazz = Objects.requireNonNull(clazz, "clazz");
   }
 
   @Override public boolean equals(@Nullable Object obj) {

core/src/main/java/org/apache/calcite/jdbc/JavaTypeFactoryImpl.java

@@ -402,9 +402,9 @@ private static class RecordFieldImpl implements Types.RecordField {
         Type type,
         boolean nullable,
         int modifiers) {
-      this.syntheticType = requireNonNull(syntheticType);
-      this.name = requireNonNull(name);
-      this.type = requireNonNull(type);
+      this.syntheticType = requireNonNull(syntheticType, "syntheticType");
+      this.name = requireNonNull(name, "name");
+      this.type = requireNonNull(type, "type");
       this.nullable = nullable;
       this.modifiers = modifiers;
       assert !(nullable && Primitive.is(type))

core/src/main/java/org/apache/calcite/materialize/Lattice.java

@@ -114,13 +114,13 @@ private Lattice(CalciteSchema rootSchema, LatticeRootNode rootNode,
       ImmutableSortedSet<Measure> defaultMeasures, ImmutableList<Tile> tiles,
       ImmutableListMultimap<Integer, Boolean> columnUses) {
     this.rootSchema = rootSchema;
-    this.rootNode = requireNonNull(rootNode);
-    this.columns = requireNonNull(columns);
+    this.rootNode = requireNonNull(rootNode, "rootNode");
+    this.columns = requireNonNull(columns, "columns");
     this.auto = auto;
     this.algorithm = algorithm;
     this.algorithmMaxMillis = algorithmMaxMillis;
     this.defaultMeasures = defaultMeasures.asList(); // unique and sorted
-    this.tiles = requireNonNull(tiles);
+    this.tiles = requireNonNull(tiles, "tiles");
     this.columnUses = columnUses;
 
     assert isValid(Litmus.THROW);
@@ -560,7 +560,7 @@ public static class Measure implements Comparable<Measure> {
 
     public Measure(SqlAggFunction agg, boolean distinct, @Nullable String name,
         Iterable<Column> args) {
-      this.agg = requireNonNull(agg);
+      this.agg = requireNonNull(agg, "agg");
       this.distinct = distinct;
       this.name = name;
       this.args = ImmutableList.copyOf(args);
@@ -656,7 +656,7 @@ public abstract static class Column implements Comparable<Column> {
 
     private Column(int ordinal, String alias) {
       this.ordinal = ordinal;
-      this.alias = requireNonNull(alias);
+      this.alias = requireNonNull(alias, "alias");
     }
 
     /** Converts a list of columns to a bit set of their ordinals. */
@@ -701,8 +701,8 @@ public static class BaseColumn extends Column {
 
     private BaseColumn(int ordinal, String table, String column, String alias) {
       super(ordinal, alias);
-      this.table = requireNonNull(table);
-      this.column = requireNonNull(column);
+      this.table = requireNonNull(table, "table");
+      this.column = requireNonNull(column, "column");
     }
 
     @Override public String toString() {
@@ -1147,8 +1147,8 @@ public static class Tile {
 
     public Tile(ImmutableList<Measure> measures,
         ImmutableList<Column> dimensions) {
-      this.measures = requireNonNull(measures);
-      this.dimensions = requireNonNull(dimensions);
+      this.measures = requireNonNull(measures, "measures");
+      this.dimensions = requireNonNull(dimensions, "dimensions");
       assert Ordering.natural().isStrictlyOrdered(dimensions);
       assert Ordering.natural().isStrictlyOrdered(measures);
       bitSet = Column.toBitSet(dimensions);

core/src/main/java/org/apache/calcite/materialize/LatticeSpace.java

@@ -51,7 +51,7 @@ class LatticeSpace {
   final Map<LatticeTable, List<RexNode>> tableExpressions = new HashMap<>();
 
   LatticeSpace(SqlStatisticProvider statisticProvider) {
-    this.statisticProvider = Objects.requireNonNull(statisticProvider);
+    this.statisticProvider = Objects.requireNonNull(statisticProvider, "statisticProvider");
   }
 
   /** Derives a unique name for a table, qualifying with schema name only if

core/src/main/java/org/apache/calcite/materialize/LatticeSuggester.java

@@ -633,7 +633,7 @@ private static class TableRef {
     private final int ordinalInQuery;
 
     private TableRef(LatticeTable table, int ordinalInQuery) {
-      this.table = requireNonNull(table);
+      this.table = requireNonNull(table, "table");
       this.ordinalInQuery = ordinalInQuery;
     }
 
@@ -659,7 +659,7 @@ private static class StepRef extends DefaultEdge {
 
     StepRef(TableRef source, TableRef target, Step step, int ordinalInQuery) {
       super(source, target);
-      this.step = requireNonNull(step);
+      this.step = requireNonNull(step, "step");
       this.ordinalInQuery = ordinalInQuery;
     }
 

core/src/main/java/org/apache/calcite/materialize/LatticeTable.java

@@ -30,7 +30,7 @@ public class LatticeTable {
   public final String alias;
 
   LatticeTable(RelOptTable table) {
-    t = Objects.requireNonNull(table);
+    t = Objects.requireNonNull(table, "table");
     alias = Objects.requireNonNull(Util.last(table.getQualifiedName()));
   }
 

core/src/main/java/org/apache/calcite/materialize/MaterializationActor.java

@@ -77,7 +77,7 @@ static class Materialization {
         RelDataType rowType,
         @Nullable List<String> viewSchemaPath) {
       this.key = key;
-      this.rootSchema = Objects.requireNonNull(rootSchema);
+      this.rootSchema = Objects.requireNonNull(rootSchema, "rootSchema");
       Preconditions.checkArgument(rootSchema.isRoot(), "must be root schema");
       this.materializedTable = materializedTable; // may be null
       this.sql = sql;

core/src/main/java/org/apache/calcite/materialize/MutableNode.java

@@ -66,7 +66,7 @@ class MutableNode {
   /** Creates a non-root node. */
   @SuppressWarnings("argument.type.incompatible")
   MutableNode(LatticeTable table, @Nullable MutableNode parent, @Nullable Step step) {
-    this.table = Objects.requireNonNull(table);
+    this.table = Objects.requireNonNull(table, "table");
     this.parent = parent;
     this.step = step;
     if (parent != null) {

core/src/main/java/org/apache/calcite/materialize/ProfilerLatticeStatisticProvider.java

@@ -46,7 +46,7 @@ class ProfilerLatticeStatisticProvider implements LatticeStatisticProvider {
 
   /** Creates a ProfilerLatticeStatisticProvider. */
   private ProfilerLatticeStatisticProvider(Lattice lattice) {
-    Objects.requireNonNull(lattice);
+    Objects.requireNonNull(lattice, "lattice");
     this.profile = Suppliers.memoize(() -> {
       final ProfilerImpl profiler =
           ProfilerImpl.builder()

core/src/main/java/org/apache/calcite/materialize/SqlLatticeStatisticProvider.java

@@ -48,7 +48,7 @@ class SqlLatticeStatisticProvider implements LatticeStatisticProvider {
 
   /** Creates a SqlLatticeStatisticProvider. */
   private SqlLatticeStatisticProvider(Lattice lattice) {
-    this.lattice = requireNonNull(lattice);
+    this.lattice = requireNonNull(lattice, "lattice");
   }
 
   @Override public double cardinality(List<Lattice.Column> columns) {

core/src/main/java/org/apache/calcite/materialize/Step.java

@@ -51,7 +51,7 @@ private Step(LatticeTable source, LatticeTable target,
       List<IntPair> keys, String keyString) {
     super(source, target);
     this.keys = ImmutableList.copyOf(keys);
-    this.keyString = Objects.requireNonNull(keyString);
+    this.keyString = Objects.requireNonNull(keyString, "keyString");
     assert IntPair.ORDERING.isStrictlyOrdered(keys); // ordered and unique
   }
 
@@ -147,7 +147,7 @@ static class Factory implements AttributedDirectedGraph.AttributedEdgeFactory<
 
     @SuppressWarnings("type.argument.type.incompatible")
     Factory(@UnderInitialization LatticeSpace space) {
-      this.space = Objects.requireNonNull(space);
+      this.space = Objects.requireNonNull(space, "space");
     }
 
     @Override public Step createEdge(LatticeTable source, LatticeTable target) {

core/src/main/java/org/apache/calcite/plan/AbstractRelOptPlanner.java

@@ -94,7 +94,7 @@ public abstract class AbstractRelOptPlanner implements RelOptPlanner {
    */
   protected AbstractRelOptPlanner(RelOptCostFactory costFactory,
       @Nullable Context context) {
-    this.costFactory = Objects.requireNonNull(costFactory);
+    this.costFactory = Objects.requireNonNull(costFactory, "costFactory");
     if (context == null) {
       context = Contexts.empty();
     }