the new update

Author: Artem Labazin

.codestyle/checkstyle.xml

@@ -64,14 +64,17 @@ limitations under the License.
   <module name="UniqueProperties"/>
 
   <module name="SuppressWarningsFilter" />
+    <module name="LineLength">
+      <property name="max" value="120"/>
+    </module>
 
 
   <module name="TreeWalker">
     <module name="SuppressWarningsHolder" />
 
     <!-- Checks for Javadoc comments.                     -->
     <!-- See http://checkstyle.sf.net/config_javadoc.html -->
-    <!-- <module name="JavadocMethod">
+    <module name="JavadocMethod">
       <property name="scope" value="protected"/>
       <property name="allowedAnnotations" value="Override, Test"/>
       <property name="allowThrowsTagsForSubclasses" value="true"/>
@@ -90,15 +93,14 @@ limitations under the License.
     <module name="SummaryJavadoc">
       <property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
     </module>
-    <module name="JavadocParagraph"/>
     <module name="SingleLineJavadoc">
       <property name="ignoreInlineTags" value="false"/>
     </module>
     <module name="AtclauseOrder">
       <property name="tagOrder" value="@param, @return, @throws, @see, @since, @author, @version, @deprecated"/>
       <property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
     </module>
-    <module name="NonEmptyAtclauseDescription"/> -->
+    <module name="NonEmptyAtclauseDescription"/>
 
 
     <!-- Checks for Naming Conventions.                  -->
@@ -183,9 +185,6 @@ limitations under the License.
     <module name="AnonInnerLength">
       <property name="max" value="20"/>
     </module>
-    <module name="LineLength">
-      <property name="max" value="140"/>
-    </module>
     <module name="MethodLength">
       <property name="tokens" value="METHOD_DEF"/>
       <property name="max" value="60"/>
@@ -234,7 +233,7 @@ limitations under the License.
     <module name="OperatorWrap">
       <property name="option" value="NL"/>
       <property name="tokens"
-                value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LT, MINUS, MOD, NOT_EQUAL, QUESTION, SL, SR, STAR"/>
+                value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LE, LITERAL_INSTANCEOF, LT, MINUS, MOD, NOT_EQUAL, QUESTION, SL, SR, STAR"/>
     </module>
     <module name="ParenPad"/>
     <module name="SeparatorWrap">
@@ -347,7 +346,6 @@ limitations under the License.
     <module name="OneStatementPerLine"/>
     <module name="PackageDeclaration"/>
     <module name="ParameterAssignment"/>
-    <module name="SimplifyBooleanExpression"/>
     <module name="SimplifyBooleanReturn"/>
     <module name="StringLiteralEquality"/>
     <module name="SuperClone"/>
@@ -379,11 +377,10 @@ limitations under the License.
       <property name="caseIndent" value="0"/>
       <property name="throwsIndent" value="0"/>
       <property name="lineWrappingIndentation" value="4"/>
-      <property name="arrayInitIndent" value="4"/>
+      <property name="arrayInitIndent" value="2"/>
       <property name="forceStrictCondition" value="false"/>
     </module>
     <module name="OuterTypeFilename"/>
-    <module name="TodoComment"/>
     <module name="UncommentedMain">
       <property name="excludedClasses" value="\.Main$"/>
     </module>

.codestyle/pmd.xml

@@ -24,18 +24,24 @@ limitations under the License.
   <description>PMD Rules</description>
 
   <rule ref="category/java/bestpractices.xml">
+    <exclude name="AvoidPrintStackTrace" />
+    <exclude name="SystemPrintln" />
+    <exclude name="UseVarargs" />
   </rule>
   <rule ref="category/java/codestyle.xml">
+    <exclude name="LinguisticNaming" />
     <exclude name="AbstractNaming" />
     <exclude name="AtLeastOneConstructor" />
     <exclude name="AvoidPrefixingMethodParameters" />
+    <exclude name="ClassNamingConventions" />
     <exclude name="CommentDefaultAccessModifier" />
     <exclude name="DefaultPackage" />
     <exclude name="FieldDeclarationsShouldBeAtStartOfClass" />
     <exclude name="LocalVariableCouldBeFinal" />
     <exclude name="LongVariable" />
     <exclude name="MethodArgumentCouldBeFinal" />
     <exclude name="OnlyOneReturn" />
+    <exclude name="PrematureDeclaration" />
     <exclude name="ShortClassName" />
     <exclude name="ShortMethodName" />
     <exclude name="ShortVariable" />
@@ -46,10 +52,12 @@ limitations under the License.
     <exclude name="AvoidCatchingGenericException" />
     <exclude name="AvoidRethrowingException" />
     <exclude name="AvoidThrowingNullPointerException" />
+    <exclude name="CyclomaticComplexity" />
     <exclude name="ExcessiveImports" />
     <exclude name="ExcessivePublicCount" />
     <exclude name="LawOfDemeter" />
     <exclude name="LoosePackageCoupling" />
+    <exclude name="SimplifyBooleanExpressions" />
     <exclude name="TooManyFields" />
     <exclude name="TooManyMethods" />
 
@@ -63,14 +71,18 @@ limitations under the License.
     <exclude name="CommentRequired" />
   </rule>
   <rule ref="category/java/errorprone.xml">
-    <exclude name="AvoidFieldNameMatchingTypeName" />
     <exclude name="AvoidFieldNameMatchingMethodName" />
+    <exclude name="AvoidFieldNameMatchingTypeName" />
     <exclude name="BeanMembersShouldSerialize" />
+    <exclude name="CompareObjectsWithEquals" />
     <exclude name="DataflowAnomalyAnalysis" />
+    <exclude name="DontImportSun" />
     <exclude name="MissingBreakInSwitch" />
   </rule>
   <rule ref="category/java/multithreading.xml">
-    <exclude name="AvoidUsingVolatile" />
+    <exclude name="AvoidSynchronizedAtMethodLevel" />
+    <exclude name="DoNotUseThreads" />
+    <exclude name="UseConcurrentHashMap" />
   </rule>
   <rule ref="category/java/performance.xml">
     <exclude name="AvoidUsingShortType" />

CHANGELOG.md

@@ -12,6 +12,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Add more tests.
 - Add `JavaDoc`.
 
+## [1.17.0](https://github.com/appulse-projects/utils-java/releases/tag/1.17.0) - 2019-12-09
+
+### Added
+
+- `BytesInputStream` implementation of `InputStream` with `Bytes` internal;
+- `BytesOutputStream` implementation of `OutputStream` with `Bytes` internal.
+
+### Changed
+
+- Updated plugins;
+- Updated `pmd` and `checkstyle` rules;
+- Correct *Javadoc*s.
+
 ## [1.16.4](https://github.com/appulse-projects/utils-java/releases/tag/1.16.4) - 2019-12-05
 
 ### Changed

pom.xml

@@ -24,7 +24,7 @@ limitations under the License.
 
   <groupId>io.appulse</groupId>
   <artifactId>utils-java</artifactId>
-  <version>1.16.4</version>
+  <version>1.17.0</version>
   <packaging>jar</packaging>
 
   <properties>
@@ -66,7 +66,7 @@ limitations under the License.
     <url>https://github.com/appulse-projects/utils-java</url>
     <connection>scm:git:https://github.com/appulse-projects/utils-java.git</connection>
     <developerConnection>scm:git:https://github.com/appulse-projects/utils-java.git</developerConnection>
-    <tag>1.16.4</tag>
+    <tag>1.17.0</tag>
   </scm>
 
   <distributionManagement>
@@ -194,13 +194,14 @@ limitations under the License.
       <plugin>
         <groupId>pl.project13.maven</groupId>
         <artifactId>git-commit-id-plugin</artifactId>
-        <version>3.0.0</version>
+        <version>4.0.0</version>
         <executions>
           <execution>
-            <id>git-infos</id>
+            <id>get-the-git-infos</id>
             <goals>
               <goal>revision</goal>
             </goals>
+            <phase>initialize</phase>
           </execution>
         </executions>
         <configuration>
@@ -224,7 +225,7 @@ limitations under the License.
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
-        <version>3.1.0</version>
+        <version>3.1.1</version>
         <configuration>
           <additionalOptions>-Xdoclint:none</additionalOptions>
           <additionalparam>-Xdoclint:none</additionalparam>
@@ -301,7 +302,7 @@ limitations under the License.
       <plugin>
         <groupId>com.github.spotbugs</groupId>
         <artifactId>spotbugs-maven-plugin</artifactId>
-        <version>3.1.11</version>
+        <version>3.1.12.2</version>
         <configuration>
           <effort>Max</effort>
           <threshold>Low</threshold>
@@ -353,7 +354,7 @@ limitations under the License.
           <dependency>
             <groupId>com.puppycrawl.tools</groupId>
             <artifactId>checkstyle</artifactId>
-            <version>8.21</version>
+            <version>8.24</version>
           </dependency>
         </dependencies>
         <executions>

src/main/java/io/appulse/utils/AnnotationUtils.java

@@ -31,8 +31,8 @@
 /**
  * Different annotation helpers.
  *
- * @author Artem Labazin
  * @since 1.7.0
+ * @author Artem Labazin
  */
 public final class AnnotationUtils {
 
@@ -62,6 +62,8 @@ public final class AnnotationUtils {
    *
    * @param annotationType the annotation type to look for, both locally and as a meta-annotation
    *
+   * @param <T> the annotation type.
+   *
    * @return the first matching annotation
    *
    * @since 1.7.0
@@ -89,6 +91,8 @@ public static <T extends Annotation> Optional<T> findAnnotation (Class<?> clazz,
    *
    * @param annotationType the annotation type to look for, both locally and as a meta-annotation
    *
+   * @param <T> the annotation type.
+   *
    * @return the first matching annotation
    *
    * @since 1.7.0
@@ -118,6 +122,8 @@ public static <T extends Annotation> Optional<T> findAnnotation (AnnotatedElemen
    *
    * @param annotationType the annotation type to look for
    *
+   * @param <T> the annotation type.
+   *
    * @return the first matching annotation
    *
    * @since 1.7.0
@@ -141,7 +147,8 @@ public static boolean isInJavaLangAnnotationPackage (Annotation annotation) {
   }
 
   /**
-   * Determine if the {@link Annotation} with the supplied name is defined in the core JDK {@code java.lang.annotation} package.
+   * Determine if the {@link Annotation} with the supplied name is defined in
+   * the core JDK {@code java.lang.annotation} package.
    *
    * @param annotationType the annotation type to check
    *
@@ -154,7 +161,8 @@ public static boolean isInJavaLangAnnotationPackage (Class<? extends Annotation>
   }
 
   /**
-   * Determine if the {@link Annotation} with the supplied name is defined in the core JDK {@code java.lang.annotation} package.
+   * Determine if the {@link Annotation} with the supplied name is defined in
+   * the core JDK {@code java.lang.annotation} package.
    *
    * @param annotationType the name of the annotation type to check
    *

src/main/java/io/appulse/utils/Bytes.java

@@ -24,8 +24,8 @@
  * This interface provides an abstract view for a primitive byte
  * arrays ({@code byte[]}).
  *
- * @author Artem Labazin
  * @since 1.12.0
+ * @author Artem Labazin
  */
 @SuppressWarnings({
     "PMD.ExcessiveClassLength",
@@ -90,7 +90,9 @@ static Bytes copy (ByteBuffer buffer) {
   }
 
   /**
-   * Create a new {@link Bytes} instance with a fixed size content
+   * Create a new {@link Bytes} instance with a fixed size content.
+   *
+   * @param size the size of a new buffer.
    *
    * @return the new {@link Bytes} instance
    */
@@ -1638,6 +1640,8 @@ static Bytes resizableArray (int initialSize) {
 
   /**
    * Returns the number of bytes (octets) this buffer can contain.
+   *
+   * @return the number of bytes.
    */
   int capacity ();
 
@@ -1766,7 +1770,7 @@ static Bytes resizableArray (int initialSize) {
 
   /**
    * Returns the copy of range the buffer's back byte array from
-   * <b>0</b> till <b>writeIndex</t>.
+   * <b>0</b> till <b>writeIndex</b>.
    * <p>
    * Modifications to this buffer's content may NOT cause the
    * returned array's content to be modified, and vice versa.