You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@orc.apache.org by do...@apache.org on 2021/08/09 08:14:44 UTC
[orc] branch main updated: ORC-924: Add
`RedundantModifier`/`ModifierOrder` Checkstyle rules (#837)
This is an automated email from the ASF dual-hosted git repository.
dongjoon pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/orc.git
The following commit(s) were added to refs/heads/main by this push:
new 7e7e974 ORC-924: Add `RedundantModifier`/`ModifierOrder` Checkstyle rules (#837)
7e7e974 is described below
commit 7e7e974883e0d789972f09043680399058f58599
Author: William Hyun <wi...@apache.org>
AuthorDate: Mon Aug 9 01:14:40 2021 -0700
ORC-924: Add `RedundantModifier`/`ModifierOrder` Checkstyle rules (#837)
### What changes were proposed in this pull request?
This PR aims to add redundant modifier and modifier order checkstyle rules.
### Why are the changes needed?
This will improve code quality removing inconsistent patterns.
### How was this patch tested?
Pass the CIs.
---
.../org/apache/hadoop/fs/TrackingLocalFileSystem.java | 2 +-
.../org/apache/orc/bench/core/RandomGenerator.java | 4 ++--
.../java/org/apache/orc/bench/core/SalesGenerator.java | 2 +-
.../apache/orc/bench/core/convert/json/JsonReader.java | 4 ++--
.../core/src/java/org/apache/orc/InMemoryKeystore.java | 2 +-
.../org/apache/orc/impl/DirectDecompressionCodec.java | 4 ++--
java/core/src/java/org/apache/orc/impl/InStream.java | 4 ++--
.../src/java/org/apache/orc/impl/RecordReaderImpl.java | 6 +++---
.../java/org/apache/orc/impl/RecordReaderUtils.java | 2 +-
.../src/java/org/apache/orc/impl/RedBlackTree.java | 2 +-
.../org/apache/orc/impl/RunLengthIntegerReaderV2.java | 2 +-
.../java/org/apache/orc/impl/SerializationUtils.java | 2 +-
.../src/java/org/apache/orc/mapred/OrcInputFormat.java | 2 +-
java/pom.xml | 2 ++
.../src/java/org/apache/orc/impl/ZeroCopyShims.java | 18 +++++++++---------
.../java/org/apache/orc/tools/convert/JsonReader.java | 6 +++---
.../src/java/org/apache/orc/tools/json/ListType.java | 4 ++--
.../src/java/org/apache/orc/tools/json/StructType.java | 2 +-
18 files changed, 36 insertions(+), 34 deletions(-)
diff --git a/java/bench/core/src/java/org/apache/hadoop/fs/TrackingLocalFileSystem.java b/java/bench/core/src/java/org/apache/hadoop/fs/TrackingLocalFileSystem.java
index bd3b027..fbaec05 100644
--- a/java/bench/core/src/java/org/apache/hadoop/fs/TrackingLocalFileSystem.java
+++ b/java/bench/core/src/java/org/apache/hadoop/fs/TrackingLocalFileSystem.java
@@ -26,7 +26,7 @@ public class TrackingLocalFileSystem extends RawLocalFileSystem {
class TrackingFileInputStream extends RawLocalFileSystem.LocalFSFileInputStream {
- public TrackingFileInputStream(Path f) throws IOException {
+ TrackingFileInputStream(Path f) throws IOException {
super(f);
}
diff --git a/java/bench/core/src/java/org/apache/orc/bench/core/RandomGenerator.java b/java/bench/core/src/java/org/apache/orc/bench/core/RandomGenerator.java
index 9220775..7979ac0 100644
--- a/java/bench/core/src/java/org/apache/orc/bench/core/RandomGenerator.java
+++ b/java/bench/core/src/java/org/apache/orc/bench/core/RandomGenerator.java
@@ -66,7 +66,7 @@ public class RandomGenerator {
private final int sizeRange;
private final Field child;
- public RandomList(int minSize, int maxSize, Field child) {
+ RandomList(int minSize, int maxSize, Field child) {
this.minSize = minSize;
this.sizeRange = maxSize - minSize + 1;
this.child = child;
@@ -92,7 +92,7 @@ public class RandomGenerator {
private class RandomStruct extends ValueGenerator {
private final Field[] children;
- public RandomStruct(Field[] children) {
+ RandomStruct(Field[] children) {
this.children = children;
}
diff --git a/java/bench/core/src/java/org/apache/orc/bench/core/SalesGenerator.java b/java/bench/core/src/java/org/apache/orc/bench/core/SalesGenerator.java
index 9ac1264..c2c12a4 100644
--- a/java/bench/core/src/java/org/apache/orc/bench/core/SalesGenerator.java
+++ b/java/bench/core/src/java/org/apache/orc/bench/core/SalesGenerator.java
@@ -25,7 +25,7 @@ import org.apache.orc.bench.core.convert.BatchReader;
public class SalesGenerator implements BatchReader {
private final RandomGenerator generator;
private long rowsRemaining;
- private final static double MOSTLY = 0.99999;
+ private static final double MOSTLY = 0.99999;
public SalesGenerator(long rows) {
this(rows, 42);
diff --git a/java/bench/core/src/java/org/apache/orc/bench/core/convert/json/JsonReader.java b/java/bench/core/src/java/org/apache/orc/bench/core/convert/json/JsonReader.java
index e12a36a..893b738 100644
--- a/java/bench/core/src/java/org/apache/orc/bench/core/convert/json/JsonReader.java
+++ b/java/bench/core/src/java/org/apache/orc/bench/core/convert/json/JsonReader.java
@@ -194,7 +194,7 @@ public class JsonReader implements BatchReader {
private JsonConverter[] childrenConverters;
private List<String> fieldNames;
- public StructColumnConverter(TypeDescription schema) {
+ StructColumnConverter(TypeDescription schema) {
List<TypeDescription> kids = schema.getChildren();
childrenConverters = new JsonConverter[kids.size()];
for(int c=0; c < childrenConverters.length; ++c) {
@@ -221,7 +221,7 @@ public class JsonReader implements BatchReader {
static class ListColumnConverter implements JsonConverter {
private JsonConverter childrenConverter;
- public ListColumnConverter(TypeDescription schema) {
+ ListColumnConverter(TypeDescription schema) {
childrenConverter = createConverter(schema.getChildren().get(0));
}
diff --git a/java/core/src/java/org/apache/orc/InMemoryKeystore.java b/java/core/src/java/org/apache/orc/InMemoryKeystore.java
index d618fef..8ef4c2a 100644
--- a/java/core/src/java/org/apache/orc/InMemoryKeystore.java
+++ b/java/core/src/java/org/apache/orc/InMemoryKeystore.java
@@ -314,7 +314,7 @@ public class InMemoryKeystore implements KeyProvider {
private final byte[] material;
- public KeyVersion(final String keyName, final int version,
+ KeyVersion(final String keyName, final int version,
final EncryptionAlgorithm algorithm, final byte[] material) {
super(keyName, version, algorithm);
this.material = material;
diff --git a/java/core/src/java/org/apache/orc/impl/DirectDecompressionCodec.java b/java/core/src/java/org/apache/orc/impl/DirectDecompressionCodec.java
index 7e0110d..fc441f2 100644
--- a/java/core/src/java/org/apache/orc/impl/DirectDecompressionCodec.java
+++ b/java/core/src/java/org/apache/orc/impl/DirectDecompressionCodec.java
@@ -23,6 +23,6 @@ import java.io.IOException;
import java.nio.ByteBuffer;
public interface DirectDecompressionCodec extends CompressionCodec {
- public boolean isAvailable();
- public void directDecompress(ByteBuffer in, ByteBuffer out) throws IOException;
+ boolean isAvailable();
+ void directDecompress(ByteBuffer in, ByteBuffer out) throws IOException;
}
diff --git a/java/core/src/java/org/apache/orc/impl/InStream.java b/java/core/src/java/org/apache/orc/impl/InStream.java
index f84cc17..fc45543 100644
--- a/java/core/src/java/org/apache/orc/impl/InStream.java
+++ b/java/core/src/java/org/apache/orc/impl/InStream.java
@@ -68,7 +68,7 @@ public abstract class InStream extends InputStream {
* @param newRange the block that is current
* @param isJump if this was a seek instead of a natural read
*/
- abstract protected void setCurrent(DiskRangeList newRange,
+ protected abstract void setCurrent(DiskRangeList newRange,
boolean isJump);
/**
* Reset the input to a new set of data.
@@ -696,7 +696,7 @@ public abstract class InStream extends InputStream {
private static class EncryptedCompressedStream extends CompressedStream {
private final EncryptionState encrypt;
- public EncryptedCompressedStream(Object name,
+ EncryptedCompressedStream(Object name,
DiskRangeList input,
long offset,
long length,
diff --git a/java/core/src/java/org/apache/orc/impl/RecordReaderImpl.java b/java/core/src/java/org/apache/orc/impl/RecordReaderImpl.java
index aa457ef..5578587 100644
--- a/java/core/src/java/org/apache/orc/impl/RecordReaderImpl.java
+++ b/java/core/src/java/org/apache/orc/impl/RecordReaderImpl.java
@@ -852,7 +852,7 @@ public class RecordReaderImpl implements RecordReader {
*/
static class SargCastException extends IllegalArgumentException {
- public SargCastException(String string) {
+ SargCastException(String string) {
super(string);
}
}
@@ -971,8 +971,8 @@ public class RecordReaderImpl implements RecordReader {
}
public static class SargApplier {
- public final static boolean[] READ_ALL_RGS = null;
- public final static boolean[] READ_NO_RGS = new boolean[0];
+ public static final boolean[] READ_ALL_RGS = null;
+ public static final boolean[] READ_NO_RGS = new boolean[0];
private final OrcFile.WriterVersion writerVersion;
private final SearchArgument sarg;
diff --git a/java/core/src/java/org/apache/orc/impl/RecordReaderUtils.java b/java/core/src/java/org/apache/orc/impl/RecordReaderUtils.java
index 4431551..a4e3e9e 100644
--- a/java/core/src/java/org/apache/orc/impl/RecordReaderUtils.java
+++ b/java/core/src/java/org/apache/orc/impl/RecordReaderUtils.java
@@ -500,7 +500,7 @@ public class RecordReaderUtils {
// this is an implementation copied from ElasticByteBufferPool in hadoop-2,
// which lacks a clear()/clean() operation
- public final static class ByteBufferAllocatorPool implements HadoopShims.ByteBufferPoolShim {
+ public static final class ByteBufferAllocatorPool implements HadoopShims.ByteBufferPoolShim {
private static final class Key implements Comparable<Key> {
private final int capacity;
private final long insertionGeneration;
diff --git a/java/core/src/java/org/apache/orc/impl/RedBlackTree.java b/java/core/src/java/org/apache/orc/impl/RedBlackTree.java
index db405f3..06fd349 100644
--- a/java/core/src/java/org/apache/orc/impl/RedBlackTree.java
+++ b/java/core/src/java/org/apache/orc/impl/RedBlackTree.java
@@ -40,7 +40,7 @@ abstract class RedBlackTree {
/**
* Create a set with the given initial capacity.
*/
- public RedBlackTree(int initialCapacity) {
+ RedBlackTree(int initialCapacity) {
data = new DynamicIntArray(initialCapacity * ELEMENT_SIZE);
}
diff --git a/java/core/src/java/org/apache/orc/impl/RunLengthIntegerReaderV2.java b/java/core/src/java/org/apache/orc/impl/RunLengthIntegerReaderV2.java
index d76a0aa..dafd370 100644
--- a/java/core/src/java/org/apache/orc/impl/RunLengthIntegerReaderV2.java
+++ b/java/core/src/java/org/apache/orc/impl/RunLengthIntegerReaderV2.java
@@ -50,7 +50,7 @@ public class RunLengthIntegerReaderV2 implements IntegerReader {
this.utils = new SerializationUtils();
}
- private final static RunLengthIntegerWriterV2.EncodingType[] encodings =
+ private static final RunLengthIntegerWriterV2.EncodingType[] encodings =
RunLengthIntegerWriterV2.EncodingType.values();
private void readValues(boolean ignoreEof) throws IOException {
// read the first 2 bits and determine the encoding type
diff --git a/java/core/src/java/org/apache/orc/impl/SerializationUtils.java b/java/core/src/java/org/apache/orc/impl/SerializationUtils.java
index 3afa3eb..50740ae 100644
--- a/java/core/src/java/org/apache/orc/impl/SerializationUtils.java
+++ b/java/core/src/java/org/apache/orc/impl/SerializationUtils.java
@@ -39,7 +39,7 @@ import java.util.TimeZone;
public final class SerializationUtils {
private static final Logger LOG = LoggerFactory.getLogger(SerializationUtils.class);
- private final static int BUFFER_SIZE = 64;
+ private static final int BUFFER_SIZE = 64;
private final byte[] readBuffer;
private final byte[] writeBuffer;
diff --git a/java/mapreduce/src/java/org/apache/orc/mapred/OrcInputFormat.java b/java/mapreduce/src/java/org/apache/orc/mapred/OrcInputFormat.java
index ff3109c..f7bc28f 100644
--- a/java/mapreduce/src/java/org/apache/orc/mapred/OrcInputFormat.java
+++ b/java/mapreduce/src/java/org/apache/orc/mapred/OrcInputFormat.java
@@ -51,7 +51,7 @@ import org.apache.orc.TypeDescription;
public class OrcInputFormat<V extends WritableComparable>
extends FileInputFormat<NullWritable, V> {
- private final static int KRYO_SARG_MAX_BUFFER = 16777216;
+ private static final int KRYO_SARG_MAX_BUFFER = 16777216;
/**
* Convert a string with a comma separated list of column ids into the
diff --git a/java/pom.xml b/java/pom.xml
index 74d5c7f..ab227a4 100644
--- a/java/pom.xml
+++ b/java/pom.xml
@@ -296,6 +296,8 @@
<module name="TreeWalker">
<module name="OuterTypeFilename"/>
<module name="UnusedImports"/>
+ <module name="ModifierOrder"/>
+ <module name="RedundantModifier"/>
<module name="NoLineWrap"/>
<module name="OneStatementPerLine"/>
<module name="NeedBraces">
diff --git a/java/shims/src/java/org/apache/orc/impl/ZeroCopyShims.java b/java/shims/src/java/org/apache/orc/impl/ZeroCopyShims.java
index 1115eb1..cc777f1 100644
--- a/java/shims/src/java/org/apache/orc/impl/ZeroCopyShims.java
+++ b/java/shims/src/java/org/apache/orc/impl/ZeroCopyShims.java
@@ -29,17 +29,17 @@ class ZeroCopyShims {
private static final class ByteBufferPoolAdapter implements ByteBufferPool {
private HadoopShims.ByteBufferPoolShim pool;
- public ByteBufferPoolAdapter(HadoopShims.ByteBufferPoolShim pool) {
+ ByteBufferPoolAdapter(HadoopShims.ByteBufferPoolShim pool) {
this.pool = pool;
}
@Override
- public final ByteBuffer getBuffer(boolean direct, int length) {
+ public ByteBuffer getBuffer(boolean direct, int length) {
return this.pool.getBuffer(direct, length);
}
@Override
- public final void putBuffer(ByteBuffer buffer) {
+ public void putBuffer(ByteBuffer buffer) {
this.pool.putBuffer(buffer);
}
}
@@ -47,12 +47,12 @@ class ZeroCopyShims {
private static final class ZeroCopyAdapter implements HadoopShims.ZeroCopyReaderShim {
private final FSDataInputStream in;
private final ByteBufferPoolAdapter pool;
- private final static EnumSet<ReadOption> CHECK_SUM = EnumSet
+ private static final EnumSet<ReadOption> CHECK_SUM = EnumSet
.noneOf(ReadOption.class);
- private final static EnumSet<ReadOption> NO_CHECK_SUM = EnumSet
+ private static final EnumSet<ReadOption> NO_CHECK_SUM = EnumSet
.of(ReadOption.SKIP_CHECKSUMS);
- public ZeroCopyAdapter(FSDataInputStream in,
+ ZeroCopyAdapter(FSDataInputStream in,
HadoopShims.ByteBufferPoolShim poolshim) {
this.in = in;
if (poolshim != null) {
@@ -63,7 +63,7 @@ class ZeroCopyShims {
}
@Override
- public final ByteBuffer readBuffer(int maxLength, boolean verifyChecksums)
+ public ByteBuffer readBuffer(int maxLength, boolean verifyChecksums)
throws IOException {
EnumSet<ReadOption> options = NO_CHECK_SUM;
if (verifyChecksums) {
@@ -73,12 +73,12 @@ class ZeroCopyShims {
}
@Override
- public final void releaseBuffer(ByteBuffer buffer) {
+ public void releaseBuffer(ByteBuffer buffer) {
this.in.releaseBuffer(buffer);
}
@Override
- public final void close() throws IOException {
+ public void close() throws IOException {
this.in.close();
}
}
diff --git a/java/tools/src/java/org/apache/orc/tools/convert/JsonReader.java b/java/tools/src/java/org/apache/orc/tools/convert/JsonReader.java
index 1611779..08d2afe 100644
--- a/java/tools/src/java/org/apache/orc/tools/convert/JsonReader.java
+++ b/java/tools/src/java/org/apache/orc/tools/convert/JsonReader.java
@@ -205,7 +205,7 @@ public class JsonReader implements RecordReader {
private JsonConverter[] childrenConverters;
private List<String> fieldNames;
- public StructColumnConverter(TypeDescription schema) {
+ StructColumnConverter(TypeDescription schema) {
List<TypeDescription> kids = schema.getChildren();
childrenConverters = new JsonConverter[kids.size()];
for(int c=0; c < childrenConverters.length; ++c) {
@@ -233,7 +233,7 @@ public class JsonReader implements RecordReader {
class ListColumnConverter implements JsonConverter {
private JsonConverter childrenConverter;
- public ListColumnConverter(TypeDescription schema) {
+ ListColumnConverter(TypeDescription schema) {
childrenConverter = createConverter(schema.getChildren().get(0));
}
@@ -261,7 +261,7 @@ public class JsonReader implements RecordReader {
private JsonConverter keyConverter;
private JsonConverter valueConverter;
- public MapColumnConverter(TypeDescription schema) {
+ MapColumnConverter(TypeDescription schema) {
TypeDescription keyType = schema.getChildren().get(0);
if (keyType.getCategory() != TypeDescription.Category.STRING) {
throw new IllegalArgumentException("JSON can only support MAP key in STRING type: " + schema);
diff --git a/java/tools/src/java/org/apache/orc/tools/json/ListType.java b/java/tools/src/java/org/apache/orc/tools/json/ListType.java
index 22ebddd..7a6936a 100644
--- a/java/tools/src/java/org/apache/orc/tools/json/ListType.java
+++ b/java/tools/src/java/org/apache/orc/tools/json/ListType.java
@@ -28,11 +28,11 @@ import java.io.PrintStream;
class ListType extends HiveType {
HiveType elementType;
- public ListType() {
+ ListType() {
super(Kind.LIST);
}
- public ListType(HiveType child) {
+ ListType(HiveType child) {
super(Kind.LIST);
this.elementType = child;
}
diff --git a/java/tools/src/java/org/apache/orc/tools/json/StructType.java b/java/tools/src/java/org/apache/orc/tools/json/StructType.java
index f2edd28..250ea1d 100644
--- a/java/tools/src/java/org/apache/orc/tools/json/StructType.java
+++ b/java/tools/src/java/org/apache/orc/tools/json/StructType.java
@@ -30,7 +30,7 @@ import java.util.TreeMap;
*/
class StructType extends HiveType {
private static final String COL_PREFIX = "_col";
- private final static Comparator<String> FIELD_COMPARATOR = (left, right) -> {
+ private static final Comparator<String> FIELD_COMPARATOR = (left, right) -> {
if (left == null) {
return right == null ? 0 : -1;
} else if (right == null) {