Coverage Report - com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck
 
Classes in this File Line Coverage Branch Coverage Complexity
ArrayTypeStyleCheck
100%
18/18
100%
12/12
2
 
 1  
 ////////////////////////////////////////////////////////////////////////////////
 2  
 // checkstyle: Checks Java source code for adherence to a set of rules.
 3  
 // Copyright (C) 2001-2017 the original author or authors.
 4  
 //
 5  
 // This library is free software; you can redistribute it and/or
 6  
 // modify it under the terms of the GNU Lesser General Public
 7  
 // License as published by the Free Software Foundation; either
 8  
 // version 2.1 of the License, or (at your option) any later version.
 9  
 //
 10  
 // This library is distributed in the hope that it will be useful,
 11  
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
 12  
 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 13  
 // Lesser General Public License for more details.
 14  
 //
 15  
 // You should have received a copy of the GNU Lesser General Public
 16  
 // License along with this library; if not, write to the Free Software
 17  
 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 18  
 ////////////////////////////////////////////////////////////////////////////////
 19  
 
 20  
 package com.puppycrawl.tools.checkstyle.checks;
 21  
 
 22  
 import com.puppycrawl.tools.checkstyle.StatelessCheck;
 23  
 import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
 24  
 import com.puppycrawl.tools.checkstyle.api.DetailAST;
 25  
 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
 26  
 
 27  
 /**
 28  
  * Checks the style of array type definitions.
 29  
  * Some like Java-style: {@code public static void main(String[] args)}
 30  
  * and some like C-style: public static void main(String args[])
 31  
  *
 32  
  * <p>By default the Check enforces Java style.
 33  
  * @author lkuehne
 34  
  */
 35  
 @StatelessCheck
 36  14
 public class ArrayTypeStyleCheck extends AbstractCheck {
 37  
     /**
 38  
      * A key is pointing to the warning message text in "messages.properties"
 39  
      * file.
 40  
      */
 41  
     public static final String MSG_KEY = "array.type.style";
 42  
 
 43  
     /** Controls whether to use Java or C style. */
 44  14
     private boolean javaStyle = true;
 45  
 
 46  
     @Override
 47  
     public int[] getDefaultTokens() {
 48  17
         return getRequiredTokens();
 49  
     }
 50  
 
 51  
     @Override
 52  
     public int[] getAcceptableTokens() {
 53  6
         return getRequiredTokens();
 54  
     }
 55  
 
 56  
     @Override
 57  
     public int[] getRequiredTokens() {
 58  41
         return new int[] {TokenTypes.ARRAY_DECLARATOR};
 59  
     }
 60  
 
 61  
     @Override
 62  
     public void visitToken(DetailAST ast) {
 63  32
         final DetailAST typeAST = ast.getParent();
 64  32
         if (typeAST.getType() == TokenTypes.TYPE
 65  
                 // Do not check method's return type.
 66  
                 // We have no alternatives here.
 67  24
                 && typeAST.getParent().getType() != TokenTypes.METHOD_DEF) {
 68  20
             final DetailAST variableAST = typeAST.getNextSibling();
 69  20
             if (variableAST != null) {
 70  14
                 final boolean isJavaStyle =
 71  14
                     variableAST.getLineNo() > ast.getLineNo()
 72  12
                     || variableAST.getColumnNo() - ast.getColumnNo() > -1;
 73  
 
 74  14
                 if (isJavaStyle != javaStyle) {
 75  7
                     log(ast.getLineNo(), ast.getColumnNo(), MSG_KEY);
 76  
                 }
 77  
             }
 78  
         }
 79  32
     }
 80  
 
 81  
     /**
 82  
      * Controls whether to check for Java or C style.
 83  
      * @param javaStyle true if Java style should be used.
 84  
      */
 85  
     public void setJavaStyle(boolean javaStyle) {
 86  2
         this.javaStyle = javaStyle;
 87  2
     }
 88  
 }