
com.puppycrawl.tools.checkstyle.checks.coding.MissingSwitchDefaultCheck Maven / Gradle / Ivy
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2015 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.checks.coding;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Checks that switch statement has "default" clause.
*
*
* Rationale: It's usually a good idea to introduce a
* default case in every switch statement. Even if
* the developer is sure that all currently possible
* cases are covered, this should be expressed in the
* default branch, e.g. by using an assertion. This way
* the code is protected against later changes, e.g.
* introduction of new types in an enumeration type.
*
*
* An example of how to configure the check is:
*
*
* <module name="MissingSwitchDefault"/>
*
* @author o_sukhodolsky
*/
public class MissingSwitchDefaultCheck extends Check {
/**
* A key is pointing to the warning message text in "messages.properties"
* file.
*/
public static final String MSG_KEY = "missing.switch.default";
@Override
public int[] getDefaultTokens() {
return new int[] {TokenTypes.LITERAL_SWITCH};
}
@Override
public int[] getAcceptableTokens() {
return getDefaultTokens();
}
@Override
public int[] getRequiredTokens() {
return getDefaultTokens();
}
@Override
public void visitToken(DetailAST ast) {
final DetailAST firstCaseGroupAst = ast.findFirstToken(TokenTypes.CASE_GROUP);
if (!containsDefaultSwitch(firstCaseGroupAst)) {
log(ast.getLineNo(), MSG_KEY);
}
}
/**
* Checks if the case group or its sibling contain the 'default' switch.
* @param caseGroupAst first case group to check.
* @return true if 'default' switch found.
*/
private static boolean containsDefaultSwitch(DetailAST caseGroupAst) {
DetailAST nextAst = caseGroupAst;
boolean found = false;
while (nextAst != null) {
if (nextAst.findFirstToken(TokenTypes.LITERAL_DEFAULT) != null) {
found = true;
break;
}
nextAst = nextAst.getNextSibling();
}
return found;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy