org.sonar.java.ast.visitors.SuppressWarningsAnnotationUtils Maven / Gradle / Ivy
/*
* SonarQube Java
* Copyright (C) 2012 SonarSource
* [email protected]
*
* This program 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 3 of the License, or (at your option) any later version.
*
* This program 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 program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02
*/
package org.sonar.java.ast.visitors;
import com.sonar.sslr.api.AstNode;
import com.sonar.sslr.api.Token;
import org.sonar.java.ast.api.JavaTokenType;
import org.sonar.java.ast.parser.JavaGrammar;
public class SuppressWarningsAnnotationUtils {
private SuppressWarningsAnnotationUtils() {
}
private static final String SUPPRESS_WARNINGS_ANNOTATION_NAME = "SuppressWarnings";
private static final String SUPPRESS_WARNINGS_ANNOTATION_FQ_NAME = "java.lang." + SUPPRESS_WARNINGS_ANNOTATION_NAME;
private static final String VALUE = "\"all\"";
public static boolean isSuppressAllWarnings(AstNode astNode) {
if (astNode.is(JavaGrammar.CLASS_DECLARATION, JavaGrammar.INTERFACE_DECLARATION, JavaGrammar.ENUM_DECLARATION, JavaGrammar.ANNOTATION_TYPE_DECLARATION)) {
AstNode modifierNode = astNode.getPreviousAstNode();
while (modifierNode != null && modifierNode.is(JavaGrammar.MODIFIER)) {
if (isAnnotationSupressAllWarnings(modifierNode)) {
return true;
}
modifierNode = modifierNode.getPreviousAstNode();
}
return false;
}
final AstNode node;
if (astNode.is(JavaGrammar.METHOD_DECLARATOR_REST, JavaGrammar.VOID_METHOD_DECLARATOR_REST, JavaGrammar.CONSTRUCTOR_DECLARATOR_REST)) {
node = astNode.getFirstAncestor(JavaGrammar.CLASS_BODY_DECLARATION);
} else if (astNode.is(JavaGrammar.INTERFACE_METHOD_DECLARATOR_REST, JavaGrammar.VOID_INTERFACE_METHOD_DECLARATORS_REST)) {
node = astNode.getFirstAncestor(JavaGrammar.INTERFACE_BODY_DECLARATION);
} else if (astNode.is(JavaGrammar.ANNOTATION_METHOD_REST)) {
node = astNode.getFirstAncestor(JavaGrammar.ANNOTATION_TYPE_ELEMENT_DECLARATION);
} else {
throw new IllegalArgumentException("Unexpected AstNodeType: " + astNode.getType());
}
for (AstNode modifierNode : node.getChildren(JavaGrammar.MODIFIER)) {
if (isAnnotationSupressAllWarnings(modifierNode)) {
return true;
}
}
return false;
}
private static boolean isAnnotationSupressAllWarnings(AstNode modifierNode) {
AstNode annotationNode = modifierNode.getFirstChild();
if (annotationNode.is(JavaGrammar.ANNOTATION)) {
String name = getAnnotationName(annotationNode);
if (SUPPRESS_WARNINGS_ANNOTATION_NAME.equals(name) || SUPPRESS_WARNINGS_ANNOTATION_FQ_NAME.equals(name)) {
for (AstNode valueNode : annotationNode.getDescendants(JavaTokenType.LITERAL)) {
if (VALUE.equals(valueNode.getTokenValue())) {
return true;
}
}
}
}
return false;
}
private static String getAnnotationName(AstNode astNode) {
StringBuilder sb = new StringBuilder();
for (Token token : astNode.getFirstChild(JavaGrammar.QUALIFIED_IDENTIFIER).getTokens()) {
sb.append(token.getValue());
}
return sb.toString();
}
}