Clover Coverage Report - Checkstyle
Coverage timestamp: Fri May 9 2008 10:48:13 EST
Overview   Package   File
    FRAMES   NO FRAMES     
../../../../../../img/srcFileCovDistChart8.png 75% of files have more coverage
16   208   12   4
8   108   0.75   4
4     3  
1    
 
  OperatorWrapCheck       Line # 91 78.6% 0.78571427
13.42 16 12 12 0.75
 
  (3)
 
1    ////////////////////////////////////////////////////////////////////////////////
2    // checkstyle: Checks Java source code for adherence to a set of rules.
3    // Copyright (C) 2001-2005 Oliver Burn
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.whitespace;
21   
22    import com.puppycrawl.tools.checkstyle.api.DetailAST;
23    import com.puppycrawl.tools.checkstyle.api.TokenTypes;
24    import com.puppycrawl.tools.checkstyle.api.Utils;
25    import com.puppycrawl.tools.checkstyle.checks.AbstractOption;
26    import com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck;
27   
28    /**
29    * <p>
30    * Checks line wrapping for operators.
31    * The policy to verify is specified using the {@link OperatorWrapOption} class
32    * and defaults to {@link OperatorWrapOption#NL}.
33    * </p>
34    * <p> By default the check will check the following operators:
35    * {@link TokenTypes#BAND BAND},
36    * {@link TokenTypes#BOR BOR},
37    * {@link TokenTypes#BSR BSR},
38    * {@link TokenTypes#BXOR BXOR},
39    * {@link TokenTypes#COLON COLON},
40    * {@link TokenTypes#DIV DIV},
41    * {@link TokenTypes#EQUAL EQUAL},
42    * {@link TokenTypes#GE GE},
43    * {@link TokenTypes#GT GT},
44    * {@link TokenTypes#LAND LAND},
45    * {@link TokenTypes#LE LE},
46    * {@link TokenTypes#LITERAL_INSTANCEOF LITERAL_INSTANCEOF},
47    * {@link TokenTypes#LOR LOR},
48    * {@link TokenTypes#LT LT},
49    * {@link TokenTypes#MINUS MINUS},
50    * {@link TokenTypes#MOD MOD},
51    * {@link TokenTypes#NOT_EQUAL NOT_EQUAL},
52    * {@link TokenTypes#PLUS PLUS},
53    * {@link TokenTypes#QUESTION QUESTION},
54    * {@link TokenTypes#SL SL},
55    * {@link TokenTypes#SR SR},
56    * {@link TokenTypes#STAR STAR}.
57    * Other acceptable tokens are
58    * {@link TokenTypes#ASSIGN ASSIGN},
59    * {@link TokenTypes#BAND_ASSIGN BAND_ASSIGN},
60    * {@link TokenTypes#BOR_ASSIGN BOR_ASSIGN},
61    * {@link TokenTypes#BSR_ASSIGN BSR_ASSIGN},
62    * {@link TokenTypes#BXOR_ASSIGN BXOR_ASSIGN},
63    * {@link TokenTypes#DIV_ASSIGN DIV_ASSIGN},
64    * {@link TokenTypes#MINUS_ASSIGN MINUS_ASSIGN},
65    * {@link TokenTypes#MOD_ASSIGN MOD_ASSIGN},
66    * {@link TokenTypes#PLUS_ASSIGN PLUS_ASSIGN},
67    * {@link TokenTypes#SL_ASSIGN SL_ASSIGN},
68    * {@link TokenTypes#SR_ASSIGN SR_ASSIGN},
69    * {@link TokenTypes#STAR_ASSIGN STAR_ASSIGN}.
70    * </p>
71    * <p>
72    * An example of how to configure the check is:
73    * </p>
74    * <pre>
75    * &lt;module name="OperatorWrap"/&gt;
76    * </pre>
77    * <p> An example of how to configure the check for assignment operators at the
78    * end of a line is:
79    * </p>
80    * <pre>
81    * &lt;module name="OperatorWrap"&gt;
82    * &lt;property name="tokens"
83    * value="ASSIGN,DIV_ASSIGN,PLUS_ASSIGN,MINUS_ASSIGN,STAR_ASSIGN,MOD_ASSIGN,SR_ASSIGN,BSR_ASSIGN,SL_ASSIGN,BXOR_ASSIGN,BOR_ASSIGN,BAND_ASSIGN"/&gt;
84    * &lt;property name="option" value="eol"/&gt;
85    * &lt;/module&gt;
86    * </pre>
87    *
88    * @author Rick Giles
89    * @version 1.0
90    */
 
91    public class OperatorWrapCheck
92    extends AbstractOptionCheck
93    {
94    /**
95    * Sets the operator wrap option to new line.
96    */
 
97  3 toggle public OperatorWrapCheck()
98    {
99  3 super(OperatorWrapOption.NL);
100    }
101   
102    /** {@inheritDoc} */
 
103  2 toggle public int[] getDefaultTokens()
104    {
105  2 return new int[] {
106    TokenTypes.QUESTION, // '?'
107    TokenTypes.COLON, // ':' (not reported for a case)
108    TokenTypes.EQUAL, // "=="
109    TokenTypes.NOT_EQUAL, // "!="
110    TokenTypes.DIV, // '/'
111    TokenTypes.PLUS, //' +' (unary plus is UNARY_PLUS)
112    TokenTypes.MINUS, // '-' (unary minus is UNARY_MINUS)
113    TokenTypes.STAR, // '*'
114    TokenTypes.MOD, // '%'
115    TokenTypes.SR, // ">>"
116    TokenTypes.BSR, // ">>>"
117    TokenTypes.GE, // ">="
118    TokenTypes.GT, // ">"
119    TokenTypes.SL, // "<<"
120    TokenTypes.LE, // "<="
121    TokenTypes.LT, // '<'
122    TokenTypes.BXOR, // '^'
123    TokenTypes.BOR, // '|'
124    TokenTypes.LOR, // "||"
125    TokenTypes.BAND, // '&'
126    TokenTypes.LAND, // "&&"
127    TokenTypes.LITERAL_INSTANCEOF,
128    };
129    }
130   
131    /** {@inheritDoc} */
 
132  1 toggle public int[] getAcceptableTokens()
133    {
134  1 return new int[] {
135    TokenTypes.QUESTION, // '?'
136    TokenTypes.COLON, // ':' (not reported for a case)
137    TokenTypes.EQUAL, // "=="
138    TokenTypes.NOT_EQUAL, // "!="
139    TokenTypes.DIV, // '/'
140    TokenTypes.PLUS, //' +' (unary plus is UNARY_PLUS)
141    TokenTypes.MINUS, // '-' (unary minus is UNARY_MINUS)
142    TokenTypes.STAR, // '*'
143    TokenTypes.MOD, // '%'
144    TokenTypes.SR, // ">>"
145    TokenTypes.BSR, // ">>>"
146    TokenTypes.GE, // ">="
147    TokenTypes.GT, // ">"
148    TokenTypes.SL, // "<<"
149    TokenTypes.LE, // "<="
150    TokenTypes.LT, // '<'
151    TokenTypes.BXOR, // '^'
152    TokenTypes.BOR, // '|'
153    TokenTypes.LOR, // "||"
154    TokenTypes.BAND, // '&'
155    TokenTypes.LAND, // "&&"
156    TokenTypes.LITERAL_INSTANCEOF,
157    TokenTypes.ASSIGN, // '='
158    TokenTypes.DIV_ASSIGN, // "/="
159    TokenTypes.PLUS_ASSIGN, // "+="
160    TokenTypes.MINUS_ASSIGN, //"-="
161    TokenTypes.STAR_ASSIGN, // "*="
162    TokenTypes.MOD_ASSIGN, // "%="
163    TokenTypes.SR_ASSIGN, // ">>="
164    TokenTypes.BSR_ASSIGN, // ">>>="
165    TokenTypes.SL_ASSIGN, // "<<="
166    TokenTypes.BXOR_ASSIGN, // "^="
167    TokenTypes.BOR_ASSIGN, // "|="
168    TokenTypes.BAND_ASSIGN, // "&="
169   
170    };
171    }
172    /** {@inheritDoc} */
 
173  22 toggle public void visitToken(DetailAST aAST)
174    {
175  22 if (aAST.getType() == TokenTypes.COLON) {
176  0 final DetailAST parent = aAST.getParent();
177  0 if ((parent.getType() == TokenTypes.LITERAL_DEFAULT)
178    || (parent.getType() == TokenTypes.LITERAL_CASE))
179    {
180    //we do not want to check colon for cases and defaults
181  0 return;
182    }
183    }
184  22 final AbstractOption wOp = getAbstractOption();
185   
186  22 final String text = aAST.getText();
187  22 final int colNo = aAST.getColumnNo();
188  22 final int lineNo = aAST.getLineNo();
189  22 final String currentLine = getLines()[lineNo - 1];
190   
191    // TODO: Handle comments before and after operator
192    // Check if rest of line is whitespace, and not just the operator
193    // by itself. This last bit is to handle the operator on a line by
194    // itself.
195  22 if ((wOp == OperatorWrapOption.NL)
196    && !text.equals(currentLine.trim())
197    && (currentLine.substring(colNo + text.length())
198    .trim().length() == 0))
199    {
200