com.liferay.source.formatter.checkstyle.check.StringBundlerNamingCheck Maven / Gradle / Ivy
/**
* SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
* SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
*/
package com.liferay.source.formatter.checkstyle.check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* @author Hugo Huijser
*/
public class StringBundlerNamingCheck extends BaseCheck {
@Override
public int[] getDefaultTokens() {
return new int[] {TokenTypes.PARAMETER_DEF, TokenTypes.VARIABLE_DEF};
}
@Override
protected void doVisitToken(DetailAST detailAST) {
String typeName = getTypeName(detailAST, false);
if (!typeName.equals("StringBundler")) {
return;
}
DetailAST modifiersDetailAST = detailAST.findFirstToken(
TokenTypes.MODIFIERS);
if (modifiersDetailAST.branchContains(TokenTypes.LITERAL_PROTECTED) ||
modifiersDetailAST.branchContains(TokenTypes.LITERAL_PUBLIC)) {
return;
}
String name = getName(detailAST);
if (!name.matches("_?(sb|.*SB)([0-9]*)?")) {
log(
detailAST, _MSG_INCORRECT_VARIABLE_NAME,
_getTokenTypeName(detailAST), name);
}
}
private String _getTokenTypeName(DetailAST detailAST) {
if (detailAST.getType() == TokenTypes.PARAMETER_DEF) {
return "parameter";
}
return "variable";
}
private static final String _MSG_INCORRECT_VARIABLE_NAME =
"variable.name.incorrect";
}