UpperEllCheck.java

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.api.AbstractCheck;
23
import com.puppycrawl.tools.checkstyle.api.DetailAST;
24
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
25
import com.puppycrawl.tools.checkstyle.utils.CommonUtils;
26
27
/**
28
 * <p>Checks that long constants are defined with an upper ell.
29
 * That is <span class="code">'L'</span> and not
30
 * <span class="code">'l'</span>. This is in accordance to the Java Language
31
 * Specification, <a href="http://docs.oracle.com/javase/specs/jls/se8/html/jls-3.html#jls-3.10.1">
32
 * Section 3.10.1</a>.
33
 * </p>
34
 * <p>
35
 * Rationale: The letter <span class="code">l</span> looks a lot
36
 * like the number <span class="code">1</span>.
37
 * </p>
38
 *
39
 * <p>Examples
40
 * <p class="body">
41
 * To configure the check:
42
 *
43
 * </p>
44
 * <pre class="body">
45
 * &lt;module name=&quot;UpperEll&quot;/&gt;
46
 * </pre>
47
 *
48
 * @author Oliver Burn
49
 */
50
public class UpperEllCheck extends AbstractCheck {
51
52
    /**
53
     * A key is pointing to the warning message text in "messages.properties"
54
     * file.
55
     */
56
    public static final String MSG_KEY = "upperEll";
57
58
    @Override
59
    public int[] getDefaultTokens() {
60 1 1. getDefaultTokens : mutated return of Object value for com/puppycrawl/tools/checkstyle/checks/UpperEllCheck::getDefaultTokens to ( if (x != null) null else throw new RuntimeException ) → KILLED
        return getAcceptableTokens();
61
    }
62
63
    @Override
64
    public int[] getAcceptableTokens() {
65 1 1. getAcceptableTokens : mutated return of Object value for com/puppycrawl/tools/checkstyle/checks/UpperEllCheck::getAcceptableTokens to ( if (x != null) null else throw new RuntimeException ) → KILLED
        return new int[] {TokenTypes.NUM_LONG};
66
    }
67
68
    @Override
69
    public int[] getRequiredTokens() {
70 1 1. getRequiredTokens : mutated return of Object value for com/puppycrawl/tools/checkstyle/checks/UpperEllCheck::getRequiredTokens to ( if (x != null) null else throw new RuntimeException ) → KILLED
        return getAcceptableTokens();
71
    }
72
73
    @Override
74
    public void visitToken(DetailAST ast) {
75 1 1. visitToken : negated conditional → KILLED
        if (CommonUtils.endsWithChar(ast.getText(), 'l')) {
76 1 1. visitToken : removed call to com/puppycrawl/tools/checkstyle/checks/UpperEllCheck::log → KILLED
            log(ast.getLineNo(),
77 2 1. visitToken : Replaced integer addition with subtraction → KILLED
2. visitToken : Replaced integer subtraction with addition → KILLED
                ast.getColumnNo() + ast.getText().length() - 1,
78
                MSG_KEY);
79
        }
80
    }
81
}

Mutations

60

1.1
Location : getDefaultTokens
Killed by : com.puppycrawl.tools.checkstyle.checks.UpperEllCheckTest.testWithChecker(com.puppycrawl.tools.checkstyle.checks.UpperEllCheckTest)
mutated return of Object value for com/puppycrawl/tools/checkstyle/checks/UpperEllCheck::getDefaultTokens to ( if (x != null) null else throw new RuntimeException ) → KILLED

65

1.1
Location : getAcceptableTokens
Killed by : com.puppycrawl.tools.checkstyle.checks.UpperEllCheckTest.testGetRequiredTokens(com.puppycrawl.tools.checkstyle.checks.UpperEllCheckTest)
mutated return of Object value for com/puppycrawl/tools/checkstyle/checks/UpperEllCheck::getAcceptableTokens to ( if (x != null) null else throw new RuntimeException ) → KILLED

70

1.1
Location : getRequiredTokens
Killed by : com.puppycrawl.tools.checkstyle.checks.UpperEllCheckTest.testGetRequiredTokens(com.puppycrawl.tools.checkstyle.checks.UpperEllCheckTest)
mutated return of Object value for com/puppycrawl/tools/checkstyle/checks/UpperEllCheck::getRequiredTokens to ( if (x != null) null else throw new RuntimeException ) → KILLED

75

1.1
Location : visitToken
Killed by : com.puppycrawl.tools.checkstyle.checks.UpperEllCheckTest.testWithChecker(com.puppycrawl.tools.checkstyle.checks.UpperEllCheckTest)
negated conditional → KILLED

76

1.1
Location : visitToken
Killed by : com.puppycrawl.tools.checkstyle.checks.UpperEllCheckTest.testWithChecker(com.puppycrawl.tools.checkstyle.checks.UpperEllCheckTest)
removed call to com/puppycrawl/tools/checkstyle/checks/UpperEllCheck::log → KILLED

77

1.1
Location : visitToken
Killed by : com.puppycrawl.tools.checkstyle.checks.UpperEllCheckTest.testWithChecker(com.puppycrawl.tools.checkstyle.checks.UpperEllCheckTest)
Replaced integer addition with subtraction → KILLED

2.2
Location : visitToken
Killed by : com.puppycrawl.tools.checkstyle.checks.UpperEllCheckTest.testWithChecker(com.puppycrawl.tools.checkstyle.checks.UpperEllCheckTest)
Replaced integer subtraction with addition → KILLED

Active mutators

Tests examined


Report generated by PIT 1.2.2