diff options
Diffstat (limited to 'plugins/InspectionGadgets/InspectionGadgetsAnalysis/src/com/siyeh/ig/naming/StaticVariableNamingConventionInspectionBase.java')
-rw-r--r-- | plugins/InspectionGadgets/InspectionGadgetsAnalysis/src/com/siyeh/ig/naming/StaticVariableNamingConventionInspectionBase.java | 114 |
1 files changed, 114 insertions, 0 deletions
diff --git a/plugins/InspectionGadgets/InspectionGadgetsAnalysis/src/com/siyeh/ig/naming/StaticVariableNamingConventionInspectionBase.java b/plugins/InspectionGadgets/InspectionGadgetsAnalysis/src/com/siyeh/ig/naming/StaticVariableNamingConventionInspectionBase.java new file mode 100644 index 000000000000..55d3c6aa4279 --- /dev/null +++ b/plugins/InspectionGadgets/InspectionGadgetsAnalysis/src/com/siyeh/ig/naming/StaticVariableNamingConventionInspectionBase.java @@ -0,0 +1,114 @@ +/* + * Copyright 2000-2013 JetBrains s.r.o. + * + * 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 com.siyeh.ig.naming; + +import com.intellij.psi.PsiField; +import com.intellij.psi.PsiModifier; +import com.intellij.psi.PsiType; +import com.intellij.util.ui.CheckBox; +import com.siyeh.InspectionGadgetsBundle; +import com.siyeh.ig.BaseInspectionVisitor; +import com.siyeh.ig.psiutils.ClassUtils; +import org.jetbrains.annotations.NotNull; + +import javax.swing.*; + +public class StaticVariableNamingConventionInspectionBase extends ConventionInspection { + private static final int DEFAULT_MIN_LENGTH = 5; + private static final int DEFAULT_MAX_LENGTH = 32; + @SuppressWarnings({"PublicField"}) + public boolean checkMutableFinals = false; + + @Override + @NotNull + public String getDisplayName() { + return InspectionGadgetsBundle.message("static.variable.naming.convention.display.name"); + } + + @Override + protected boolean buildQuickFixesOnlyForOnTheFlyErrors() { + return true; + } + + @Override + @NotNull + public String buildErrorString(Object... infos) { + final String fieldName = (String)infos[0]; + if (fieldName.length() < getMinLength()) { + return InspectionGadgetsBundle.message("static.variable.naming.convention.problem.descriptor.short"); + } + else if (fieldName.length() > getMaxLength()) { + return InspectionGadgetsBundle.message("static.variable.naming.convention.problem.descriptor.long"); + } + return InspectionGadgetsBundle.message("static.variable.naming.convention.problem.descriptor.regex.mismatch", getRegex()); + } + + @Override + protected String getDefaultRegex() { + return "s_[a-z][A-Za-z\\d]*"; + } + + @Override + protected int getDefaultMinLength() { + return DEFAULT_MIN_LENGTH; + } + + @Override + protected int getDefaultMaxLength() { + return DEFAULT_MAX_LENGTH; + } + + @Override + public JComponent[] createExtraOptions() { + return new JComponent[]{ + new CheckBox(InspectionGadgetsBundle.message("static.variable.naming.convention.mutable.option"), this, "checkMutableFinals") + }; + } + + @Override + public BaseInspectionVisitor buildVisitor() { + return new NamingConventionsVisitor(); + } + + private class NamingConventionsVisitor extends BaseInspectionVisitor { + + @Override + public void visitField(@NotNull PsiField field) { + if (!field.hasModifierProperty(PsiModifier.STATIC)) { + return; + } + if (field.hasModifierProperty(PsiModifier.FINAL)) { + if (!checkMutableFinals) { + return; + } + else { + final PsiType type = field.getType(); + if (ClassUtils.isImmutable(type)) { + return; + } + } + } + final String name = field.getName(); + if (name == null) { + return; + } + if (isValid(name)) { + return; + } + registerFieldError(field, name); + } + } +} |