com.liferay.source.formatter.checkstyle.checks.FullyQualifiedNameCheck 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.source.formatter.checkstyle.util.DetailASTUtil;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import java.util.List;
/**
* @author Hugo Huijser
*/
public class FullyQualifiedNameCheck extends BaseCheck {
@Override
public int[] getDefaultTokens() {
return new int[] {
TokenTypes.CLASS_DEF, TokenTypes.ENUM_DEF, TokenTypes.INTERFACE_DEF
};
}
@Override
protected void doVisitToken(DetailAST detailAST) {
DetailAST parentAST = detailAST.getParent();
if (parentAST != null) {
return;
}
List nameASTList = DetailASTUtil.getAllChildTokens(
detailAST, true, TokenTypes.IDENT);
for (DetailAST nameAST : nameASTList) {
String name = nameAST.getText();
String fullyQualifiedName = _getFullyQualifiedName(nameAST, name);
if ((fullyQualifiedName == null) ||
fullyQualifiedName.matches(".*\\.upgrade\\.v[0-9_]+\\.\\w+")) {
continue;
}
if (!_isFullyQualifiedNameRequired(
detailAST, fullyQualifiedName, name, nameASTList)) {
log(
nameAST.getLineNo(), _MSG_USE_IMPORT_STATEMENT,
fullyQualifiedName);
}
}
}
private boolean _containsImport(DetailAST rootDetailAST, String className) {
DetailAST siblingAST = rootDetailAST;
while (true) {
siblingAST = siblingAST.getPreviousSibling();
if (siblingAST == null) {
return false;
}
if ((siblingAST.getType() != TokenTypes.IMPORT) &&
(siblingAST.getType() != TokenTypes.STATIC_IMPORT)) {
continue;
}
DetailAST dotAST = siblingAST.findFirstToken(TokenTypes.DOT);
if (dotAST == null) {
continue;
}
FullIdent fullIdent = FullIdent.createFullIdent(dotAST);
String importName = fullIdent.getText();
if (((siblingAST.getType() == TokenTypes.IMPORT) &&
importName.endsWith("." + className)) ||
((siblingAST.getType() == TokenTypes.STATIC_IMPORT) &&
importName.contains("." + className + "."))) {
return true;
}
}
}
private String _getFullyQualifiedName(DetailAST nameAST, String name) {
if (!name.matches("[A-Z][A-Za-z0-9]+")) {
return null;
}
DetailAST parentAST = nameAST.getParent();
if (parentAST.getType() != TokenTypes.DOT) {
return null;
}
FullIdent fullIdent = FullIdent.createFullIdent(parentAST);
String fullyQualifiedName = fullIdent.getText();
if (fullyQualifiedName.matches("([a-z]\\w*\\.){2,}[A-Z]\\w*")) {
return fullyQualifiedName;
}
return null;
}
private boolean _isFullyQualifiedNameRequired(
DetailAST rootDetailAST, String fullyQualifiedName, String className,
List nameASTList) {
if (_containsImport(rootDetailAST, className)) {
return true;
}
for (DetailAST nameAST : nameASTList) {
String name = nameAST.getText();
if (!name.equals(className)) {
continue;
}
String curFullyQualifiedName = _getFullyQualifiedName(
nameAST, name);
if ((curFullyQualifiedName == null) ||
!curFullyQualifiedName.equals(fullyQualifiedName)) {
return true;
}
}
return false;
}
private static final String _MSG_USE_IMPORT_STATEMENT =
"import.statement.use";
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy