use checkstyle

Neiko2002 · Dec 13, 2014 · 7bc9e84 · 7bc9e84
1 parent d6ebf07
commit 7bc9e84
Show file tree

Hide file tree

Showing 32 changed files with 291 additions and 111 deletions.
diff --git a/build.gradle b/build.gradle
@@ -1,5 +1,5 @@
-// Apply the java plugin to add support for Java
 apply plugin: 'java'
+apply plugin: 'checkstyle'
 
 repositories {
   jcenter()
@@ -12,3 +12,7 @@ dependencies {
   testCompile "org.mockito:mockito-core:1.+"
   testCompile "org.hamcrest:hamcrest-all:1.3"
 }
+
+checkstyle {
+  toolVersion '6.1.1'
+}
diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml
@@ -0,0 +1,201 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC
+          "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
+          "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
+
+<!--
+
+    Checkstyle configuration that checks the Google coding conventions from:
+    
+    -  Google Java Style
+       https://google-styleguide.googlecode.com/svn-history/r130/trunk/javaguide.html
+       
+    Checkstyle is very configurable. Be sure to read the documentation at
+    http://checkstyle.sf.net (or in your downloaded distribution).
+
+    Most Checks are configurable, be sure to consult the documentation.
+
+    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="charset" value="UTF-8"/>
+
+    <property name="severity" value="warning"/>
+
+    <!-- Checks for whitespace                               -->
+    <!-- See http://checkstyle.sf.net/config_whitespace.html -->
+        <module name="FileTabCharacter">
+            <property name="eachLine" value="true"/>
+        </module>
+
+    <module name="TreeWalker">
+        <module name="UnusedImports"/> 
+        <module name="OuterTypeFilename"/>
+        <module name="IllegalTokenText">
+            <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."/>
+        </module>
+        <module name="AvoidEscapedUnicodeCharacters">
+            <property name="allowEscapesForControlCharacters" value="true"/>
+            <property name="allowByTailComment" value="true"/>
+            <property name="allowNonPrintableEscapes" value="true"/>
+        </module>
+        <module name="LineLength">
+            <property name="max" value="100"/>
+            <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
+        </module>
+        <module name="AvoidStarImport"/>
+        <module name="OneTopLevelClass"/>
+        <module name="NoLineWrap"/>
+        <module name="EmptyBlock">
+            <property name="option" value="TEXT"/>
+            <property name="tokens" value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
+        </module>
+        <module name="NeedBraces"/>
+        <module name="LeftCurly">
+            <property name="maxLineLength" value="100"/>
+        </module>
+        <module name="RightCurly"/>
+        <module name="RightCurly">
+            <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"/>
+        </module>
+        <module name="WhitespaceAround">
+            <property name="allowEmptyConstructors" value="true"/>
+            <property name="allowEmptyMethods" value="true"/>
+            <property name="allowEmptyTypes" value="true"/>
+            <property name="allowEmptyLoops" value="true"/>
+            <message key="ws.notFollowed"
+             value="WhitespaceAround: ''{0}'' is not followed by whitespace."/>
+             <message key="ws.notPreceded"
+             value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
+        </module>
+        <module name="OneStatementPerLine"/>
+        <module name="MultipleVariableDeclarations"/>
+        <module name="ArrayTypeStyle"/>
+        <module name="MissingSwitchDefault"/>
+        <module name="FallThrough"/>
+        <module name="UpperEll"/>
+        <module name="ModifierOrder"/>
+        <module name="EmptyLineSeparator">
+            <property name="allowNoEmptyLineBetweenFields" value="true"/>
+        </module>
+        <module name="SeparatorWrap">
+            <property name="tokens" value="DOT"/>
+            <property name="option" value="nl"/>
+        </module>
+        <module name="SeparatorWrap">
+            <property name="tokens" value="COMMA"/>
+            <property name="option" value="EOL"/>
+        </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}''."/>
+        </module>
+        <module name="TypeName">
+            <message key="name.invalidPattern"
+             value="Type name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="MemberName">
+            <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}''."/>
+        </module>
+        <module name="ParameterName">
+            <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}''."/>
+        </module>
+        <module name="LocalVariableName">
+            <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}''."/>
+        </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}''."/>
+        </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}''."/>
+        </module>
+        <module name="NoFinalizer"/>
+        <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="Indentation">
+            <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"/>
+        </module>
+        <module name="AbbreviationAsWordInName">
+            <property name="ignoreFinal" value="false"/>
+            <property name="allowedAbbreviationLength" value="1"/>
+        </module>
+        <module name="OverloadMethodsDeclarationOrder"/>
+        <module name="VariableDeclarationUsageDistance"/>
+        <module name="CustomImportOrder">
+            <property name="thirdPartyPackageRegExp" value=".*"/>
+            <property name="specialImportsRegExp" value="com.google"/>
+            <property name="sortImportsInGroupAlphabetically" value="true"/>
+            <property name="customImportOrderRules" value="STATIC###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE"/>
+        </module>
+        <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="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"/>
+        </module>
+        <module name="NonEmptyAtclauseDescription"/>
+        <module name="JavadocTagContinuationIndentation"/>
+        <module name="SummaryJavadocCheck">
+            <property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
+        </module>
+        <module name="JavadocParagraph"/>
+        <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"/>
+        </module>
+        <module name="JavadocMethod">
+            <property name="scope" value="public"/>
+            <property name="allowMissingParamTags" value="true"/>
+            <property name="allowMissingThrowsTags" value="true"/>
+            <property name="allowMissingReturnTag" value="true"/>
+            <property name="minLineCount" value="2"/>
+            <property name="allowedAnnotations" value="Override, Test"/>
+            <property name="allowThrowsTagsForSubclasses" value="true"/>
+        </module>
+        <module name="MethodName">
+            <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}''."/>
+        </module>
+        <module name="SingleLineJavadoc"/>
+    </module>
+</module>
diff --git a/src/main/java/com/emilong/ioagogo/benchmark/RandomFileFactory.java b/src/main/java/com/emilong/ioagogo/benchmark/RandomFileFactory.java
@@ -17,6 +17,10 @@ public class RandomFileFactory implements IFileFactory {
   private final File file;
   private final Random random = new Random();
 
+  /**
+    * Creates a new RandomFileFactory with the given fileSize and parent
+    * directory. May throw IOException if unable to create the file.
+    */
   public RandomFileFactory(int fileSize, File directory) throws IOException {
     file = File.createTempFile(PREFIX, SUFFIX, directory);
 
@@ -27,8 +31,7 @@ public RandomFileFactory(int fileSize, File directory) throws IOException {
       for (int i = 0; i < fileSize; i++) {
         outputStream.write(random.nextInt(256) & 0xFF);
       }
-    }
-    finally {
+    } finally {
       if (outputStream != null) {
         outputStream.close();
       }

diff --git a/src/main/java/com/emilong/ioagogo/benchmark/SingleReadStrategyTimer.java b/src/main/java/com/emilong/ioagogo/benchmark/SingleReadStrategyTimer.java
@@ -22,6 +22,13 @@ public SingleReadStrategyTimer(IFileFactory fileFactory,
     this.readStrategy = readStrategy;
   }
 
+  /**
+    * Performs a run with the given strategy for each of the given buffer
+    * sizes. Performs at most one run per buffer size. Will not perform any
+    * runs which the given strategy does not support. Returns the
+    * TimerResults for each of the runs performed, potentially fewer than
+    * the length bufferSizes array.
+    */
   public List<TimerResult> performRuns(int[] bufferSizes) throws IOException {
     List<TimerResult> results = new ArrayList<TimerResult>(bufferSizes.length);
 

diff --git a/...in/java/com/emilong/ioagogo/strategies/BufferedInputStreamWithByteArrayReadsStrategy.java b/...in/java/com/emilong/ioagogo/strategies/BufferedInputStreamWithByteArrayReadsStrategy.java
@@ -1,7 +1,7 @@
 package com.emilong.ioagogo.strategies;
 
-import java.io.File;
 import java.io.BufferedInputStream;
+import java.io.File;
 import java.io.FileInputStream;
 import java.io.IOException;
 
@@ -25,8 +25,7 @@ public byte[] readBytes(int bufferSize, File inputFile) throws IOException {
       inputStream = new BufferedInputStream(new FileInputStream(inputFile));
 
       while (inputStream.read(buffer, 0, bufferSize) >= 0) {}
-    }
-    finally {
+    } finally {
       if (inputStream != null) {
         inputStream.close();
       }

diff --git a/src/main/java/com/emilong/ioagogo/strategies/BufferedInputStreamWithByteReadsStrategy.java b/src/main/java/com/emilong/ioagogo/strategies/BufferedInputStreamWithByteReadsStrategy.java
@@ -1,7 +1,7 @@
 package com.emilong.ioagogo.strategies;
 
-import java.io.File;
 import java.io.BufferedInputStream;
+import java.io.File;
 import java.io.FileInputStream;
 import java.io.IOException;
 
@@ -27,8 +27,7 @@ public byte[] readBytes(int bufferSize, File inputFile) throws IOException {
       for (int i = 0; i < inputFile.length(); i++) {
         buffer[0] = (byte) inputStream.read();
       }
-    }
-    finally {
+    } finally {
       if (inputStream != null) {
         inputStream.close();
       }

diff --git a/src/main/java/com/emilong/ioagogo/strategies/FileChannelWithAllocatedByteBufferStrategy.java b/src/main/java/com/emilong/ioagogo/strategies/FileChannelWithAllocatedByteBufferStrategy.java
@@ -9,12 +9,11 @@
   * through a FileChannel with a normal allocated ByteBuffer.
 ***/
 public class FileChannelWithAllocatedByteBufferStrategy
-  extends FileChannelWithByteBufferStrategy {
+    extends FileChannelWithByteBufferStrategy {
 
   @Override
   protected ByteBufferFactory createByteBufferFactory(int bufferSize)
-    throws IOException
-  {
+      throws IOException {
     return new AllocatedByteBufferFactory(bufferSize);
   }
 

diff --git a/src/main/java/com/emilong/ioagogo/strategies/FileChannelWithByteBufferStrategy.java b/src/main/java/com/emilong/ioagogo/strategies/FileChannelWithByteBufferStrategy.java
@@ -33,8 +33,7 @@ public byte[] readBytes(int bufferSize, File inputFile) throws IOException {
            n = fileChannel.read(byteBuffer)) {
         byteBuffer.position(0);
       }
-    }
-    finally {
+    } finally {
       if (inputStream != null) {
         inputStream.close();
       }

diff --git a/src/main/java/com/emilong/ioagogo/strategies/FileChannelWithDirectByteBufferStrategy.java b/src/main/java/com/emilong/ioagogo/strategies/FileChannelWithDirectByteBufferStrategy.java
@@ -9,12 +9,11 @@
   * through a FileChannel with a direct allocated ByteBuffer.
 ***/
 public class FileChannelWithDirectByteBufferStrategy
-  extends FileChannelWithByteBufferStrategy {
+    extends FileChannelWithByteBufferStrategy {
 
   @Override
   protected ByteBufferFactory createByteBufferFactory(int bufferSize)
-    throws IOException
-  {
+      throws IOException {
     return new DirectByteBufferFactory(bufferSize);
   }
 

diff --git a/src/main/java/com/emilong/ioagogo/strategies/FileChannelWithMappedByteBufferStrategy.java b/src/main/java/com/emilong/ioagogo/strategies/FileChannelWithMappedByteBufferStrategy.java
@@ -26,14 +26,13 @@ public byte[] readBytes(int bufferSize, File inputFile) throws IOException {
       inputStream = new FileInputStream(inputFile);
       FileChannel fileChannel = inputStream.getChannel();
       ByteBuffer byteBuffer =
-        fileChannel.map(FileChannel.MapMode.READ_ONLY, 0L, fileChannel.size());
+          fileChannel.map(FileChannel.MapMode.READ_ONLY, 0L, fileChannel.size());
 
       while (byteBuffer.hasRemaining()) {
         int readSize = Math.min(byteBuffer.remaining(), bufferSize);
         byteBuffer.get(buffer, 0, readSize);
       }
-    }
-    finally {
+    } finally {
       if (inputStream != null) {
         inputStream.close();
       }

diff --git a/src/main/java/com/emilong/ioagogo/strategies/FileChannelWithWrappedByteBufferStrategy.java b/src/main/java/com/emilong/ioagogo/strategies/FileChannelWithWrappedByteBufferStrategy.java
@@ -10,12 +10,11 @@
   * byte array.
 ***/
 public class FileChannelWithWrappedByteBufferStrategy
-  extends FileChannelWithByteBufferStrategy {
+    extends FileChannelWithByteBufferStrategy {
 
   @Override
   protected ByteBufferFactory createByteBufferFactory(int bufferSize)
-    throws IOException
-  {
+    throws IOException {
     return new WrappedByteBufferFactory(bufferSize);
   }
 

diff --git a/src/main/java/com/emilong/ioagogo/strategies/FileInputStreamWithByteArrayReadsStrategy.java b/src/main/java/com/emilong/ioagogo/strategies/FileInputStreamWithByteArrayReadsStrategy.java
@@ -24,8 +24,7 @@ public byte[] readBytes(int bufferSize, File inputFile) throws IOException {
       inputStream = new FileInputStream(inputFile);
 
       while (inputStream.read(buffer, 0, bufferSize) >= 0) {}
-    }
-    finally {
+    } finally {
       if (inputStream != null) {
         inputStream.close();
       }

diff --git a/src/main/java/com/emilong/ioagogo/strategies/FileInputStreamWithByteReadsStrategy.java b/src/main/java/com/emilong/ioagogo/strategies/FileInputStreamWithByteReadsStrategy.java
@@ -26,8 +26,7 @@ public byte[] readBytes(int bufferSize, File inputFile) throws IOException {
       for (int i = 0; i < inputFile.length(); i++) {
         buffer[0] = (byte) inputStream.read();
       }
-    }
-    finally {
+    } finally {
       if (inputStream != null) {
         inputStream.close();
       }

diff --git a/src/main/java/com/emilong/ioagogo/strategies/RandomAccessFileWithByteArrayReadsStrategy.java b/src/main/java/com/emilong/ioagogo/strategies/RandomAccessFileWithByteArrayReadsStrategy.java
@@ -24,8 +24,7 @@ public byte[] readBytes(int bufferSize, File inputFile) throws IOException {
       randomAccessFile = new RandomAccessFile(inputFile, "r");
 
       while (randomAccessFile.read(buffer, 0, bufferSize) >= 0) {}
-    }
-    finally {
+    } finally {
       if (randomAccessFile != null) {
         randomAccessFile.close();
       }