IDEA-20936 (BooleanMethodDoesNotStartWithQuestionWord: add option for suppressing in @Interface)

This commit is contained in:
Bas Leijdekkers
2010-04-05 17:05:28 +02:00
parent ca8c4ef373
commit b14939b868
4 changed files with 89 additions and 84 deletions
@@ -1763,4 +1763,5 @@ remove.leading.zero.to.make.decimal.quickfix=Remove leading zero to make decimal
convert.octal.literal.to.decimal.literal.quickfix=Convert octal literal to decimal literal
ignore.single.field.static.imports.option=Ignore single &field static imports
ignore.single.method.static.imports.option=Ignore single &method static imports
ignore.methods.with.boolean.return.type.option=ignore methods with Boolean return type
ignore.methods.with.boolean.return.type.option=Ignore methods with &Boolean return type
ignore.boolean.methods.in.an.interface.option=Ignore boolean methods in an @&interface
@@ -1,49 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<form xmlns="http://www.intellij.com/uidesigner/form/" version="1" bind-to-class="com.siyeh.ig.naming.BooleanMethodNameMustStartWithQuestionInspection.Form">
<grid id="88823" binding="contentPanel" layout-manager="GridLayoutManager" row-count="3" column-count="2" same-size-horizontally="false" same-size-vertically="false" hgap="4" vgap="4">
<margin top="4" left="4" bottom="4" right="4"/>
<constraints>
<xy x="92" y="33" width="295" height="162"/>
</constraints>
<properties/>
<border type="none"/>
<children>
<scrollpane id="14807">
<constraints>
<grid row="0" column="0" row-span="3" col-span="1" vsize-policy="3" hsize-policy="7" anchor="0" fill="3" indent="0" use-parent-layout="false"/>
</constraints>
<properties/>
<border type="none"/>
<children>
<component id="2273d" class="com.siyeh.ig.ui.IGTable" binding="table" custom-create="true">
<constraints/>
<properties/>
</component>
</children>
</scrollpane>
<component id="52926" class="javax.swing.JButton" binding="addButton">
<constraints>
<grid row="0" column="1" row-span="1" col-span="1" vsize-policy="0" hsize-policy="0" anchor="0" fill="1" indent="0" use-parent-layout="false"/>
</constraints>
<properties>
<margin top="3" left="8" bottom="3" right="8"/>
<text resource-bundle="com/siyeh/InspectionGadgetsBundle" key="button.add"/>
</properties>
</component>
<component id="f6174" class="javax.swing.JButton" binding="removeButton">
<constraints>
<grid row="1" column="1" row-span="1" col-span="1" vsize-policy="0" hsize-policy="0" anchor="0" fill="1" indent="0" use-parent-layout="false"/>
</constraints>
<properties>
<margin top="3" left="8" bottom="3" right="8"/>
<text resource-bundle="com/siyeh/InspectionGadgetsBundle" key="button.remove"/>
</properties>
</component>
<vspacer id="6a13b">
<constraints>
<grid row="2" column="1" row-span="1" col-span="1" vsize-policy="6" hsize-policy="1" anchor="0" fill="2" indent="0" use-parent-layout="false"/>
</constraints>
</vspacer>
</children>
</grid>
</form>
@@ -1,5 +1,5 @@
/*
* Copyright 2003-2007 Dave Griffith, Bas Leijdekkers
* Copyright 2003-2010 Dave Griffith, Bas Leijdekkers
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,6 +17,7 @@ package com.siyeh.ig.naming;
import com.intellij.openapi.util.InvalidDataException;
import com.intellij.openapi.util.WriteExternalException;
import com.intellij.psi.PsiClass;
import com.intellij.psi.PsiMethod;
import com.intellij.psi.PsiType;
import com.siyeh.InspectionGadgetsBundle;
@@ -25,21 +26,29 @@ import com.siyeh.ig.BaseInspectionVisitor;
import com.siyeh.ig.InspectionGadgetsFix;
import com.siyeh.ig.fixes.RenameFix;
import com.siyeh.ig.psiutils.LibraryUtil;
import com.siyeh.ig.ui.AddAction;
import com.siyeh.ig.ui.IGTable;
import com.siyeh.ig.ui.ListWrappingTableModel;
import com.siyeh.ig.ui.RemoveAction;
import com.siyeh.ig.ui.*;
import org.jdom.Element;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import javax.swing.*;
import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.util.ArrayList;
import java.util.List;
public class BooleanMethodNameMustStartWithQuestionInspection
extends BaseInspection{
@SuppressWarnings({"PublicField"})
public boolean ignoreBooleanMethods = false;
@SuppressWarnings({"PublicField"})
public boolean ignoreInAnnotationInterface = true;
/** @noinspection PublicField*/
@NonNls public String questionString =
"is,can,has,should,could,will,shall,check,contains,equals,add," +
@@ -51,41 +60,97 @@ public class BooleanMethodNameMustStartWithQuestionInspection
parseString(questionString, questionList);
}
@Override
@NotNull
public String getDisplayName(){
return InspectionGadgetsBundle.message(
"boolean.method.name.must.start.with.question.display.name");
}
@Override
@NotNull
public String buildErrorString(Object... infos){
return InspectionGadgetsBundle.message(
"boolean.method.name.must.start.with.question.problem.descriptor");
}
@Override
public void readSettings(Element element) throws InvalidDataException{
super.readSettings(element);
parseString(questionString, questionList);
}
@Override
public void writeSettings(Element element) throws WriteExternalException{
questionString = formatString(questionList);
super.writeSettings(element);
}
@Override
public JComponent createOptionsPanel(){
final Form form = new Form();
return form.getContentPanel();
final JPanel panel = new JPanel(new GridBagLayout());
final IGTable table =
new IGTable(new ListWrappingTableModel(questionList,
InspectionGadgetsBundle.message(
"boolean.method.name.must.start.with.question.table.column.name")));
final JScrollPane scrollPane = new JScrollPane(table);
final GridBagConstraints constraints = new GridBagConstraints();
constraints.gridx = 0;
constraints.gridy = 0;
constraints.gridheight = 3;
constraints.weightx = 1.0;
constraints.weighty = 1.0;
constraints.fill = GridBagConstraints.BOTH;
panel.add(scrollPane, constraints);
final JButton addButton = new JButton(new AddAction(table));
constraints.gridx = 1;
constraints.gridheight = 1;
constraints.weightx = 0.0;
constraints.weighty = 0.0;
constraints.fill = GridBagConstraints.HORIZONTAL;
panel.add(addButton, constraints);
final JButton removeButton = new JButton(new RemoveAction(table));
constraints.gridy = 1;
panel.add(removeButton, constraints);
final BlankFiller filler = new BlankFiller();
constraints.gridy = 2;
constraints.weighty = 1.0;
panel.add(filler, constraints);
final CheckBox checkBox1 =
new CheckBox(InspectionGadgetsBundle.message(
"ignore.methods.with.boolean.return.type.option"),
this, "ignoreBooleanMethods");
constraints.gridy = 3;
constraints.gridx = 0;
constraints.gridwidth = 2;
constraints.weighty = 0.0;
panel.add(checkBox1, constraints);
final CheckBox checkBox2 =
new CheckBox(InspectionGadgetsBundle.message(
"ignore.boolean.methods.in.an.interface.option"),
this, "ignoreInAnnotationInterface");
constraints.gridy = 4;
panel.add(checkBox2, constraints);
return panel;
}
@Override
protected InspectionGadgetsFix buildFix(Object... infos){
return new RenameFix();
}
@Override
protected boolean buildQuickFixesOnlyForOnTheFlyErrors(){
return true;
}
@Override
public BaseInspectionVisitor buildVisitor(){
return new BooleanMethodNameMustStartWithQuestionVisitor();
}
@@ -95,8 +160,20 @@ public class BooleanMethodNameMustStartWithQuestionInspection
@Override public void visitMethod(@NotNull PsiMethod method){
final PsiType returnType = method.getReturnType();
if(returnType == null || !returnType.equals(PsiType.BOOLEAN)){
if(returnType == null){
return;
} else if(!returnType.equals(PsiType.BOOLEAN)){
if (ignoreBooleanMethods ||
!returnType.equalsToText("java.lang.Boolean")) {
return;
}
}
if (ignoreInAnnotationInterface) {
final PsiClass containingClass = method.getContainingClass();
if (containingClass != null &&
containingClass.isAnnotationType()) {
return;
}
}
final String name = method.getName();
for(String question : questionList){
@@ -110,28 +187,4 @@ public class BooleanMethodNameMustStartWithQuestionInspection
registerMethodError(method);
}
}
private class Form{
JPanel contentPanel;
JButton addButton;
JButton removeButton;
IGTable table;
Form(){
super();
addButton.setAction(new AddAction(table));
removeButton.setAction(new RemoveAction(table));
}
private void createUIComponents(){
table = new IGTable(new ListWrappingTableModel(questionList,
InspectionGadgetsBundle.message(
"boolean.method.name.must.start.with.question.table.column.name")));
}
public JComponent getContentPanel(){
return contentPanel;
}
}
}
@@ -48,7 +48,7 @@ public class NonBooleanMethodNameMayNotStartWithQuestionInspection
"startsWith,endsWith";
@SuppressWarnings({"PublicField"})
public boolean ignoreBooleanMethods = true;
public boolean ignoreBooleanMethods = false;
List<String> questionList = new ArrayList(32);