This is an automated email from the ASF dual-hosted git repository.
dpitkin pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new 48782e7570 MINOR: [Java] Bump com.puppycrawl.tools:checkstyle from
8.29 to 10.17.0 in /java (#43311)
48782e7570 is described below
commit 48782e75708157f2296ab95699239207c5588871
Author: Dane Pitkin <[email protected]>
AuthorDate: Tue Jul 30 09:21:58 2024 -0400
MINOR: [Java] Bump com.puppycrawl.tools:checkstyle from 8.29 to 10.17.0 in
/java (#43311)
### Rationale for this change
Now that Java 8 is deprecated, we can bump checkstyle to latest version.
### What changes are included in this PR?
* Bump checkstyle to 10.17.0
* Update checkstyle.xml to fix backwards-breaking changes
* Fix new check errors
### Are these changes tested?
CI
### Are there any user-facing changes?
No
Authored-by: Dane Pitkin <[email protected]>
Signed-off-by: Dane Pitkin <[email protected]>
---
java/.gitattributes | 1 +
java/dev/checkstyle/checkstyle.xml | 2 +-
.../arrow/driver/jdbc/utils/VectorSchemaRootTransformer.java | 11 +++++++++++
java/pom.xml | 3 ++-
.../java/org/apache/arrow/vector/BaseFixedWidthVector.java | 2 +-
.../org/apache/arrow/vector/BaseLargeVariableWidthVector.java | 2 +-
.../java/org/apache/arrow/vector/BaseVariableWidthVector.java | 2 +-
.../org/apache/arrow/vector/BaseVariableWidthViewVector.java | 2 +-
.../java/org/apache/arrow/vector/ExtensionTypeVector.java | 2 +-
.../src/main/java/org/apache/arrow/vector/FieldVector.java | 2 +-
.../src/main/java/org/apache/arrow/vector/NullVector.java | 2 +-
.../apache/arrow/vector/complex/BaseRepeatedValueVector.java | 2 +-
.../java/org/apache/arrow/vector/complex/LargeListVector.java | 4 ++--
.../main/java/org/apache/arrow/vector/complex/ListVector.java | 2 +-
.../org/apache/arrow/vector/complex/RepeatedValueVector.java | 2 +-
.../java/org/apache/arrow/vector/complex/StructVector.java | 2 +-
16 files changed, 28 insertions(+), 15 deletions(-)
diff --git a/java/.gitattributes b/java/.gitattributes
index 596615322f..366d3c2b3c 100644
--- a/java/.gitattributes
+++ b/java/.gitattributes
@@ -1,2 +1,3 @@
.gitattributes export-ignore
.gitignore export-ignore
+* text=auto eol=lf
diff --git a/java/dev/checkstyle/checkstyle.xml
b/java/dev/checkstyle/checkstyle.xml
index eb63c3ff0f..4b546ac56e 100644
--- a/java/dev/checkstyle/checkstyle.xml
+++ b/java/dev/checkstyle/checkstyle.xml
@@ -180,7 +180,7 @@
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
</module>
<module name="JavadocMethod">
- <property name="scope" value="public"/>
+ <property name="accessModifiers" value="public"/>
<property name="allowMissingParamTags" value="true"/>
<property name="allowMissingReturnTag" value="true"/>
<property name="allowedAnnotations" value="Override, Test"/>
diff --git
a/java/flight/flight-sql-jdbc-core/src/main/java/org/apache/arrow/driver/jdbc/utils/VectorSchemaRootTransformer.java
b/java/flight/flight-sql-jdbc-core/src/main/java/org/apache/arrow/driver/jdbc/utils/VectorSchemaRootTransformer.java
index b651e1eb9b..b3c7a1ee5c 100644
---
a/java/flight/flight-sql-jdbc-core/src/main/java/org/apache/arrow/driver/jdbc/utils/VectorSchemaRootTransformer.java
+++
b/java/flight/flight-sql-jdbc-core/src/main/java/org/apache/arrow/driver/jdbc/utils/VectorSchemaRootTransformer.java
@@ -44,6 +44,12 @@ public interface VectorSchemaRootTransformer {
private final List<Field> newFields = new ArrayList<>();
private final Collection<Task> tasks = new ArrayList<>();
+ /**
+ * Constructor for the VectorSchemaRootTransformer's Builder.
+ *
+ * @param schema The Arrow schema.
+ * @param bufferAllocator The BufferAllocator to use for allocating memory.
+ */
public Builder(final Schema schema, final BufferAllocator bufferAllocator)
{
this.schema = schema;
this.bufferAllocator =
@@ -127,6 +133,11 @@ public interface VectorSchemaRootTransformer {
return this;
}
+ /**
+ * Build the {@link VectorSchemaRoot} with applied transformation tasks.
+ *
+ * @return The built {@link VectorSchemaRoot}.
+ */
public VectorSchemaRootTransformer build() {
return (originalRoot, transformedRoot) -> {
if (transformedRoot == null) {
diff --git a/java/pom.xml b/java/pom.xml
index c62ae332b1..838e60b037 100644
--- a/java/pom.xml
+++ b/java/pom.xml
@@ -105,6 +105,7 @@ under the License.
<dep.avro.version>1.11.3</dep.avro.version>
<arrow.vector.classifier></arrow.vector.classifier>
<forkCount>2</forkCount>
+ <checkstyle.version>10.17.0</checkstyle.version>
<checkstyle.failOnViolation>true</checkstyle.failOnViolation>
<error_prone_core.version>2.29.2</error_prone_core.version>
<mockito.core.version>5.11.0</mockito.core.version>
@@ -719,7 +720,7 @@ under the License.
<dependency>
<groupId>com.puppycrawl.tools</groupId>
<artifactId>checkstyle</artifactId>
- <version>8.29</version>
+ <version>${checkstyle.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
diff --git
a/java/vector/src/main/java/org/apache/arrow/vector/BaseFixedWidthVector.java
b/java/vector/src/main/java/org/apache/arrow/vector/BaseFixedWidthVector.java
index 50ddf30bf7..387033f0d2 100644
---
a/java/vector/src/main/java/org/apache/arrow/vector/BaseFixedWidthVector.java
+++
b/java/vector/src/main/java/org/apache/arrow/vector/BaseFixedWidthVector.java
@@ -453,9 +453,9 @@ public abstract class BaseFixedWidthVector extends
BaseValueVector
/**
* Get the inner vectors.
*
+ * @return the inner vectors for this field as defined by the TypeLayout
* @deprecated This API will be removed as the current implementations no
longer support inner
* vectors.
- * @return the inner vectors for this field as defined by the TypeLayout
*/
@Deprecated
@Override
diff --git
a/java/vector/src/main/java/org/apache/arrow/vector/BaseLargeVariableWidthVector.java
b/java/vector/src/main/java/org/apache/arrow/vector/BaseLargeVariableWidthVector.java
index 3a177f84c9..552a896ea8 100644
---
a/java/vector/src/main/java/org/apache/arrow/vector/BaseLargeVariableWidthVector.java
+++
b/java/vector/src/main/java/org/apache/arrow/vector/BaseLargeVariableWidthVector.java
@@ -259,9 +259,9 @@ public abstract class BaseLargeVariableWidthVector extends
BaseValueVector
/**
* Get the inner vectors.
*
+ * @return the inner vectors for this field as defined by the TypeLayout
* @deprecated This API will be removed as the current implementations no
longer support inner
* vectors.
- * @return the inner vectors for this field as defined by the TypeLayout
*/
@Override
@Deprecated
diff --git
a/java/vector/src/main/java/org/apache/arrow/vector/BaseVariableWidthVector.java
b/java/vector/src/main/java/org/apache/arrow/vector/BaseVariableWidthVector.java
index 5d761ffbee..aaccec602f 100644
---
a/java/vector/src/main/java/org/apache/arrow/vector/BaseVariableWidthVector.java
+++
b/java/vector/src/main/java/org/apache/arrow/vector/BaseVariableWidthVector.java
@@ -275,9 +275,9 @@ public abstract class BaseVariableWidthVector extends
BaseValueVector
/**
* Get the inner vectors.
*
+ * @return the inner vectors for this field as defined by the TypeLayout
* @deprecated This API will be removed as the current implementations no
longer support inner
* vectors.
- * @return the inner vectors for this field as defined by the TypeLayout
*/
@Deprecated
@Override
diff --git
a/java/vector/src/main/java/org/apache/arrow/vector/BaseVariableWidthViewVector.java
b/java/vector/src/main/java/org/apache/arrow/vector/BaseVariableWidthViewVector.java
index f0c84bd410..aee5233f9d 100644
---
a/java/vector/src/main/java/org/apache/arrow/vector/BaseVariableWidthViewVector.java
+++
b/java/vector/src/main/java/org/apache/arrow/vector/BaseVariableWidthViewVector.java
@@ -315,9 +315,9 @@ public abstract class BaseVariableWidthViewVector extends
BaseValueVector
/**
* Get the inner vectors.
*
+ * @return the inner vectors for this field as defined by the TypeLayout
* @deprecated This API will be removed as the current implementations no
longer support inner
* vectors.
- * @return the inner vectors for this field as defined by the TypeLayout
*/
@Deprecated
@Override
diff --git
a/java/vector/src/main/java/org/apache/arrow/vector/ExtensionTypeVector.java
b/java/vector/src/main/java/org/apache/arrow/vector/ExtensionTypeVector.java
index 208c8b416c..3762fecd0b 100644
--- a/java/vector/src/main/java/org/apache/arrow/vector/ExtensionTypeVector.java
+++ b/java/vector/src/main/java/org/apache/arrow/vector/ExtensionTypeVector.java
@@ -233,9 +233,9 @@ public abstract class ExtensionTypeVector<T extends
ValueVector & FieldVector>
/**
* Get the inner vectors.
*
+ * @return the inner vectors for this field as defined by the TypeLayout
* @deprecated This API will be removed as the current implementations no
longer support inner
* vectors.
- * @return the inner vectors for this field as defined by the TypeLayout
*/
@Deprecated
@Override
diff --git a/java/vector/src/main/java/org/apache/arrow/vector/FieldVector.java
b/java/vector/src/main/java/org/apache/arrow/vector/FieldVector.java
index e58f7bba84..391ef77816 100644
--- a/java/vector/src/main/java/org/apache/arrow/vector/FieldVector.java
+++ b/java/vector/src/main/java/org/apache/arrow/vector/FieldVector.java
@@ -111,9 +111,9 @@ public interface FieldVector extends ValueVector {
/**
* Get the inner vectors.
*
+ * @return the inner vectors for this field as defined by the TypeLayout
* @deprecated This API will be removed as the current implementations no
longer support inner
* vectors.
- * @return the inner vectors for this field as defined by the TypeLayout
*/
@Deprecated
List<BufferBacked> getFieldInnerVectors();
diff --git a/java/vector/src/main/java/org/apache/arrow/vector/NullVector.java
b/java/vector/src/main/java/org/apache/arrow/vector/NullVector.java
index 25e5bdc6f4..227ca716f6 100644
--- a/java/vector/src/main/java/org/apache/arrow/vector/NullVector.java
+++ b/java/vector/src/main/java/org/apache/arrow/vector/NullVector.java
@@ -224,9 +224,9 @@ public class NullVector implements FieldVector,
ValueIterableVector<Object> {
/**
* Get the inner vectors.
*
+ * @return the inner vectors for this field as defined by the TypeLayout
* @deprecated This API will be removed as the current implementations no
longer support inner
* vectors.
- * @return the inner vectors for this field as defined by the TypeLayout
*/
@Deprecated
@Override
diff --git
a/java/vector/src/main/java/org/apache/arrow/vector/complex/BaseRepeatedValueVector.java
b/java/vector/src/main/java/org/apache/arrow/vector/complex/BaseRepeatedValueVector.java
index 10637304df..1cdb87eba0 100644
---
a/java/vector/src/main/java/org/apache/arrow/vector/complex/BaseRepeatedValueVector.java
+++
b/java/vector/src/main/java/org/apache/arrow/vector/complex/BaseRepeatedValueVector.java
@@ -142,9 +142,9 @@ public abstract class BaseRepeatedValueVector extends
BaseValueVector
/**
* Get the offset vector.
*
+ * @return the underlying offset vector or null if none exists.
* @deprecated This API will be removed, as the current implementations no
longer hold inner
* offset vectors.
- * @return the underlying offset vector or null if none exists.
*/
@Override
@Deprecated
diff --git
a/java/vector/src/main/java/org/apache/arrow/vector/complex/LargeListVector.java
b/java/vector/src/main/java/org/apache/arrow/vector/complex/LargeListVector.java
index ef2e7383a9..b5b32c8032 100644
---
a/java/vector/src/main/java/org/apache/arrow/vector/complex/LargeListVector.java
+++
b/java/vector/src/main/java/org/apache/arrow/vector/complex/LargeListVector.java
@@ -319,9 +319,9 @@ public class LargeListVector extends BaseValueVector
/**
* Get the inner vectors.
*
+ * @return the inner vectors for this field as defined by the TypeLayout
* @deprecated This API will be removed as the current implementations no
longer support inner
* vectors.
- * @return the inner vectors for this field as defined by the TypeLayout
*/
@Deprecated
@Override
@@ -494,9 +494,9 @@ public class LargeListVector extends BaseValueVector
/**
* Get the offset vector.
*
+ * @return the underlying offset vector or null if none exists.
* @deprecated This API will be removed, as the current implementations no
longer hold inner
* offset vectors.
- * @return the underlying offset vector or null if none exists.
*/
@Override
@Deprecated
diff --git
a/java/vector/src/main/java/org/apache/arrow/vector/complex/ListVector.java
b/java/vector/src/main/java/org/apache/arrow/vector/complex/ListVector.java
index 17708167ff..a1e18210fc 100644
--- a/java/vector/src/main/java/org/apache/arrow/vector/complex/ListVector.java
+++ b/java/vector/src/main/java/org/apache/arrow/vector/complex/ListVector.java
@@ -277,9 +277,9 @@ public class ListVector extends BaseRepeatedValueVector
/**
* Get the inner vectors.
*
+ * @return the inner vectors for this field as defined by the TypeLayout
* @deprecated This API will be removed as the current implementations no
longer support inner
* vectors.
- * @return the inner vectors for this field as defined by the TypeLayout
*/
@Deprecated
@Override
diff --git
a/java/vector/src/main/java/org/apache/arrow/vector/complex/RepeatedValueVector.java
b/java/vector/src/main/java/org/apache/arrow/vector/complex/RepeatedValueVector.java
index 16492aec74..de7966a0ae 100644
---
a/java/vector/src/main/java/org/apache/arrow/vector/complex/RepeatedValueVector.java
+++
b/java/vector/src/main/java/org/apache/arrow/vector/complex/RepeatedValueVector.java
@@ -35,9 +35,9 @@ public interface RepeatedValueVector extends ValueVector,
DensityAwareVector {
/**
* Get the offset vector.
*
+ * @return the underlying offset vector or null if none exists.
* @deprecated This API will be removed, as the current implementations no
longer hold inner
* offset vectors.
- * @return the underlying offset vector or null if none exists.
*/
@Deprecated
UInt4Vector getOffsetVector();
diff --git
a/java/vector/src/main/java/org/apache/arrow/vector/complex/StructVector.java
b/java/vector/src/main/java/org/apache/arrow/vector/complex/StructVector.java
index 53f83fdfa7..dda9b6547f 100644
---
a/java/vector/src/main/java/org/apache/arrow/vector/complex/StructVector.java
+++
b/java/vector/src/main/java/org/apache/arrow/vector/complex/StructVector.java
@@ -188,9 +188,9 @@ public class StructVector extends NonNullableStructVector
/**
* Get the inner vectors.
*
+ * @return the inner vectors for this field as defined by the TypeLayout
* @deprecated This API will be removed as the current implementations no
longer support inner
* vectors.
- * @return the inner vectors for this field as defined by the TypeLayout
*/
@Deprecated
@Override