This is an automated email from the ASF dual-hosted git repository. leerho pushed a commit to branch Minor_updates in repository https://gitbox.apache.org/repos/asf/datasketches-memory.git
commit 499dda2c5d892397bb305bc7557af31295142004 Author: Lee Rhodes <[email protected]> AuthorDate: Tue Mar 2 12:27:28 2021 -0800 Minor changes. Added SuppressWarnings() as documentation of restricted access issues so they can be easily found. --- .../datasketches/memory/AccessByteBuffer.java | 1 + .../apache/datasketches/memory/AllocateDirect.java | 10 +- .../datasketches/memory/AllocateDirectMap.java | 11 +- .../org/apache/datasketches/memory/BaseState.java | 1 + .../memory/BaseWritableBufferImpl.java | 1 + .../memory/BaseWritableMemoryImpl.java | 1 + .../apache/datasketches/memory/CompareAndCopy.java | 1 + .../java/org/apache/datasketches/memory/Ints.java | 5 +- .../apache/datasketches/memory/JDK7Compatible.java | 1 + .../org/apache/datasketches/memory/NioBits.java | 1 + .../memory/NonNativeWritableBufferImpl.java | 1 + .../memory/NonNativeWritableMemoryImpl.java | 1 + .../org/apache/datasketches/memory/UnsafeUtil.java | 2 +- .../java/org/apache/datasketches/memory/Utf8.java | 1 + .../datasketches/memory/WritableBufferImpl.java | 1 + .../datasketches/memory/WritableMemoryImpl.java | 1 + .../org/apache/datasketches/memory/XxHash64.java | 1 + .../apache/datasketches/memory/UnsafeUtilTest.java | 2 +- tools/MemoryCheckstyle.xml | 253 +++++---------------- 19 files changed, 86 insertions(+), 210 deletions(-) diff --git a/src/main/java/org/apache/datasketches/memory/AccessByteBuffer.java b/src/main/java/org/apache/datasketches/memory/AccessByteBuffer.java index 5b0929e..697bbe8 100644 --- a/src/main/java/org/apache/datasketches/memory/AccessByteBuffer.java +++ b/src/main/java/org/apache/datasketches/memory/AccessByteBuffer.java @@ -31,6 +31,7 @@ import java.nio.ByteOrder; * @author Praveenkumar Venkatesan * @author Roman Leventov */ +@SuppressWarnings({"restriction"}) final class AccessByteBuffer { static final ByteBuffer ZERO_READ_ONLY_DIRECT_BYTE_BUFFER = diff --git a/src/main/java/org/apache/datasketches/memory/AllocateDirect.java b/src/main/java/org/apache/datasketches/memory/AllocateDirect.java index e699e1f..805554c 100644 --- a/src/main/java/org/apache/datasketches/memory/AllocateDirect.java +++ b/src/main/java/org/apache/datasketches/memory/AllocateDirect.java @@ -32,6 +32,7 @@ import sun.misc.Cleaner; * @author Roman Leventov * @author Lee Rhodes */ +@SuppressWarnings({"restriction","synthetic-access"}) final class AllocateDirect implements AutoCloseable { private static final Logger LOG = LoggerFactory.getLogger(AllocateDirect.class); @@ -83,9 +84,9 @@ final class AllocateDirect implements AutoCloseable { // because the valid state is already changed. cleaner.clean(); return true; - } else { - return false; } + return false; + } finally { BaseState.reachabilityFence(this); } @@ -135,9 +136,8 @@ final class AllocateDirect implements AutoCloseable { BaseState.currentDirectMemoryAllocations_.decrementAndGet(); BaseState.currentDirectMemoryAllocated_.addAndGet(-capacity); return true; - } else { - return false; - } + } + return false; } } diff --git a/src/main/java/org/apache/datasketches/memory/AllocateDirectMap.java b/src/main/java/org/apache/datasketches/memory/AllocateDirectMap.java index 41cdf46..0dbe16a 100644 --- a/src/main/java/org/apache/datasketches/memory/AllocateDirectMap.java +++ b/src/main/java/org/apache/datasketches/memory/AllocateDirectMap.java @@ -54,6 +54,7 @@ import sun.nio.ch.FileChannelImpl; * @author Lee Rhodes * @author Praveenkumar Venkatesan */ +@SuppressWarnings({"restriction","synthetic-access"}) class AllocateDirectMap implements Map { private static final Logger LOG = LoggerFactory.getLogger(AllocateDirectMap.class); @@ -162,9 +163,8 @@ class AllocateDirectMap implements Map { // because the valid state is already changed. cleaner.clean(); return true; - } else { - return false; - } + } + return false; } finally { BaseState.reachabilityFence(this); } @@ -294,9 +294,8 @@ class AllocateDirectMap implements Map { BaseState.currentDirectMemoryMapAllocated_.addAndGet(-myCapacity); } return true; - } else { - return false; - } + } + return false; } /** diff --git a/src/main/java/org/apache/datasketches/memory/BaseState.java b/src/main/java/org/apache/datasketches/memory/BaseState.java index 9f6d984..da66836 100644 --- a/src/main/java/org/apache/datasketches/memory/BaseState.java +++ b/src/main/java/org/apache/datasketches/memory/BaseState.java @@ -34,6 +34,7 @@ import java.util.concurrent.atomic.AtomicLong; * * @author Lee Rhodes */ +@SuppressWarnings({"restriction"}) abstract class BaseState { //Byte Order related diff --git a/src/main/java/org/apache/datasketches/memory/BaseWritableBufferImpl.java b/src/main/java/org/apache/datasketches/memory/BaseWritableBufferImpl.java index 2cb3c30..1894345 100644 --- a/src/main/java/org/apache/datasketches/memory/BaseWritableBufferImpl.java +++ b/src/main/java/org/apache/datasketches/memory/BaseWritableBufferImpl.java @@ -49,6 +49,7 @@ import java.nio.ByteOrder; * Common base of native-ordered and non-native-ordered {@link WritableBuffer} implementations. * Contains methods which are agnostic to the byte order. */ +@SuppressWarnings({"restriction"}) abstract class BaseWritableBufferImpl extends WritableBuffer { final BaseWritableMemoryImpl originMemory; diff --git a/src/main/java/org/apache/datasketches/memory/BaseWritableMemoryImpl.java b/src/main/java/org/apache/datasketches/memory/BaseWritableMemoryImpl.java index c0809a3..bf3c6b9 100644 --- a/src/main/java/org/apache/datasketches/memory/BaseWritableMemoryImpl.java +++ b/src/main/java/org/apache/datasketches/memory/BaseWritableMemoryImpl.java @@ -52,6 +52,7 @@ import java.nio.channels.WritableByteChannel; * Common base of native-ordered and non-native-ordered {@link WritableMemory} implementations. * Contains methods which are agnostic to the byte order. */ +@SuppressWarnings({"restriction"}) abstract class BaseWritableMemoryImpl extends WritableMemory { diff --git a/src/main/java/org/apache/datasketches/memory/CompareAndCopy.java b/src/main/java/org/apache/datasketches/memory/CompareAndCopy.java index 8052d0a..f9bbc0f 100644 --- a/src/main/java/org/apache/datasketches/memory/CompareAndCopy.java +++ b/src/main/java/org/apache/datasketches/memory/CompareAndCopy.java @@ -31,6 +31,7 @@ import static org.apache.datasketches.memory.UnsafeUtil.unsafe; /** * @author Lee Rhodes */ +@SuppressWarnings({"restriction"}) final class CompareAndCopy { /** diff --git a/src/main/java/org/apache/datasketches/memory/Ints.java b/src/main/java/org/apache/datasketches/memory/Ints.java index 4417fd7..d463ea0 100644 --- a/src/main/java/org/apache/datasketches/memory/Ints.java +++ b/src/main/java/org/apache/datasketches/memory/Ints.java @@ -28,8 +28,7 @@ final class Ints { final int result = (int) v; if (result != v) { throw new IllegalArgumentException("Out of range: " + v); - } else { - return result; - } + } + return result; } } diff --git a/src/main/java/org/apache/datasketches/memory/JDK7Compatible.java b/src/main/java/org/apache/datasketches/memory/JDK7Compatible.java index 5308b19..ee3ff0a 100644 --- a/src/main/java/org/apache/datasketches/memory/JDK7Compatible.java +++ b/src/main/java/org/apache/datasketches/memory/JDK7Compatible.java @@ -19,6 +19,7 @@ package org.apache.datasketches.memory; +@SuppressWarnings({"restriction"}) final class JDK7Compatible { private JDK7Compatible() {} diff --git a/src/main/java/org/apache/datasketches/memory/NioBits.java b/src/main/java/org/apache/datasketches/memory/NioBits.java index ac853e1..a2627b4 100644 --- a/src/main/java/org/apache/datasketches/memory/NioBits.java +++ b/src/main/java/org/apache/datasketches/memory/NioBits.java @@ -30,6 +30,7 @@ import java.util.concurrent.atomic.AtomicLong; * * @author Lee Rhodes */ +@SuppressWarnings({"restriction"}) final class NioBits { private static final Class<?> VM_CLASS; private static final Method VM_MAX_DIRECT_MEMORY_METHOD; diff --git a/src/main/java/org/apache/datasketches/memory/NonNativeWritableBufferImpl.java b/src/main/java/org/apache/datasketches/memory/NonNativeWritableBufferImpl.java index 9c30d1f..c2ed3bd 100644 --- a/src/main/java/org/apache/datasketches/memory/NonNativeWritableBufferImpl.java +++ b/src/main/java/org/apache/datasketches/memory/NonNativeWritableBufferImpl.java @@ -48,6 +48,7 @@ import static org.apache.datasketches.memory.UnsafeUtil.unsafe; * @author Roman Leventov * @author Lee Rhodes */ +@SuppressWarnings({"restriction"}) abstract class NonNativeWritableBufferImpl extends BaseWritableBufferImpl { //Pass-through ctor diff --git a/src/main/java/org/apache/datasketches/memory/NonNativeWritableMemoryImpl.java b/src/main/java/org/apache/datasketches/memory/NonNativeWritableMemoryImpl.java index 0de2304..8a26156 100644 --- a/src/main/java/org/apache/datasketches/memory/NonNativeWritableMemoryImpl.java +++ b/src/main/java/org/apache/datasketches/memory/NonNativeWritableMemoryImpl.java @@ -48,6 +48,7 @@ import static org.apache.datasketches.memory.UnsafeUtil.unsafe; * @author Roman Leventov * @author Lee Rhodes */ +@SuppressWarnings({"restriction"}) abstract class NonNativeWritableMemoryImpl extends BaseWritableMemoryImpl { //Pass-through ctor diff --git a/src/main/java/org/apache/datasketches/memory/UnsafeUtil.java b/src/main/java/org/apache/datasketches/memory/UnsafeUtil.java index 9dc45f8..a307802 100644 --- a/src/main/java/org/apache/datasketches/memory/UnsafeUtil.java +++ b/src/main/java/org/apache/datasketches/memory/UnsafeUtil.java @@ -29,7 +29,7 @@ import sun.misc.Unsafe; * * @author Lee Rhodes */ -@SuppressWarnings("javadoc") +@SuppressWarnings({"javadoc","restriction"}) public final class UnsafeUtil { public static final Unsafe unsafe; public static final String JDK; //must be at least "1.8" diff --git a/src/main/java/org/apache/datasketches/memory/Utf8.java b/src/main/java/org/apache/datasketches/memory/Utf8.java index 4962bc2..7cf3c28 100644 --- a/src/main/java/org/apache/datasketches/memory/Utf8.java +++ b/src/main/java/org/apache/datasketches/memory/Utf8.java @@ -45,6 +45,7 @@ import java.nio.CharBuffer; * @author Lee Rhodes * @author Roman Leventov */ +@SuppressWarnings({"restriction","synthetic-access"}) final class Utf8 { private Utf8() { } diff --git a/src/main/java/org/apache/datasketches/memory/WritableBufferImpl.java b/src/main/java/org/apache/datasketches/memory/WritableBufferImpl.java index 0a4f93a..3fbd565 100644 --- a/src/main/java/org/apache/datasketches/memory/WritableBufferImpl.java +++ b/src/main/java/org/apache/datasketches/memory/WritableBufferImpl.java @@ -55,6 +55,7 @@ import static org.apache.datasketches.memory.UnsafeUtil.unsafe; * @author Roman Leventov * @author Lee Rhodes */ +@SuppressWarnings({"restriction"}) abstract class WritableBufferImpl extends BaseWritableBufferImpl { //Pass-through ctor diff --git a/src/main/java/org/apache/datasketches/memory/WritableMemoryImpl.java b/src/main/java/org/apache/datasketches/memory/WritableMemoryImpl.java index 9a5f812..d85fecc 100644 --- a/src/main/java/org/apache/datasketches/memory/WritableMemoryImpl.java +++ b/src/main/java/org/apache/datasketches/memory/WritableMemoryImpl.java @@ -55,6 +55,7 @@ import static org.apache.datasketches.memory.UnsafeUtil.unsafe; * @author Roman Leventov * @author Lee Rhodes */ +@SuppressWarnings({"restriction"}) abstract class WritableMemoryImpl extends BaseWritableMemoryImpl { //Pass-through ctor diff --git a/src/main/java/org/apache/datasketches/memory/XxHash64.java b/src/main/java/org/apache/datasketches/memory/XxHash64.java index dd5e97f..dd0715c 100644 --- a/src/main/java/org/apache/datasketches/memory/XxHash64.java +++ b/src/main/java/org/apache/datasketches/memory/XxHash64.java @@ -53,6 +53,7 @@ import static org.apache.datasketches.memory.UnsafeUtil.unsafe; * * @author Lee Rhodes */ +@SuppressWarnings({"restriction"}) public class XxHash64 { // Unsigned, 64-bit primes private static final long P1 = -7046029288634856825L; diff --git a/src/test/java/org/apache/datasketches/memory/UnsafeUtilTest.java b/src/test/java/org/apache/datasketches/memory/UnsafeUtilTest.java index 5a5aaeb..0ac9463 100644 --- a/src/test/java/org/apache/datasketches/memory/UnsafeUtilTest.java +++ b/src/test/java/org/apache/datasketches/memory/UnsafeUtilTest.java @@ -32,7 +32,7 @@ import org.testng.annotations.Test; /** * @author Lee Rhodes */ -@SuppressWarnings("javadoc") +@SuppressWarnings({"javadoc","restriction"}) public class UnsafeUtilTest { long testField = 1; //Do not remove & cannot be static. Used in reflection check. diff --git a/tools/MemoryCheckstyle.xml b/tools/MemoryCheckstyle.xml index 9250f2a..2ab9697 100644 --- a/tools/MemoryCheckstyle.xml +++ b/tools/MemoryCheckstyle.xml @@ -1,392 +1,236 @@ <?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 -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. + This configuration file was written by the eclipse-cs plugin configuration editor --> - <!-- - 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. + Checkstyle-Configuration: MemoryCheckstyle + Description: none --> - -<module name = "Checker"> - <property name="charset" value="UTF-8"/> +<module name="Checker"> <property name="severity" value="warning"/> + <property name="charset" value="UTF-8"/> <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="110"/> - <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="tokens" value="VARIABLE_DEF"/> <property name="allowSamelineMultipleAnnotations" value="true"/> + <property name="tokens" value="VARIABLE_DEF"/> </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 --> + <module name="LeftCurly"> <property name="severity" value="ignore"/> <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/> </module> - - <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 --> + <module name="NeedBraces"/> + <module name="RightCurly"> <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="tagOrder" value="@param, @return, @throws, @deprecated"/> <property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/> + <property name="tagOrder" value="@param, @return, @throws, @deprecated"/> </module> - <module name="JavadocMethod"> - <property name="scope" value="public"/> - <property name="allowMissingParamTags" value="false"/> - <property name="allowMissingThrowsTags" value="true"/> - <property name="allowMissingReturnTag" value="false"/> <property name="allowedAnnotations" value="Override, Test"/> - <property name="allowThrowsTagsForSubclasses" value="true"/> + <property name="scope" value="public"/> </module> - <module name="JavadocParagraph"/> - <module name="JavadocTagContinuationIndentation"> <property name="severity" value="ignore"/> <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/> </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"/> <property name="allowByTailComment" value="true"/> <property name="allowNonPrintableEscapes" value="true"/> <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/> - </module> - + </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"/> <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> <module name="AbbreviationAsWordInName"> <property name="severity" value="ignore"/> - <property name="ignoreFinal" value="false"/> <property name="allowedAbbreviationLength" value="1"/> + <property name="ignoreFinal" value="false"/> <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="illegalPattern" value="true"/> <property name="message" value="Trailing whitespace"/> + <property name="illegalPattern" value="true"/> <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.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 --> - + <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"/> <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="tokens" value="DOT"/> <property name="option" value="nl"/> + <property name="tokens" value="DOT"/> </module> - <module name="SeparatorWrap"> - <property name="tokens" value="COMMA"/> <property name="option" value="EOL"/> + <property name="tokens" value="COMMA"/> </module> - <module name="WhitespaceAround"> <property name="allowEmptyConstructors" value="true"/> <property name="allowEmptyMethods" value="true"/> @@ -395,6 +239,27 @@ 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> <!-- End of TreeWalker --> + <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> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
