StaticVariableNameCheck.java

1
////////////////////////////////////////////////////////////////////////////////
2
// checkstyle: Checks Java source code for adherence to a set of rules.
3
// Copyright (C) 2001-2018 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.naming;
21
22
import com.puppycrawl.tools.checkstyle.api.DetailAST;
23
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
24
import com.puppycrawl.tools.checkstyle.utils.ScopeUtils;
25
26
/**
27
 * <p>
28
 * Checks that static, non-final variable names conform to a format specified
29
 * by the format property. The format is a
30
 * {@link java.util.regex.Pattern regular expression} and defaults to
31
 * <strong>^[a-z][a-zA-Z0-9]*$</strong>.
32
 * </p>
33
 * <p>
34
 * An example of how to configure the check is:
35
 * </p>
36
 * <pre>
37
 * &lt;module name="StaticVariableName"/&gt;
38
 * </pre>
39
 * <p>
40
 * An example of how to configure the check for names that begin with
41
 * a lower case letter, followed by letters, digits, and underscores is:
42
 * </p>
43
 * <pre>
44
 * &lt;module name="StaticVariableName"&gt;
45
 *    &lt;property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/&gt;
46
 * &lt;/module&gt;
47
 * </pre>
48
 * @author Rick Giles
49
 */
50
public class StaticVariableNameCheck
51
    extends AbstractAccessControlNameCheck {
52
53
    /** Creates a new {@code StaticVariableNameCheck} instance. */
54
    public StaticVariableNameCheck() {
55
        super("^[a-z][a-zA-Z0-9]*$");
56
    }
57
58
    @Override
59
    public int[] getDefaultTokens() {
60 1 1. getDefaultTokens : mutated return of Object value for com/puppycrawl/tools/checkstyle/checks/naming/StaticVariableNameCheck::getDefaultTokens to ( if (x != null) null else throw new RuntimeException ) → KILLED
        return getRequiredTokens();
61
    }
62
63
    @Override
64
    public int[] getAcceptableTokens() {
65 1 1. getAcceptableTokens : mutated return of Object value for com/puppycrawl/tools/checkstyle/checks/naming/StaticVariableNameCheck::getAcceptableTokens to ( if (x != null) null else throw new RuntimeException ) → KILLED
        return getRequiredTokens();
66
    }
67
68
    @Override
69
    public int[] getRequiredTokens() {
70 1 1. getRequiredTokens : mutated return of Object value for com/puppycrawl/tools/checkstyle/checks/naming/StaticVariableNameCheck::getRequiredTokens to ( if (x != null) null else throw new RuntimeException ) → KILLED
        return new int[] {TokenTypes.VARIABLE_DEF};
71
    }
72
73
    @Override
74
    protected final boolean mustCheckName(DetailAST ast) {
75
        final DetailAST modifiersAST =
76
            ast.findFirstToken(TokenTypes.MODIFIERS);
77 1 1. mustCheckName : negated conditional → KILLED
        final boolean isStatic = modifiersAST.findFirstToken(TokenTypes.LITERAL_STATIC) != null;
78 1 1. mustCheckName : negated conditional → KILLED
        final boolean isFinal = modifiersAST.findFirstToken(TokenTypes.FINAL) != null;
79
80 3 1. mustCheckName : negated conditional → KILLED
2. mustCheckName : negated conditional → KILLED
3. mustCheckName : replaced return of integer sized value with (x == 0 ? 1 : 0) → KILLED
        return isStatic
81
                && !isFinal
82 1 1. mustCheckName : negated conditional → KILLED
                && shouldCheckInScope(modifiersAST)
83 1 1. mustCheckName : negated conditional → KILLED
                && !ScopeUtils.isInInterfaceOrAnnotationBlock(ast);
84
    }
85
86
}

Mutations

60

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

65

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

70

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

77

1.1
Location : mustCheckName
Killed by : com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheckTest.testSpecified(com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheckTest)
negated conditional → KILLED

78

1.1
Location : mustCheckName
Killed by : com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheckTest.testSpecified(com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheckTest)
negated conditional → KILLED

80

1.1
Location : mustCheckName
Killed by : com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheckTest.testSpecified(com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheckTest)
negated conditional → KILLED

2.2
Location : mustCheckName
Killed by : com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheckTest.testSpecified(com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheckTest)
negated conditional → KILLED

3.3
Location : mustCheckName
Killed by : com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheckTest.testInterfaceOrAnnotationBlock(com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheckTest)
replaced return of integer sized value with (x == 0 ? 1 : 0) → KILLED

82

1.1
Location : mustCheckName
Killed by : com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheckTest.testSpecified(com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheckTest)
negated conditional → KILLED

83

1.1
Location : mustCheckName
Killed by : com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheckTest.testInterfaceOrAnnotationBlock(com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheckTest)
negated conditional → KILLED

Active mutators

Tests examined


Report generated by PIT 1.3.1