TypeNameCheck.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.TokenTypes;
23
import com.puppycrawl.tools.checkstyle.utils.CommonUtils;
24
25
/**
26
 * <p>
27
 * Checks that type names conform to a format specified
28
 * by the format property. The format is a
29
 * {@link java.util.regex.Pattern regular expression} and defaults to
30
 * <strong>^[A-Z][a-zA-Z0-9]*$</strong>.
31
 * </p>
32
 * <p>
33
 * An example of how to configure the check is:
34
 * </p>
35
 * <pre>
36
 * &lt;module name="TypeName"/&gt;
37
 * </pre>
38
 * <p>
39
 * An example of how to configure the check for names that begin with
40
 * a lower case letter, followed by letters, digits, and underscores is:
41
 * </p>
42
 * <pre>
43
 * &lt;module name="TypeName"&gt;
44
 *    &lt;property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/&gt;
45
 * &lt;/module&gt;
46
 * </pre>
47
 * @author Oliver Burn
48
 */
49
public class TypeNameCheck
50
    extends AbstractAccessControlNameCheck {
51
52
    /**
53
     * Default pattern for type name.
54
     */
55
    public static final String DEFAULT_PATTERN = "^[A-Z][a-zA-Z0-9]*$";
56
57
    /**
58
     * Creates a new {@code TypeNameCheck} instance.
59
     */
60
    public TypeNameCheck() {
61
        super(DEFAULT_PATTERN);
62
    }
63
64
    @Override
65
    public int[] getDefaultTokens() {
66 1 1. getDefaultTokens : mutated return of Object value for com/puppycrawl/tools/checkstyle/checks/naming/TypeNameCheck::getDefaultTokens to ( if (x != null) null else throw new RuntimeException ) → KILLED
        return getAcceptableTokens();
67
    }
68
69
    @Override
70
    public int[] getAcceptableTokens() {
71 1 1. getAcceptableTokens : mutated return of Object value for com/puppycrawl/tools/checkstyle/checks/naming/TypeNameCheck::getAcceptableTokens to ( if (x != null) null else throw new RuntimeException ) → KILLED
        return new int[] {TokenTypes.CLASS_DEF,
72
                          TokenTypes.INTERFACE_DEF,
73
                          TokenTypes.ENUM_DEF,
74
                          TokenTypes.ANNOTATION_DEF,
75
        };
76
    }
77
78
    @Override
79
    public int[] getRequiredTokens() {
80 1 1. getRequiredTokens : mutated return of Object value for com/puppycrawl/tools/checkstyle/checks/naming/TypeNameCheck::getRequiredTokens to ( if (x != null) null else throw new RuntimeException ) → KILLED
        return CommonUtils.EMPTY_INT_ARRAY;
81
    }
82
83
}

Mutations

66

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

71

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

80

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

Active mutators

Tests examined


Report generated by PIT 1.3.1