/*
* ModeShape (http://www.modeshape.org)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.modeshape.checkstyle;
import java.util.HashSet;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* A simple CheckStyle checker to verify specific import statements are not being used.
*
* @author Sanne Grinovero
*/
public class IllegalImport extends Check {
private final HashSet<String> notAllowedImports = new HashSet<String>();
private String message = "";
/**
* Set the list of illegal import statements.
*
* @param importStatements array of illegal packages
*/
public void setIllegalClassnames( String[] importStatements ) {
for (String impo : importStatements) {
notAllowedImports.add(impo);
}
}
public void setMessage( String message ) {
if (message != null) {
this.message = message;
}
}
@Override
public int[] getDefaultTokens() {
return new int[] {TokenTypes.IMPORT, TokenTypes.STATIC_IMPORT};
}
@Override
public void visitToken( DetailAST aAST ) {
final FullIdent imp;
if (aAST.getType() == TokenTypes.IMPORT) {
imp = FullIdent.createFullIdentBelow(aAST);
} else {
// handle case of static imports of method names
imp = FullIdent.createFullIdent(aAST.getFirstChild().getNextSibling());
}
final String text = imp.getText();
if (isIllegalImport(text)) {
final String message = buildError(text);
log(aAST.getLineNo(), aAST.getColumnNo(), message, text);
}
}
private String buildError( String importStatement ) {
return "Import statement violating a checkstyle rule: " + importStatement + ". " + message;
}
private boolean isIllegalImport( String importString ) {
return notAllowedImports.contains(importString);
}
}