You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@calcite.apache.org by jh...@apache.org on 2023/06/08 23:28:05 UTC
[calcite] 05/06: Code style: Lint
This is an automated email from the ASF dual-hosted git repository.
jhyde pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/calcite.git
commit abf05e39ee822bae2e5da6526aeb40bbbbe0ea2e
Author: Julian Hyde <jh...@apache.org>
AuthorDate: Sun Jun 4 11:18:51 2023 -0700
Code style: Lint
Add an autostyle rule, and fix its one violation.
Fix lint violations detected by [CALCITE-5765] LintTest (to follow).
---
build.gradle.kts | 1 +
core/src/main/java/org/apache/calcite/plan/SubstitutionVisitor.java | 2 +-
.../java/org/apache/calcite/plan/volcano/IterativeRuleDriver.java | 2 +-
core/src/main/java/org/apache/calcite/rex/RexVisitorImpl.java | 4 ++--
.../src/main/java/org/apache/calcite/sql/SqlDescriptorOperator.java | 2 +-
core/src/main/java/org/apache/calcite/util/Glossary.java | 2 +-
.../src/test/java/org/apache/calcite/rex/RexProgramBuilderBase.java | 2 +-
core/src/test/java/org/apache/calcite/test/JdbcTest.java | 3 +--
core/src/test/java/org/apache/calcite/test/SqlValidatorTest.java | 6 ++----
.../test/java/org/apache/calcite/util/graph/DirectedGraphTest.java | 2 +-
.../java/org/apache/calcite/adapter/elasticsearch/Scrolling.java | 2 +-
.../src/main/java/org/apache/calcite/linq4j/EnumerableDefaults.java | 4 ++--
.../src/main/java/org/apache/calcite/linq4j/QueryableDefaults.java | 2 +-
linq4j/src/main/java/org/apache/calcite/linq4j/tree/Blocks.java | 2 +-
linq4j/src/main/java/org/apache/calcite/linq4j/tree/Expression.java | 2 +-
linq4j/src/main/java/org/apache/calcite/linq4j/tree/Statement.java | 2 +-
16 files changed, 19 insertions(+), 21 deletions(-)
diff --git a/build.gradle.kts b/build.gradle.kts
index 87d7b9399c..f618a99340 100644
--- a/build.gradle.kts
+++ b/build.gradle.kts
@@ -603,6 +603,7 @@ allprojects {
replace("hamcrest: anyOf", "org.hamcrest.core.AnyOf.anyOf", "org.hamcrest.CoreMatchers.anyOf")
replace("hamcrest: containsString", "org.hamcrest.core.StringContains.containsString", "org.hamcrest.CoreMatchers.containsString")
replace("hamcrest: CoreMatchers", "import org.hamcrest.CoreMatchers;", "import static org.hamcrest.CoreMatchers.anything;")
+ replace("hamcrest: empty", "org.hamcrest.collection.IsEmptyCollection.empty", "org.hamcrest.Matchers.empty")
replace("hamcrest: emptyArray", "org.hamcrest.collection.IsArrayWithSize.emptyArray", "org.hamcrest.Matchers.emptyArray")
replace("hamcrest: endsWidth", "org.hamcrest.core.StringEndsWith.endsWith", "org.hamcrest.CoreMatchers.endsWith")
replace("hamcrest: equalTo", "org.hamcrest.core.IsEqual.equalTo", "org.hamcrest.CoreMatchers.equalTo")
diff --git a/core/src/main/java/org/apache/calcite/plan/SubstitutionVisitor.java b/core/src/main/java/org/apache/calcite/plan/SubstitutionVisitor.java
index 9668f44625..53c03f810a 100644
--- a/core/src/main/java/org/apache/calcite/plan/SubstitutionVisitor.java
+++ b/core/src/main/java/org/apache/calcite/plan/SubstitutionVisitor.java
@@ -877,7 +877,7 @@ public class SubstitutionVisitor {
}
/**
- * <p>Applies this rule to a particular node in a query. The goal is
+ * Applies this rule to a particular node in a query. The goal is
* to convert {@code query} into {@code target}. Before the rule is
* invoked, Calcite has made sure that query's children are equivalent
* to target's children.
diff --git a/core/src/main/java/org/apache/calcite/plan/volcano/IterativeRuleDriver.java b/core/src/main/java/org/apache/calcite/plan/volcano/IterativeRuleDriver.java
index a43a500db4..9aea576e95 100644
--- a/core/src/main/java/org/apache/calcite/plan/volcano/IterativeRuleDriver.java
+++ b/core/src/main/java/org/apache/calcite/plan/volcano/IterativeRuleDriver.java
@@ -22,7 +22,7 @@ import org.apache.calcite.util.trace.CalciteTrace;
import org.slf4j.Logger;
/***
- * <p>The algorithm executes repeatedly. The exact rules
+ * The algorithm executes repeatedly. The exact rules
* that may be fired varies.
*
* <p>The planner iterates over the rule matches presented
diff --git a/core/src/main/java/org/apache/calcite/rex/RexVisitorImpl.java b/core/src/main/java/org/apache/calcite/rex/RexVisitorImpl.java
index a0a45f5229..4f1fd8d63e 100644
--- a/core/src/main/java/org/apache/calcite/rex/RexVisitorImpl.java
+++ b/core/src/main/java/org/apache/calcite/rex/RexVisitorImpl.java
@@ -119,7 +119,7 @@ public class RexVisitorImpl<@Nullable R> implements RexVisitor<R> {
}
/**
- * <p>Visits an array of expressions, returning the logical 'and' of their
+ * Visits an array of expressions, returning the logical 'and' of their
* results.
*
* <p>If any of them returns false, returns false immediately; if they all
@@ -141,7 +141,7 @@ public class RexVisitorImpl<@Nullable R> implements RexVisitor<R> {
}
/**
- * <p>Visits an array of expressions, returning the logical 'or' of their
+ * Visits an array of expressions, returning the logical 'or' of their
* results.
*
* <p>If any of them returns true, returns true immediately; if they all
diff --git a/core/src/main/java/org/apache/calcite/sql/SqlDescriptorOperator.java b/core/src/main/java/org/apache/calcite/sql/SqlDescriptorOperator.java
index 90cc7cccef..ef88e6691a 100644
--- a/core/src/main/java/org/apache/calcite/sql/SqlDescriptorOperator.java
+++ b/core/src/main/java/org/apache/calcite/sql/SqlDescriptorOperator.java
@@ -25,7 +25,7 @@ import org.apache.calcite.sql.validate.SqlValidatorScope;
import static org.apache.calcite.util.Static.RESOURCE;
/**
- * <p>DESCRIPTOR appears as an argument in a function. DESCRIPTOR accepts a list of
+ * DESCRIPTOR appears as an argument in a function. DESCRIPTOR accepts a list of
* identifiers that represent a list of names. The interpretation of names is left
* to the function.
*
diff --git a/core/src/main/java/org/apache/calcite/util/Glossary.java b/core/src/main/java/org/apache/calcite/util/Glossary.java
index 3ee9c8989c..ddd6a723ef 100644
--- a/core/src/main/java/org/apache/calcite/util/Glossary.java
+++ b/core/src/main/java/org/apache/calcite/util/Glossary.java
@@ -29,7 +29,7 @@ public interface Glossary {
// CHECKSTYLE: OFF
/**
- * <p>This table shows how and where the Gang of Four patterns are applied.
+ * This table shows how and where the Gang of Four patterns are applied.
* The table uses information from the GoF book and from a course on
* advanced object design taught by Craig Larman.
*
diff --git a/core/src/test/java/org/apache/calcite/rex/RexProgramBuilderBase.java b/core/src/test/java/org/apache/calcite/rex/RexProgramBuilderBase.java
index bc2b51da29..7fc52d9efa 100644
--- a/core/src/test/java/org/apache/calcite/rex/RexProgramBuilderBase.java
+++ b/core/src/test/java/org/apache/calcite/rex/RexProgramBuilderBase.java
@@ -251,7 +251,7 @@ public abstract class RexProgramBuilderBase {
* <p>Tries to expand the cast, and therefore the result may be something
* other than a {@link RexCall} to the CAST operator, such as a
* {@link RexLiteral}.
-
+ *
* @param e input node
* @param type type to cast to
* @return input node converted to given type
diff --git a/core/src/test/java/org/apache/calcite/test/JdbcTest.java b/core/src/test/java/org/apache/calcite/test/JdbcTest.java
index ad06270d49..2367c88699 100644
--- a/core/src/test/java/org/apache/calcite/test/JdbcTest.java
+++ b/core/src/test/java/org/apache/calcite/test/JdbcTest.java
@@ -474,8 +474,7 @@ public class JdbcTest {
connection.close();
}
- /**
- * <p>Test case for
+ /** Test case for
* <a href="https://issues.apache.org/jira/browse/CALCITE-3423">[CALCITE-3423]
* Support using CAST operation and BOOLEAN type value in table macro</a>. */
@Test void testTableMacroWithCastOrBoolean() throws SQLException {
diff --git a/core/src/test/java/org/apache/calcite/test/SqlValidatorTest.java b/core/src/test/java/org/apache/calcite/test/SqlValidatorTest.java
index c1df80bd00..1ae294a41f 100644
--- a/core/src/test/java/org/apache/calcite/test/SqlValidatorTest.java
+++ b/core/src/test/java/org/apache/calcite/test/SqlValidatorTest.java
@@ -106,10 +106,8 @@ public class SqlValidatorTest extends SqlValidatorTestCase {
//~ Static fields/initializers ---------------------------------------------
// CHECKSTYLE: IGNORE 1
- /**
- * @deprecated Deprecated so that usages of this constant will show up in
- * yellow in Intellij and maybe someone will fix them.
- */
+ /** @deprecated Deprecated so that usages of this constant will show up in
+ * yellow in Intellij and maybe someone will fix them. */
protected static final boolean TODO = false;
private static final String ANY = "(?s).*";
diff --git a/core/src/test/java/org/apache/calcite/util/graph/DirectedGraphTest.java b/core/src/test/java/org/apache/calcite/util/graph/DirectedGraphTest.java
index 2c4c6a27f7..1425c40dd0 100644
--- a/core/src/test/java/org/apache/calcite/util/graph/DirectedGraphTest.java
+++ b/core/src/test/java/org/apache/calcite/util/graph/DirectedGraphTest.java
@@ -33,9 +33,9 @@ import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.CoreMatchers.notNullValue;
import static org.hamcrest.CoreMatchers.nullValue;
import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.empty;
import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.hasToString;
-import static org.hamcrest.collection.IsEmptyCollection.empty;
import static org.hamcrest.collection.IsIterableWithSize.iterableWithSize;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
diff --git a/elasticsearch/src/main/java/org/apache/calcite/adapter/elasticsearch/Scrolling.java b/elasticsearch/src/main/java/org/apache/calcite/adapter/elasticsearch/Scrolling.java
index 573ddc2ca5..a75c061df8 100644
--- a/elasticsearch/src/main/java/org/apache/calcite/adapter/elasticsearch/Scrolling.java
+++ b/elasticsearch/src/main/java/org/apache/calcite/adapter/elasticsearch/Scrolling.java
@@ -27,7 +27,7 @@ import java.util.Objects;
import java.util.function.Consumer;
/**
- * <p>"Iterator" which retrieves results lazily and in batches. Uses
+ * "Iterator" which retrieves results lazily and in batches. Uses
* <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html">Elastic Scrolling API</a>
* to optimally consume large search results.
*
diff --git a/linq4j/src/main/java/org/apache/calcite/linq4j/EnumerableDefaults.java b/linq4j/src/main/java/org/apache/calcite/linq4j/EnumerableDefaults.java
index 9bf171e5a4..ae92498dc2 100644
--- a/linq4j/src/main/java/org/apache/calcite/linq4j/EnumerableDefaults.java
+++ b/linq4j/src/main/java/org/apache/calcite/linq4j/EnumerableDefaults.java
@@ -321,7 +321,7 @@ public abstract class EnumerableDefaults {
}
/**
- * <p>Analogous to LINQ's Enumerable.Cast extension method.
+ * Analogous to LINQ's Enumerable.Cast extension method.
*
* @param clazz Target type
* @param <T2> Target type
@@ -1644,7 +1644,7 @@ public abstract class EnumerableDefaults {
}
/**
- * <p>Fetches blocks of size {@code batchSize} from {@code outer},
+ * Fetches blocks of size {@code batchSize} from {@code outer},
* storing each block into a list ({@code outerValues}).
* For each block, it uses the {@code inner} function to
* obtain an enumerable with the correlated rows from the right (inner) input.
diff --git a/linq4j/src/main/java/org/apache/calcite/linq4j/QueryableDefaults.java b/linq4j/src/main/java/org/apache/calcite/linq4j/QueryableDefaults.java
index f84c085343..e3d96a3aec 100644
--- a/linq4j/src/main/java/org/apache/calcite/linq4j/QueryableDefaults.java
+++ b/linq4j/src/main/java/org/apache/calcite/linq4j/QueryableDefaults.java
@@ -218,7 +218,7 @@ public abstract class QueryableDefaults {
}
/**
- * <p>Analogous to LINQ's Enumerable.Cast extension method.
+ * Analogous to LINQ's Enumerable.Cast extension method.
*
* @param clazz Target type
* @param <T2> Target type
diff --git a/linq4j/src/main/java/org/apache/calcite/linq4j/tree/Blocks.java b/linq4j/src/main/java/org/apache/calcite/linq4j/tree/Blocks.java
index 578767adb6..b1a47c7d55 100644
--- a/linq4j/src/main/java/org/apache/calcite/linq4j/tree/Blocks.java
+++ b/linq4j/src/main/java/org/apache/calcite/linq4j/tree/Blocks.java
@@ -19,7 +19,7 @@ package org.apache.calcite.linq4j.tree;
import static java.util.Objects.requireNonNull;
/**
- * <p>Helper methods concerning {@link BlockStatement}s.
+ * Helper methods concerning {@link BlockStatement}s.
*
* @see BlockBuilder
*/
diff --git a/linq4j/src/main/java/org/apache/calcite/linq4j/tree/Expression.java b/linq4j/src/main/java/org/apache/calcite/linq4j/tree/Expression.java
index 15eb8bff9f..8354484c74 100644
--- a/linq4j/src/main/java/org/apache/calcite/linq4j/tree/Expression.java
+++ b/linq4j/src/main/java/org/apache/calcite/linq4j/tree/Expression.java
@@ -19,7 +19,7 @@ package org.apache.calcite.linq4j.tree;
import java.lang.reflect.Type;
/**
- * <p>Analogous to LINQ's System.Linq.Expression.
+ * Analogous to LINQ's System.Linq.Expression.
*/
public abstract class Expression extends AbstractNode {
diff --git a/linq4j/src/main/java/org/apache/calcite/linq4j/tree/Statement.java b/linq4j/src/main/java/org/apache/calcite/linq4j/tree/Statement.java
index 8897ca11be..18648a4fc0 100644
--- a/linq4j/src/main/java/org/apache/calcite/linq4j/tree/Statement.java
+++ b/linq4j/src/main/java/org/apache/calcite/linq4j/tree/Statement.java
@@ -19,7 +19,7 @@ package org.apache.calcite.linq4j.tree;
import java.lang.reflect.Type;
/**
- * <p>Statement.
+ * Statement.
*/
public abstract class Statement extends AbstractNode {
protected Statement(ExpressionType nodeType, Type type) {