com.liferay.source.formatter.checkstyle.checks.MethodNameCheck Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* 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.
*/
package com.liferay.source.formatter.checkstyle.checks;
import com.liferay.portal.kernel.util.StringUtil;
import com.liferay.source.formatter.checkstyle.util.DetailASTUtil;
import com.liferay.source.formatter.util.DebugUtil;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.utils.AnnotationUtility;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* @author Hugo Huijser
*/
public class MethodNameCheck
extends com.puppycrawl.tools.checkstyle.checks.naming.MethodNameCheck {
public void setCheckDoMethodName(boolean checkDoMethodName) {
_checkDoMethodName = checkDoMethodName;
}
public void setEnabled(boolean enabled) {
_enabled = enabled;
}
public void setShowDebugInformation(boolean showDebugInformation) {
_showDebugInformation = showDebugInformation;
}
@Override
public void visitToken(DetailAST detailAST) {
if (!_enabled) {
return;
}
if (!_showDebugInformation) {
_checkMethodName(detailAST);
return;
}
long startTime = System.currentTimeMillis();
_checkMethodName(detailAST);
long endTime = System.currentTimeMillis();
Class> clazz = getClass();
DebugUtil.increaseProcessingTime(
clazz.getSimpleName(), endTime - startTime);
}
@Override
protected boolean mustCheckName(DetailAST detailAST) {
if (AnnotationUtility.containsAnnotation(detailAST, "Reference")) {
return false;
}
DetailAST modifiersAST = detailAST.findFirstToken(TokenTypes.MODIFIERS);
return shouldCheckInScope(modifiersAST);
}
private void _checkDoMethodName(DetailAST detailAST) {
String name = _getMethodName(detailAST);
Matcher matcher = _doMethodNamePattern.matcher(name);
if (!matcher.find()) {
return;
}
String noDoName =
"_" + StringUtil.toLowerCase(matcher.group(1)) + matcher.group(2);
String noUnderscoreName = name.substring(1);
DetailAST parentAST = detailAST.getParent();
List methodDefASTList = DetailASTUtil.getAllChildTokens(
parentAST, false, TokenTypes.METHOD_DEF);
for (DetailAST methodDefAST : methodDefASTList) {
String methodName = _getMethodName(methodDefAST);
if (methodName.equals(noDoName) ||
methodName.equals(noUnderscoreName)) {
return;
}
}
log(detailAST.getLineNo(), _MSG_RENAME_METHOD, name, noDoName);
}
private void _checkMethodName(DetailAST detailAST) {
if (_checkDoMethodName) {
_checkDoMethodName(detailAST);
}
super.visitToken(detailAST);
}
private String _getMethodName(DetailAST detailAST) {
DetailAST nameAST = detailAST.findFirstToken(TokenTypes.IDENT);
return nameAST.getText();
}
private static final String _MSG_RENAME_METHOD = "method.rename";
private boolean _checkDoMethodName;
private final Pattern _doMethodNamePattern = Pattern.compile(
"^_do([A-Z])(.*)$");
private boolean _enabled = true;
private boolean _showDebugInformation;
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy