minor: fix violations from RequireEmptyLineBeforeAtClauseBlock

Author: josephmate

sevntu-checks/src/main/java/com/github/sevntu/checkstyle/SevntuUtil.java

@@ -39,6 +39,7 @@ private SevntuUtil() {
      * This utility method if used to mark that token passed to
      * {@link AbstractCheck#visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST)} is not
      * supported by this method.
+     *
      * @param token
      *        token/type that is not supported
      * @throws IllegalArgumentException

sevntu-checks/src/main/java/com/github/sevntu/checkstyle/checks/annotation/ForbidAnnotationCheck.java

@@ -37,6 +37,7 @@
  * value="XXX"/> <property name="annotationTargets"
  * value="METHOD_DEF,CLASS_DEF"/> </module>
  * </pre>
+ *
  * @author <a href="mailto:[email protected]">Hidoyatov Victor</a>
  * @since 1.12.0
  */
@@ -59,6 +60,7 @@ public class ForbidAnnotationCheck extends AbstractCheck {
 
     /**
      * Setter for annotationNames.
+     *
      * @param names - array of annotation's names
      */
     public void setAnnotationNames(final String... names) {
@@ -71,6 +73,7 @@ public void setAnnotationNames(final String... names) {
 
     /**
      * Getter for annotationNames.
+     *
      * @param targets - array of type's names
      */
     public void setAnnotationTargets(String... targets) {
@@ -138,6 +141,7 @@ private static String getAnnotationName(DetailAST annotation) {
 
     /**
      * Return true if mAnnotationNames contains aAnnotationName.
+     *
      * @param annotationName - name of current annotation
      * @return boolean
      */
@@ -147,6 +151,7 @@ private boolean isRequiredAnnotationName(String annotationName) {
 
     /**
      * Return true if mAnnotationTargets contains aTargetType.
+     *
      * @param targetType - type of current annotation
      * @return boolean
      */

sevntu-checks/src/main/java/com/github/sevntu/checkstyle/checks/annotation/RequiredParameterForAnnotationCheck.java

@@ -117,6 +117,7 @@ public class RequiredParameterForAnnotationCheck extends AbstractCheck {
 
     /**
      * The annotation name we are interested in.
+     *
      * @param annotationName set annotation name
      */
     public void setAnnotationName(String annotationName) {
@@ -125,6 +126,7 @@ public void setAnnotationName(String annotationName) {
 
     /**
      * The required list of parameters we have to use.
+     *
      * @param requiredPropertiesParameter set required list of parameters
      */
     public void setRequiredParameters(String... requiredPropertiesParameter) {
@@ -169,6 +171,7 @@ public void visitToken(DetailAST annotationNode) {
 
     /**
      * Returns full name of an annotation.
+     *
      * @param annotationNode The node to examine.
      * @return name of an annotation.
      */
@@ -194,6 +197,7 @@ private static String getAnnotationName(DetailAST annotationNode) {
 
     /**
      * Returns the name of annotations properties.
+     *
      * @param annotationNode The node to examine.
      * @return name of annotation properties.
      */

sevntu-checks/src/main/java/com/github/sevntu/checkstyle/checks/coding/AvoidDefaultSerializableInInnerClassesCheck.java

@@ -32,6 +32,7 @@
  * implement both methods. For more information read
  * "Effective Java (2nd edition)" chapter 11, item 74, page 294.
  * </p>
+ *
  * @author <a href="mailto:[email protected]">Ilia Dubinin</a>
  * @since 1.8.0
  */
@@ -54,6 +55,7 @@ public class AvoidDefaultSerializableInInnerClassesCheck extends AbstractCheck {
      * <p>
      * Set allow partly implementation serializable interface.
      * </p>
+     *
      * @param allow - Option, that allow partial implementation
      *        of serializable interface.
      */
@@ -94,6 +96,7 @@ public void visitToken(DetailAST detailAST) {
      * Return true if it is nested class. Terminology is here :
      * http://download.oracle.com/javase/tutorial/java/javaOO/nested.html
      * </p>
+     *
      * @param classNode - class node
      * @return - boolean variable
      */
@@ -147,6 +150,7 @@ && isVoidMethod(methodNode)
      * Return true, if methods readObject() and writeObject() have correct
      * modifiers.
      * </p>
+     *
      * @param methodNode
      *        - current method node;
      * @return boolean value;
@@ -166,6 +170,7 @@ private static boolean isPrivateMethod(DetailAST methodNode) {
      * <p>
      * Return true, if method has void type.
      * </p>
+     *
      * @param methodNode - method node
      * @return boolean variable
      */
@@ -180,6 +185,7 @@ private static boolean isVoidMethod(DetailAST methodNode) {
      * Return true, if method has correct parameters (ObjectInputStream for
      * readObject() and ObjectOutputStream for writeObject()).
      * </p>
+     *
      * @param methodNode - method node.
      * @param parameterText - correct parameter text.
      * @return boolean variable.
@@ -240,6 +246,7 @@ private final class SiblingIterator {
         * <b>
         * Children Iterator constructor.
         * </b>
+        *
         * @param parent - child parent.
         */
         /* package */ SiblingIterator(DetailAST parent) {
@@ -250,6 +257,7 @@ private final class SiblingIterator {
         * <b>
         * Return boolean value, if has next element.
         * </b>
+        *
         * @return boolean value
         */
         public boolean hasNextSibling() {
@@ -260,6 +268,7 @@ public boolean hasNextSibling() {
         * <b>
         * Return next DetailAST element.
         * </b>
+        *
         * @return next DetailAST.
         */
 

sevntu-checks/src/main/java/com/github/sevntu/checkstyle/checks/coding/AvoidHidingCauseExceptionCheck.java

@@ -60,6 +60,7 @@
  *        throw new RuntimeException("Runtime Exception!");
  *      }
  * </pre>
+ *
  * @author <a href="mailto:[email protected]"> Daniil
  *         Yaroslavtsev</a>
  * @author <a href="mailto:[email protected]">Ilja Dubinin</a>
@@ -114,6 +115,7 @@ public void visitToken(DetailAST detailAST) {
 
     /**
      * Returns true when aThrowParamNamesList contains caught exception.
+     *
      * @param throwParamNamesList List of throw parameter names.
      * @param wrapExcNames List of caught exception names.
      * @return true when aThrowParamNamesList contains caught exception
@@ -134,6 +136,7 @@ private static boolean isContainsCaughtExc(List<DetailAST> throwParamNamesList,
     /**
      * Returns a List of<code>DetailAST</code> that contains the names of
      * parameters  for current "throw" keyword.
+     *
      * @param startNode The start node for exception name searching.
      * @param paramNamesAST The list, that will be contain names of the
      *     parameters
@@ -160,6 +163,7 @@ private List<DetailAST> buildThrowParamNamesList(DetailAST startNode,
      * Recursive method which searches for the <code>LITERAL_THROW</code>
      * DetailASTs all levels below on the current <code>aParentAST</code> node
      * without entering into nested try/catch blocks.
+     *
      * @param parentAST A start node for "throw" keyword <code>DetailASTs
      * </code> searching.
      * @return null-safe list of <code>LITERAL_THROW</code> literals
@@ -184,6 +188,7 @@ private List<DetailAST> makeThrowList(DetailAST parentAST) {
     /**
      * Searches for all exceptions that wraps the original exception
      * object (only in current "catch" block).
+     *
      * @param currentCatchAST A LITERAL_CATCH node of the
      *     current "catch" block.
      * @param parentAST Current parent node to start search.
@@ -232,6 +237,7 @@ private List<String> makeExceptionsList(DetailAST currentCatchAST,
 
     /**
      * Gets all the children one level below on the current parent node.
+     *
      * @param node Current parent node.
      * @return List of children one level below on the current
      *         parent node (aNode).

sevntu-checks/src/main/java/com/github/sevntu/checkstyle/checks/coding/AvoidModifiersForTypesCheck.java

@@ -214,6 +214,7 @@ public class AvoidModifiersForTypesCheck extends AbstractCheck {
     /**
      * Sets the regexp for the names of classes, that could not have 'annotation'
      * modifier.
+     *
      * @param forbiddenClassesRegexpAnnotation
      *        String contains the regex to set for the names of classes, that
      *        could not have 'annotation' modifier.
@@ -234,6 +235,7 @@ public void setForbiddenClassesRegexpAnnotation(String forbiddenClassesRegexpAnn
     /**
      * Sets the regexp for the names of classes, that could not have 'final'
      * modifier.
+     *
      * @param forbiddenClassesRegexpFinal
      *        String contains the regex to set for the names of classes, that
      *        could not have 'final' modifier.
@@ -254,6 +256,7 @@ public void setForbiddenClassesRegexpFinal(String forbiddenClassesRegexpFinal) {
     /**
      * Sets the regexp for the names of classes, that could not have 'static'
      * modifier.
+     *
      * @param forbiddenClassesRegexpStatic
      *        String contains the regex to set for the names of classes, that
      *        could not have 'static' modifier.
@@ -274,6 +277,7 @@ public void setForbiddenClassesRegexpStatic(String forbiddenClassesRegexpStatic)
     /**
      * Sets the regexp for the names of classes, that could not have 'transient'
      * modifier.
+     *
      * @param forbiddenClassesRegexpTransient
      *        String contains the regex to set for the names of classes, that
      *        could not have 'transient' modifier.
@@ -294,6 +298,7 @@ public void setForbiddenClassesRegexpTransient(String forbiddenClassesRegexpTran
     /**
      * Sets the regexp for the names of classes, that could not have 'volatile'
      * modifier.
+     *
      * @param forbiddenClassesRegexpVolatile
      *        String contains the regex to set for the names of classes, that
      *        could not have 'volatile' modifier.
@@ -314,6 +319,7 @@ public void setForbiddenClassesRegexpVolatile(String forbiddenClassesRegexpVolat
     /**
      * Sets the regexp for the names of classes, that could not have 'private'
      * modifier.
+     *
      * @param forbiddenClassesRegexpPrivate
      *        String contains the regex to set for the names of classes, that
      *        could not have 'private' modifier.
@@ -334,6 +340,7 @@ public void setForbiddenClassesRegexpPrivate(String forbiddenClassesRegexpPrivat
     /**
      * Sets the regexp for the names of classes, that could not have no modifier
      * ('package-private').
+     *
      * @param forbiddenClassesRegexpPackagePrivate
      *        String contains the regex to set for the names of classes, that
      *        could not have no modifier ('package-private').
@@ -355,6 +362,7 @@ public void setForbiddenClassesRegexpPackagePrivate(
     /**
      * Sets the regexp for the names of classes, that could not have 'protected'
      * modifier.
+     *
      * @param forbiddenClassesRegexpProtected
      *        String contains the regex to set for the names of classes, that
      *        could not have 'protected' modifier.
@@ -375,6 +383,7 @@ public void setForbiddenClassesRegexpProtected(String forbiddenClassesRegexpProt
     /**
      * Sets the regexp for the names of classes, that could not have 'public'
      * modifier.
+     *
      * @param forbiddenClassesRegexpPublic
      *        String contains the regex to set for the names of classes, that
      *        could not have 'public' modifier.
@@ -440,6 +449,7 @@ public void visitToken(DetailAST ast) {
     /**
      * Checks whether a specific Java modifier is used in a given class with
      * the specified regular expression.
+     *
      * @param modifierType the modifier type
      * @param className the class name
      * @return either <code>true</code> if the regexp match the className,
@@ -452,6 +462,7 @@ private boolean match(int modifierType, String className) {
 
     /**
      * Maps the modifierType to a regular expression.
+     *
      * @param modifierType the modifier type
      * @return the Pattern object storing the regexp for the names of classes,
      *     that must not have the modifierType.
@@ -494,6 +505,7 @@ private Pattern mapToRegExp(int modifierType) {
 
     /**
      * Gets the full className of the defined variable.
+     *
      * @param variableDefNode
      *        A DetailAST node is related to variable definition (VARIABLE_DEF
      *        node type).
@@ -525,6 +537,7 @@ private static String getClassNameAndPath(DetailAST variableDefNode) {
 
     /**
      * Gets the class name from full (dotted) classPath.
+     *
      * @param classNameAndPath
      *        - the full (dotted) classPath. Must not be null.
      * @return the name of the class is specified by the current full name&path.
@@ -537,6 +550,7 @@ private static String getClassName(final String classNameAndPath) {
     /**
      * Gets the modifiers of the defined variable (annotation, public, private, final, static,
      * transient or volatile).
+     *
      * @param variableDefAst
      *        A DetailAST node is related to the variable definition
      *        (VARIABLE_DEF type)
@@ -556,6 +570,7 @@ private static Set<Integer> getModifiers(DetailAST variableDefAst) {
     /**
      * Gets all the children which are one level below on the current DetailAST
      * parent node.
+     *
      * @param node
      *        The parent node.
      * @return The list of children one level below on the current parent node.

sevntu-checks/src/main/java/com/github/sevntu/checkstyle/checks/coding/AvoidNotShortCircuitOperatorsForBooleanCheck.java

@@ -67,6 +67,7 @@
  *             || isModifier() && isNotTrue();
  * }
  * </pre>
+ *
  * @author <a href="mailto:[email protected]"> Daniil
  *         Yaroslavtsev</a>
  * @since 1.8.0
@@ -134,6 +135,7 @@ public final void visitToken(final DetailAST detailAST) {
     /**
      * Checks whether the current method/variable definition type
      * is "Boolean".
+     *
      * @param node - current method or variable definition node.
      * @return "true" if current method or variable has a Boolean type.
      */
@@ -145,6 +147,7 @@ private static boolean isBooleanType(final DetailAST node) {
     /**
      * Checks that current expression is calculated using "|", "&amp;", "|=", "&amp;="
      * operators contains at least one Boolean operand.
+     *
      * @param node - current TokenTypes.EXPR node to check.
      * @return "true" if current expression is calculated using "|", "&amp;",
      *     "|=". "&amp;=" operators contains at least one Boolean operand or false
@@ -190,6 +193,7 @@ && isBooleanType(currentNode)) {
      * Searches for all supported operands names in current expression.
      * When checking, treatments to external class variables, method calls,
      * etc are not considered as expression operands.
+     *
      * @param exprParentAST - the current TokenTypes.EXPR parent node.
      * @return List of supported operands contained in current expression.
      */
@@ -212,6 +216,7 @@ public final List<String> getSupportedOperandsNames(
     /**
      * Checks is the current expression has
      * keywords "true" or "false".
+     *
      * @param parentAST - the current TokenTypes.EXPR parent node.
      * @return true if the current processed expression contains
      *     "true" or "false" keywords and false otherwise.
@@ -237,6 +242,7 @@ public final boolean hasTrueOrFalseLiteral(final DetailAST parentAST) {
 
     /**
      * Gets all the children one level below on the current top node.
+     *
      * @param node - current parent node.
      * @return an array of children one level below on the current parent node
      *         aNode.

sevntu-checks/src/main/java/com/github/sevntu/checkstyle/checks/coding/ConfusingConditionCheck.java

@@ -181,6 +181,7 @@ && isConditionAllNegative(literalIf)) {
 
     /**
      * Checks if the given AST can be ignored.
+     *
      * @param literalIf The AST to check.
      * @return {@code true} if it can be ignored.
      */
@@ -286,6 +287,7 @@ private static int getAmountOfCodeRowsInBlock(DetailAST detailAST) {
 
     /**
      * Retrieves the first, opening brace of an {@code if} or {@code else} statement.
+     *
      * @param detailAST The token to examine.
      * @return The opening brace token or {@code null} if it doesn't exist.
      */