You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datasketches.apache.org by le...@apache.org on 2021/06/07 19:22:34 UTC
[datasketches-memory] 03/04: Interim, fixed java version check.
This is an automated email from the ASF dual-hosted git repository.
leerho pushed a commit to branch AddExceptions
in repository https://gitbox.apache.org/repos/asf/datasketches-memory.git
commit 7421e27ac2bf517fc5e6c238e8462dda6b985593
Author: Lee Rhodes <le...@users.noreply.github.com>
AuthorDate: Sun Jun 6 21:48:59 2021 -0700
Interim, fixed java version check.
Other missing exception specifications.
---
.../datasketches/memory/MemoryCloseException.java | 2 +-
.../memory/internal/AllocateDirectMap.java | 12 +-
.../memory/internal/AllocateDirectWritableMap.java | 7 +-
.../memory/internal/BaseStateImpl.java | 2 +-
.../memory/internal/BaseWritableBufferImpl.java | 4 +-
.../memory/internal/BaseWritableMemoryImpl.java | 2 +-
.../datasketches/memory/internal/BufferImpl.java | 1 +
.../datasketches/memory/internal/NioBits.java | 25 +--
.../datasketches/memory/internal/UnsafeUtil.java | 12 +-
.../memory/test/IsValidUtf8TestUtil.java | 14 +-
.../datasketches/memory/test/ReflectUtil.java | 22 +-
.../datasketches/memory/test/UnsafeUtilTest.java | 20 +-
.../apache/datasketches/memory/test/UtilTest.java | 2 +-
tools/MemoryCheckstyle.xml | 231 ++++++++++++++++-----
14 files changed, 235 insertions(+), 121 deletions(-)
diff --git a/src/main/java/org/apache/datasketches/memory/MemoryCloseException.java b/src/main/java/org/apache/datasketches/memory/MemoryCloseException.java
index fd9ba3f..b6260a5 100644
--- a/src/main/java/org/apache/datasketches/memory/MemoryCloseException.java
+++ b/src/main/java/org/apache/datasketches/memory/MemoryCloseException.java
@@ -32,7 +32,7 @@ public class MemoryCloseException extends MemoryException {
super("The associated resource failed to close.");
}
- public MemoryCloseException(String resource) {
+ public MemoryCloseException(final String resource) {
super("The associated resource, " + resource + ", failed to close");
}
diff --git a/src/main/java/org/apache/datasketches/memory/internal/AllocateDirectMap.java b/src/main/java/org/apache/datasketches/memory/internal/AllocateDirectMap.java
index 6111b60..e1076a4 100644
--- a/src/main/java/org/apache/datasketches/memory/internal/AllocateDirectMap.java
+++ b/src/main/java/org/apache/datasketches/memory/internal/AllocateDirectMap.java
@@ -91,7 +91,7 @@ class AllocateDirectMap implements Map {
MAPPED_BYTE_BUFFER_FORCE0_METHOD = MappedByteBuffer.class
.getDeclaredMethod("force0", FileDescriptor.class, long.class, long.class); //JDK15 removed
MAPPED_BYTE_BUFFER_FORCE0_METHOD.setAccessible(true);
- } catch (final Exception e) {
+ } catch (final SecurityException | NoSuchMethodException e) {
throw new RuntimeException("Could not reflect static methods: " + e);
}
}
@@ -148,7 +148,7 @@ class AllocateDirectMap implements Map {
nativeBaseOffset,
capacityBytes,
pageCount);
- } catch (final Exception e) {
+ } catch (final IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
throw new RuntimeException(
String.format("Encountered %s exception while loading", e.getClass()));
}
@@ -160,7 +160,7 @@ class AllocateDirectMap implements Map {
doClose("AllocateDirectMap");
}
- boolean doClose(String resource) {
+ boolean doClose(final String resource) {
try {
if (deallocator.deallocate(false)) {
// This Cleaner.clean() call effectively just removes the Cleaner from the internal linked
@@ -171,7 +171,7 @@ class AllocateDirectMap implements Map {
}
return false;
} catch (final Exception e) {
- throw new MemoryCloseException(resource);
+ throw new MemoryCloseException(resource);
} finally {
BaseStateImpl.reachabilityFence(this);
}
@@ -194,7 +194,7 @@ class AllocateDirectMap implements Map {
.invoke(AccessByteBuffer.ZERO_READ_ONLY_DIRECT_BYTE_BUFFER,
nativeBaseOffset,
capacityBytes);
- } catch (final Exception e) {
+ } catch (final IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
throw new RuntimeException(
String.format("Encountered %s exception while loading", e.getClass()));
}
@@ -309,7 +309,7 @@ class AllocateDirectMap implements Map {
try {
FILE_CHANNEL_IMPL_UNMAP0_METHOD.invoke(myFc, actualNativeBaseOffset, myCapacity);
myRaf.close();
- } catch (final Exception e) {
+ } catch (final IllegalAccessException | IllegalArgumentException | InvocationTargetException | IOException e) {
throw new RuntimeException(
String.format("Encountered %s exception while freeing memory", e.getClass()));
}
diff --git a/src/main/java/org/apache/datasketches/memory/internal/AllocateDirectWritableMap.java b/src/main/java/org/apache/datasketches/memory/internal/AllocateDirectWritableMap.java
index 8a64a27..ce6a413 100644
--- a/src/main/java/org/apache/datasketches/memory/internal/AllocateDirectWritableMap.java
+++ b/src/main/java/org/apache/datasketches/memory/internal/AllocateDirectWritableMap.java
@@ -20,6 +20,8 @@
package org.apache.datasketches.memory.internal;
import java.io.File;
+import java.io.IOException;
+import java.lang.reflect.InvocationTargetException;
import org.apache.datasketches.memory.WritableMap;
@@ -53,9 +55,8 @@ final class AllocateDirectWritableMap extends AllocateDirectMap implements Writa
raf.getFD(),
nativeBaseOffset,
capacityBytes);
- } catch (final Exception e) {
- throw new RuntimeException(String.format("Encountered %s exception in force. "
- + e.getClass()));
+ } catch (final IOException | IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
+ throw new RuntimeException(String.format("Encountered %s exception in force. " + e.getClass()));
}
}
}
diff --git a/src/main/java/org/apache/datasketches/memory/internal/BaseStateImpl.java b/src/main/java/org/apache/datasketches/memory/internal/BaseStateImpl.java
index d0c3524..c76e802 100644
--- a/src/main/java/org/apache/datasketches/memory/internal/BaseStateImpl.java
+++ b/src/main/java/org/apache/datasketches/memory/internal/BaseStateImpl.java
@@ -28,9 +28,9 @@ import java.nio.ByteBuffer;
import java.nio.ByteOrder;
import java.util.concurrent.atomic.AtomicLong;
+import org.apache.datasketches.memory.BaseState;
import org.apache.datasketches.memory.DefaultMemoryRequestServer;
import org.apache.datasketches.memory.MemoryRequestServer;
-import org.apache.datasketches.memory.BaseState;
/**
* Keeps key configuration state for MemoryImpl and BufferImpl plus some common static variables
diff --git a/src/main/java/org/apache/datasketches/memory/internal/BaseWritableBufferImpl.java b/src/main/java/org/apache/datasketches/memory/internal/BaseWritableBufferImpl.java
index bfc3233..cae33e7 100644
--- a/src/main/java/org/apache/datasketches/memory/internal/BaseWritableBufferImpl.java
+++ b/src/main/java/org/apache/datasketches/memory/internal/BaseWritableBufferImpl.java
@@ -30,10 +30,10 @@ import static org.apache.datasketches.memory.internal.UnsafeUtil.ARRAY_SHORT_IND
import static org.apache.datasketches.memory.internal.UnsafeUtil.checkBounds;
import static org.apache.datasketches.memory.internal.UnsafeUtil.unsafe;
-import org.apache.datasketches.memory.Buffer;
-
import java.nio.ByteOrder;
+import org.apache.datasketches.memory.Buffer;
+
/*
* Developer notes: The heavier methods, such as put/get arrays, duplicate, region, clear, fill,
* compareTo, etc., use hard checks (check*() and incrementAndCheck*() methods), which execute at
diff --git a/src/main/java/org/apache/datasketches/memory/internal/BaseWritableMemoryImpl.java b/src/main/java/org/apache/datasketches/memory/internal/BaseWritableMemoryImpl.java
index 71abe45..954cc30 100644
--- a/src/main/java/org/apache/datasketches/memory/internal/BaseWritableMemoryImpl.java
+++ b/src/main/java/org/apache/datasketches/memory/internal/BaseWritableMemoryImpl.java
@@ -39,9 +39,9 @@ import java.nio.channels.WritableByteChannel;
import org.apache.datasketches.memory.Memory;
import org.apache.datasketches.memory.MemoryRequestServer;
import org.apache.datasketches.memory.Utf8CodingException;
+import org.apache.datasketches.memory.WritableHandle;
import org.apache.datasketches.memory.WritableMapHandle;
import org.apache.datasketches.memory.WritableMemory;
-import org.apache.datasketches.memory.WritableHandle;
/*
* Developer notes: The heavier methods, such as put/get arrays, duplicate, region, clear, fill,
diff --git a/src/main/java/org/apache/datasketches/memory/internal/BufferImpl.java b/src/main/java/org/apache/datasketches/memory/internal/BufferImpl.java
index 482db82..e673261 100644
--- a/src/main/java/org/apache/datasketches/memory/internal/BufferImpl.java
+++ b/src/main/java/org/apache/datasketches/memory/internal/BufferImpl.java
@@ -21,6 +21,7 @@ package org.apache.datasketches.memory.internal;
import java.nio.ByteBuffer;
import java.nio.ByteOrder;
+
import org.apache.datasketches.memory.Buffer;
/**
diff --git a/src/main/java/org/apache/datasketches/memory/internal/NioBits.java b/src/main/java/org/apache/datasketches/memory/internal/NioBits.java
index a25985e..3b79c58 100644
--- a/src/main/java/org/apache/datasketches/memory/internal/NioBits.java
+++ b/src/main/java/org/apache/datasketches/memory/internal/NioBits.java
@@ -22,6 +22,7 @@ package org.apache.datasketches.memory.internal;
import static org.apache.datasketches.memory.internal.UnsafeUtil.unsafe;
import java.lang.reflect.Field;
+import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.concurrent.atomic.AtomicLong;
@@ -87,7 +88,8 @@ final class NioBits {
totalCapacityField.setAccessible(true);
nioBitsTotalCapacity = (AtomicLong) (totalCapacityField.get(null));
- } catch (final Exception e) {
+ } catch (final ClassNotFoundException | NoSuchMethodException | IllegalAccessException
+ | IllegalArgumentException | InvocationTargetException | SecurityException | NoSuchFieldException e) {
throw new RuntimeException("Could not acquire java.nio.Bits class: " + e.getClass());
}
}
@@ -95,30 +97,15 @@ final class NioBits {
private NioBits() { }
static long getDirectAllocationsCount() { //tested via reflection
- try {
- final long count = nioBitsCount.get();
- return count;
- } catch (final Exception e) {
- throw new RuntimeException("Cannot read Bits.count " + e);
- }
+ return nioBitsCount.get();
}
static long getReservedMemory() { //tested via reflection
- try {
- final long resMem = nioBitsReservedMemory.get();
- return resMem;
- } catch (final Exception e) {
- throw new RuntimeException("Cannot read Bits.reservedMemory " + e);
- }
+ return nioBitsReservedMemory.get();
}
static long getTotalCapacity() { //tested via reflection
- try {
- final long resMem = nioBitsTotalCapacity.get();
- return resMem;
- } catch (final Exception e) {
- throw new RuntimeException("Cannot read Bits.totalCapacity " + e);
- }
+ return nioBitsTotalCapacity.get();
}
static int pageSize() {
diff --git a/src/main/java/org/apache/datasketches/memory/internal/UnsafeUtil.java b/src/main/java/org/apache/datasketches/memory/internal/UnsafeUtil.java
index ecd2ed5..eac8c11 100644
--- a/src/main/java/org/apache/datasketches/memory/internal/UnsafeUtil.java
+++ b/src/main/java/org/apache/datasketches/memory/internal/UnsafeUtil.java
@@ -136,17 +136,17 @@ public final class UnsafeUtil {
parts = parts[0].split("\\."); //split out the number groups
p0 = Integer.parseInt(parts[0]); //the first number group
p1 = (parts.length > 1) ? Integer.parseInt(parts[1]) : 0; //2nd number group, or 0
- } catch (final Exception e) {
- throw new ExceptionInInitializerError("Improper Java -version string: " + jdkVer + "\n" + e);
+ } catch (final NumberFormatException e) {
+ throw new RuntimeException("Improper Java -version string: " + jdkVer + "\n" + e);
}
//checkJavaVersion(jdkVer, p0, p1);
return new int[] {p0, p1};
}
public static void checkJavaVersion(final String jdkVer, final int p0, final int p1) {
- if ( (p0 < 1) || ((p0 == 1) && (p1 < 8)) || (p0 >= 9) ) {
- throw new ExceptionInInitializerError(
- "Unsupported JDK Major Version, must be 1.8: " + jdkVer);
+ if ( (p0 < 1) || ((p0 == 1) && (p1 < 8)) || (p0 > 13) ) {
+ throw new IllegalArgumentException(
+ "Unsupported JDK Major Version, must be one of 1.8, 8, 9, 10, 11, 12, 13: " + jdkVer);
}
}
@@ -161,6 +161,8 @@ public final class UnsafeUtil {
/**
* Like {@link Unsafe#arrayBaseOffset(Class)}, but caches return values for common array types.
* Useful because calling {@link Unsafe#arrayBaseOffset(Class)} directly incurs more overhead.
+ * @param c The given Class<?>.
+ * @return the base-offset
*/
public static long getArrayBaseOffset(final Class<?> c) {
// Ordering here is roughly in order of what we expect to be most popular.
diff --git a/src/test/java/org/apache/datasketches/memory/test/IsValidUtf8TestUtil.java b/src/test/java/org/apache/datasketches/memory/test/IsValidUtf8TestUtil.java
index 0e08200..123413a 100644
--- a/src/test/java/org/apache/datasketches/memory/test/IsValidUtf8TestUtil.java
+++ b/src/test/java/org/apache/datasketches/memory/test/IsValidUtf8TestUtil.java
@@ -23,7 +23,7 @@ package org.apache.datasketches.memory.test;
* Stripped down version of
* https://github.com/protocolbuffers/protobuf/blob/master/java/core/src/test/java/com/google/protobuf/IsValidUtf8TestUtil.java
*
- * Copyright 2008 Google Inc. All rights reserved.
+ * <p>Copyright 2008 Google Inc. All rights reserved.
* https://developers.google.com/protocol-buffers/
* See LICENSE.
*/
@@ -41,9 +41,9 @@ public class IsValidUtf8TestUtil {
// 18,304
static final long EXPECTED_TWO_BYTE_ROUNDTRIPPABLE_COUNT =
// Both bytes are one byte characters
- (long) Math.pow(EXPECTED_ONE_BYTE_ROUNDTRIPPABLE_COUNT, 2) +
+ (long) Math.pow(EXPECTED_ONE_BYTE_ROUNDTRIPPABLE_COUNT, 2)
// The possible number of two byte characters
- TWO_BYTE_ROUNDTRIPPABLE_CHARACTERS;
+ + TWO_BYTE_ROUNDTRIPPABLE_CHARACTERS;
// 2048
static final long THREE_BYTE_SURROGATES = 2 * 1024;
@@ -55,10 +55,10 @@ public class IsValidUtf8TestUtil {
// 2,650,112
static final long EXPECTED_THREE_BYTE_ROUNDTRIPPABLE_COUNT =
// All one byte characters
- (long) Math.pow(EXPECTED_ONE_BYTE_ROUNDTRIPPABLE_COUNT, 3) +
- (// One two byte character and a one byte character
- 2 * TWO_BYTE_ROUNDTRIPPABLE_CHARACTERS * ONE_BYTE_ROUNDTRIPPABLE_CHARACTERS) +
+ (long) Math.pow(EXPECTED_ONE_BYTE_ROUNDTRIPPABLE_COUNT, 3)
+ // One two byte character and a one byte character
+ + (2 * TWO_BYTE_ROUNDTRIPPABLE_CHARACTERS * ONE_BYTE_ROUNDTRIPPABLE_CHARACTERS)
// Three byte characters
- THREE_BYTE_ROUNDTRIPPABLE_CHARACTERS;
+ + THREE_BYTE_ROUNDTRIPPABLE_CHARACTERS;
}
diff --git a/src/test/java/org/apache/datasketches/memory/test/ReflectUtil.java b/src/test/java/org/apache/datasketches/memory/test/ReflectUtil.java
index 357d175..814ac62 100644
--- a/src/test/java/org/apache/datasketches/memory/test/ReflectUtil.java
+++ b/src/test/java/org/apache/datasketches/memory/test/ReflectUtil.java
@@ -20,7 +20,10 @@
package org.apache.datasketches.memory.test;
import java.io.File;
-import java.lang.reflect.*;
+import java.lang.reflect.Constructor;
+import java.lang.reflect.Field;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
import java.nio.ByteOrder;
import org.apache.datasketches.memory.MemoryRequestServer;
@@ -125,9 +128,9 @@ public final class ReflectUtil {
* a concrete class, but allows access to constructors, static fields and static methods.
* @return the Class object of the given class.
*/
- public static Class<?> getClass(String fullyQualifiedBinaryName) {
+ public static Class<?> getClass(final String fullyQualifiedBinaryName) {
try {
- ClassLoader scl = ClassLoader.getSystemClassLoader();
+ final ClassLoader scl = ClassLoader.getSystemClassLoader();
return scl.loadClass(fullyQualifiedBinaryName);
} catch (final ClassNotFoundException e) {
throw new RuntimeException(e);
@@ -142,7 +145,7 @@ public final class ReflectUtil {
*/
public static Constructor<?> getConstructor(final Class<?> ownerClass, final Class<?>... parameterTypes ) {
try {
- Constructor<?> ctor = ownerClass.getDeclaredConstructor(parameterTypes);
+ final Constructor<?> ctor = ownerClass.getDeclaredConstructor(parameterTypes);
ctor.setAccessible(true);
return ctor;
} catch (final NoSuchMethodException | SecurityException e) {
@@ -174,7 +177,7 @@ public final class ReflectUtil {
*/
public static Field getField(final Class<?> ownerClass, final String fieldName) {
try {
- Field field = ownerClass.getDeclaredField(fieldName);
+ final Field field = ownerClass.getDeclaredField(fieldName);
field.setAccessible(true);
return field;
} catch (final NoSuchFieldException | SecurityException e) {
@@ -205,9 +208,10 @@ public final class ReflectUtil {
* @param parameterTypes the list of parameter types
* @return the desired method.
*/
- public static Method getMethod(final Class<?> ownerClass, final String methodName, final Class<?>... parameterTypes ) {
+ public static Method getMethod(
+ final Class<?> ownerClass, final String methodName, final Class<?>... parameterTypes ) {
try {
- Method method = (parameterTypes == null)
+ final Method method = (parameterTypes == null)
? ownerClass.getDeclaredMethod(methodName)
: ownerClass.getDeclaredMethod(methodName, parameterTypes);
method.setAccessible(true);
@@ -217,7 +221,7 @@ public final class ReflectUtil {
}
}
- static void checkValid(Object target) {
+ static void checkValid(final Object target) {
try {
CHECK_VALID.invoke(target);
} catch (final IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
@@ -265,7 +269,7 @@ public final class ReflectUtil {
}
}
- static Object getUnsafeObject(Object target) {
+ static Object getUnsafeObject(final Object target) {
try {
return GET_UNSAFE_OBJECT.invoke(target);
} catch (final IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
diff --git a/src/test/java/org/apache/datasketches/memory/test/UnsafeUtilTest.java b/src/test/java/org/apache/datasketches/memory/test/UnsafeUtilTest.java
index b27b995..aa99412 100644
--- a/src/test/java/org/apache/datasketches/memory/test/UnsafeUtilTest.java
+++ b/src/test/java/org/apache/datasketches/memory/test/UnsafeUtilTest.java
@@ -43,10 +43,10 @@ public class UnsafeUtilTest {
public void checkJdkString() {
String jdkVer;
int[] p = new int[2];
- String[] good1_8Strings = {"1.8.0_121", "1.8.0_162"};
- int len = good1_8Strings.length;
+ String[] good1_Strings = {"1.8.0_121", "8", "9", "10", "11", "12", "13"};
+ int len = good1_Strings.length;
for (int i = 0; i < len; i++) {
- jdkVer = good1_8Strings[i];
+ jdkVer = good1_Strings[i];
p = UnsafeUtil.parseJavaVersion(jdkVer);
UnsafeUtil.checkJavaVersion(jdkVer, p[0], p[1]);
int jdkMajor = (p[0] == 1) ? p[1] : p[0]; //model the actual JDK_MAJOR
@@ -54,10 +54,11 @@ public class UnsafeUtilTest {
if (p[0] > 1 ) { assertTrue(jdkMajor == p[0]); }
}
try {
- jdkVer = "9.0.4"; //ver 9 string
+ jdkVer = "14.0.4"; //ver 14 string
p = UnsafeUtil.parseJavaVersion(jdkVer);
UnsafeUtil.checkJavaVersion(jdkVer, p[0], p[1]);
- } catch (Error e) {
+ fail();
+ } catch (Exception e) {
println("" + e);
}
@@ -65,7 +66,8 @@ public class UnsafeUtilTest {
jdkVer = "1.7.0_80"; //1.7 string
p = UnsafeUtil.parseJavaVersion(jdkVer);
UnsafeUtil.checkJavaVersion(jdkVer, p[0], p[1]);
- } catch (Error e) {
+ fail();
+ } catch (Exception e) {
println("" + e);
}
try {
@@ -73,7 +75,7 @@ public class UnsafeUtilTest {
p = UnsafeUtil.parseJavaVersion(jdkVer);
UnsafeUtil.checkJavaVersion(jdkVer, p[0], p[1]); //throws
fail();
- } catch (Error e) {
+ } catch (Exception e) {
println("" + e);
}
try {
@@ -81,7 +83,7 @@ public class UnsafeUtilTest {
p = UnsafeUtil.parseJavaVersion(jdkVer);
UnsafeUtil.checkJavaVersion(jdkVer, p[0], p[1]); //throws
fail();
- } catch (Exception | Error e) {
+ } catch (Exception e) {
println("" + e);
}
try {
@@ -89,7 +91,7 @@ public class UnsafeUtilTest {
p = UnsafeUtil.parseJavaVersion(jdkVer);
UnsafeUtil.checkJavaVersion(jdkVer, p[0], p[1]); //throws
fail();
- } catch (Exception | Error e) {
+ } catch (Exception e) {
println("" + e);
}
}
diff --git a/src/test/java/org/apache/datasketches/memory/test/UtilTest.java b/src/test/java/org/apache/datasketches/memory/test/UtilTest.java
index 144618f..199c908 100644
--- a/src/test/java/org/apache/datasketches/memory/test/UtilTest.java
+++ b/src/test/java/org/apache/datasketches/memory/test/UtilTest.java
@@ -143,7 +143,7 @@ public class UtilTest {
attrs.group().getName(),
PosixFilePermissions.toString(attrs.permissions()));
return s;
- } catch (Exception e) {
+ } catch (IOException e) {
throw new RuntimeException(e);
}
}
diff --git a/tools/MemoryCheckstyle.xml b/tools/MemoryCheckstyle.xml
index 351293a..7dbd33f 100644
--- a/tools/MemoryCheckstyle.xml
+++ b/tools/MemoryCheckstyle.xml
@@ -1,5 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE module PUBLIC "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" "https://checkstyle.org/dtds/configuration_1_3.dtd">
+<!DOCTYPE module PUBLIC
+ "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+ "https://checkstyle.org/dtds/configuration_1_3.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -21,126 +23,216 @@ under the License.
-->
<!--
- This configuration file was written by the eclipse-cs plugin configuration editor
--->
-<!--
- Checkstyle-Configuration: MemoryCheckstyle
- Description: none
+ MemoryCheckstyle.xml
+
+ Checkstyle is very configurable. Be sure to read the documentation at
+ http://checkstyle.sourceforge.net (or in your downloaded distribution).
+
+ To completely disable a check, just comment it out or delete it from the file.
+
+ Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
-->
+
<module name="Checker">
- <property name="severity" value="warning"/>
<property name="charset" value="UTF-8"/>
+ <property name="severity" value="warning"/>
<property name="fileExtensions" value="java"/>
+
+ <module name="BeforeExecutionExclusionFileFilter">
+ <property name="fileNamePattern" value=".*Test\.java$"/>
+ </module>
+
+ <module name="FileTabCharacter">
+ <property name="eachLine" value="true"/>
+ </module>
+
+ <module name="JavadocPackage"/>
+
+ <module name="NewlineAtEndOfFile">
+ <property name="lineSeparator" value="lf"/>
+ </module>
+
+ <!-- Size Violations -->
+ <module name="LineLength">
+ <property name="severity" value="warning"/>
+ <property name="max" value="120"/>
+ <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
+ <!-- <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/> -->
+ </module>
+
+ <module name="SuppressWithPlainTextCommentFilter">
+ <property name="offCommentFormat" value="//CHECKSTYLE.OFF\: ([\w\|]+)"/>
+ <property name="onCommentFormat" value="//CHECKSTYLE.ON\: ([\w\|]+)"/>
+ <property name="checkFormat" value="$1"/>
+ </module>
+
+ <!-- ******************************************************** -->
+
<module name="TreeWalker">
+
+ <!-- Annotations -->
<module name="AnnotationLocation">
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
</module>
+
<module name="AnnotationLocation">
- <property name="allowSamelineMultipleAnnotations" value="true"/>
<property name="tokens" value="VARIABLE_DEF"/>
+ <property name="allowSamelineMultipleAnnotations" value="true"/>
</module>
+
+ <!-- Block Checks -->
<module name="EmptyBlock">
<property name="severity" value="warning"/>
<property name="option" value="TEXT"/>
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
<module name="EmptyCatchBlock">
<property name="severity" value="ignore"/>
<property name="exceptionVariableName" value="expected"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
<module name="LeftCurly">
+ <!-- doesn't allow for if (n == 0) { return 0.0; }, which is readable and not corruptable -->
<property name="severity" value="ignore"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
- <module name="NeedBraces"/>
- <module name="RightCurly">
+
+ <module name="NeedBraces">
+ <property name="allowSingleLineStatement" value="false"/> <!-- default = false -->
+ <property name="allowEmptyLoopBody" value="false"/> <!-- default = false -->
+ </module>
+
+ <module name="RightCurly">
+ <!-- requires right curly start a new line; alone: on a line alone -->
<property name="severity" value="ignore"/>
<property name="option" value="alone"/>
<property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
+ <!-- Coding -->
<module name="FallThrough">
<property name="severity" value="warning"/>
<property name="reliefPattern" value="fallthru|falls? ?through|FALL[- ]?THROUGH"/>
+ <!-- <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/> -->
</module>
+
<module name="FinalLocalVariable">
<property name="severity" value="warning"/>
<property name="tokens" value="VARIABLE_DEF,PARAMETER_DEF"/>
</module>
+
<module name="IllegalTokenText">
<property name="severity" value="warning"/>
+ <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
<property name="format" value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
<property name="message" value="Avoid using corresponding octal or Unicode escape."/>
- <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
<module name="MissingSwitchDefault">
+ <!-- Too many false positives -->
<property name="severity" value="ignore"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
<module name="MultipleVariableDeclarations">
<property name="severity" value="ignore"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
<module name="NoFinalizer">
<property name="severity" value="ignore"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
<module name="OneStatementPerLine">
<property name="severity" value="ignore"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
<module name="OverloadMethodsDeclarationOrder">
<property name="severity" value="ignore"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
<module name="VariableDeclarationUsageDistance">
<property name="severity" value="ignore"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
+ <!-- Class Design -->
<module name="OneTopLevelClass"/>
+
<module name="FinalClass"/>
+
+ <!-- Imports -->
<module name="AvoidStarImport"/>
+
<module name="CustomImportOrder">
- <property name="customImportOrderRules" value="STATIC###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE"/>
<property name="specialImportsRegExp" value="org"/>
<property name="sortImportsInGroupAlphabetically" value="true"/>
+ <property name="separateLineBetweenGroups" value="true"/>
+ <!-- Google: "STATIC###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE" -->
+ <property name="customImportOrderRules" value="STATIC###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE"/>
</module>
+
<module name="RedundantImport"/>
+
<module name="UnusedImports"/>
+
+ <!-- Filters -->
+ <!-- Enable suppression using comments: //CHECKSTYLE.OFF: "RULE" and //CHECKSTYLE.ON: "RULE"
+ You must specify the specific rule, as in: //CHECKSTYLE.OFF: LineLength -->
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="//CHECKSTYLE.OFF\: ([\w\|]+)"/>
<property name="onCommentFormat" value="//CHECKSTYLE.ON\: ([\w\|]+)"/>
<property name="checkFormat" value="$1"/>
</module>
+
+ <!-- Javadoc Comments -->
+ <!-- JavadocPackage under Checker -->
<module name="AtclauseOrder">
- <property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
+ <property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
</module>
+
<module name="JavadocMethod">
- <property name="allowedAnnotations" value="Override, Test"/>
<property name="scope" value="public"/>
+ <property name="allowMissingParamTags" value="false"/> <!-- default -->
+ <property name="allowMissingReturnTag" value="false"/> <!-- default -->
+ <property name="allowedAnnotations" value="Override, Test"/>
</module>
+
<module name="JavadocParagraph"/>
- <!--
+
<module name="JavadocTagContinuationIndentation">
<property name="severity" value="ignore"/>
+ <property name="offset" value="0"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
- </module> -->
+ </module>
+
<module name="NonEmptyAtclauseDescription"/>
+
<module name="SingleLineJavadoc">
<property name="ignoreInlineTags" value="false"/>
</module>
+
<module name="SummaryJavadocCheck">
<property name="severity" value="ignore"/>
+ <!-- <property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/> -->
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
+ <!-- Miscellaneous -->
<module name="ArrayTypeStyle">
<property name="severity" value="ignore"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
<module name="AvoidEscapedUnicodeCharacters">
<property name="severity" value="warning"/>
<property name="allowEscapesForControlCharacters" value="true"/>
@@ -148,109 +240,154 @@ under the License.
<property name="allowNonPrintableEscapes" value="true"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
<module name="CommentsIndentation">
<property name="severity" value="warning"/>
+ <!-- <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/> -->
</module>
+
<module name="Indentation">
<property name="severity" value="ignore"/>
<property name="basicOffset" value="2"/>
+ <property name="braceAdjustment" value="0"/> <!-- default -->
<property name="caseIndent" value="2"/>
+ <property name="throwsIndent" value="4"/>
+ <property name="lineWrappingIndentation" value="4"/>
<property name="arrayInitIndent" value="2"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
<module name="OuterTypeFilename">
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
<module name="TodoComment">
<property name="severity" value="ignore"/>
<property name="format" value="(//TODO)|(//FIXME)"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
<module name="UpperEll">
<property name="severity" value="warning"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
+ <!-- Modifiers -->
<module name="ModifierOrder">
<property name="severity" value="ignore"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
+ <!-- Naming Conventions -->
<module name="AbbreviationAsWordInName">
<property name="severity" value="ignore"/>
- <property name="allowedAbbreviationLength" value="1"/>
<property name="ignoreFinal" value="false"/>
+ <property name="allowedAbbreviationLength" value="1"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
<module name="ClassTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
- <message key="name.invalidPattern" value="Class type name ''{0}'' must match pattern ''{1}''."/>
+ <message key="name.invalidPattern"
+ value="Class type name ''{0}'' must match pattern ''{1}''."/>
</module>
+
<module name="LocalVariableName">
<property name="severity" value="ignore"/>
+ <property name="tokens" value="VARIABLE_DEF"/>
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
<property name="allowOneCharVarInForLoop" value="true"/>
- <message key="name.invalidPattern" value="Local variable name ''{0}'' must match pattern ''{1}''."/>
+ <message key="name.invalidPattern"
+ value="Local variable name ''{0}'' must match pattern ''{1}''."/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
<module name="MemberName">
<property name="severity" value="ignore"/>
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
- <message key="name.invalidPattern" value="Member name ''{0}'' must match pattern ''{1}''."/>
+ <message key="name.invalidPattern"
+ value="Member name ''{0}'' must match pattern ''{1}''."/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
<module name="MethodName">
<property name="severity" value="ignore"/>
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
- <message key="name.invalidPattern" value="Method name ''{0}'' must match pattern ''{1}''."/>
+ <message key="name.invalidPattern"
+ value="Method name ''{0}'' must match pattern ''{1}''."/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
<module name="MethodTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
- <message key="name.invalidPattern" value="Method type name ''{0}'' must match pattern ''{1}''."/>
+ <message key="name.invalidPattern"
+ value="Method type name ''{0}'' must match pattern ''{1}''."/>
</module>
+
<module name="PackageName">
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
- <message key="name.invalidPattern" value="Package name ''{0}'' must match pattern ''{1}''."/>
+ <message key="name.invalidPattern"
+ value="Package name ''{0}'' must match pattern ''{1}''."/>
</module>
+
<module name="ParameterName">
<property name="severity" value="ignore"/>
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
- <message key="name.invalidPattern" value="Parameter name ''{0}'' must match pattern ''{1}''."/>
+ <message key="name.invalidPattern"
+ value="Parameter name ''{0}'' must match pattern ''{1}''."/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
<module name="TypeName">
- <message key="name.invalidPattern" value="Type name ''{0}'' must match pattern ''{1}''."/>
+ <message key="name.invalidPattern"
+ value="Type name ''{0}'' must match pattern ''{1}''."/>
</module>
+
+ <!-- Regexp -->
<module name="Regexp">
<property name="severity" value="ignore"/>
<property name="format" value="[ \t]+$"/>
- <property name="message" value="Trailing whitespace"/>
<property name="illegalPattern" value="true"/>
+ <property name="message" value="Trailing whitespace"/>
<property name="ignoreComments" value="true"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
</module>
+
+ <!-- Whitespace -->
<module name="EmptyLineSeparator">
<property name="allowNoEmptyLineBetweenFields" value="true"/>
</module>
+
<module name="GenericWhitespace">
- <message key="ws.notPreceded" value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
- <message key="ws.followed" value="GenericWhitespace ''{0}'' is followed by whitespace."/>
- <message key="ws.preceded" value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
- <message key="ws.illegalFollow" value="GenericWhitespace ''{0}'' should followed by whitespace."/>
- </module>
- <module name="NoLineWrap"/>
+ <message key="ws.followed"
+ value="GenericWhitespace ''{0}'' is followed by whitespace."/>
+ <message key="ws.preceded"
+ value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
+ <message key="ws.illegalFollow"
+ value="GenericWhitespace ''{0}'' should followed by whitespace."/>
+ <message key="ws.notPreceded"
+ value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
+ </module>
+
+ <module name="NoLineWrap"/> <!-- Only for import and package statements -->
+
<module name="MethodParamPad"/>
+
<module name="OperatorWrap">
<property name="option" value="NL"/>
<property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR "/>
</module>
+
<module name="SeparatorWrap">
- <property name="option" value="nl"/>
<property name="tokens" value="DOT"/>
+ <property name="option" value="nl"/>
</module>
+
<module name="SeparatorWrap">
- <property name="option" value="EOL"/>
<property name="tokens" value="COMMA"/>
+ <property name="option" value="EOL"/>
</module>
+
<module name="WhitespaceAround">
<property name="allowEmptyConstructors" value="true"/>
<property name="allowEmptyMethods" value="true"/>
@@ -259,27 +396,7 @@ under the License.
<message key="ws.notPreceded" value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
<message key="ws.notFollowed" value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
</module>
- <module name="JavadocTagContinuationIndentation"/>
- <module name="AnnotationLocation"/>
- </module>
- <module name="BeforeExecutionExclusionFileFilter">
- <property name="fileNamePattern" value=".*Test\.java$"/>
- </module>
- <module name="FileTabCharacter">
- <property name="eachLine" value="true"/>
- </module>
- <module name="JavadocPackage"/>
- <module name="NewlineAtEndOfFile">
- <property name="lineSeparator" value="lf"/>
- </module>
- <module name="LineLength">
- <property name="severity" value="warning"/>
- <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
- <property name="max" value="110"/>
- </module>
- <module name="SuppressWithPlainTextCommentFilter">
- <property name="offCommentFormat" value="//CHECKSTYLE.OFF\: ([\w\|]+)"/>
- <property name="onCommentFormat" value="//CHECKSTYLE.ON\: ([\w\|]+)"/>
- <property name="checkFormat" value="$1"/>
- </module>
+
+ </module> <!-- End of TreeWalker -->
+
</module>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org