001/*
002 * Sonar, open source software quality management tool.
003 * Copyright (C) 2008-2012 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * Sonar is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * Sonar is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public
017 * License along with Sonar; if not, write to the Free Software
018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019 */
020package org.sonar.java.bytecode.check;
021
022import org.sonar.check.Priority;
023import org.sonar.check.Rule;
024import org.sonar.java.bytecode.asm.AsmClass;
025import org.sonar.java.bytecode.asm.AsmMethod;
026import org.sonar.java.bytecode.visitor.BytecodeVisitor;
027import org.sonar.squid.api.CheckMessage;
028import org.sonar.squid.api.SourceFile;
029import org.sonar.squid.api.SourceMethod;
030
031@Rule(key = "UnusedProtectedMethod", priority = Priority.MAJOR)
032public class UnusedProtectedMethodCheck extends BytecodeVisitor {
033
034  private AsmClass asmClass;
035
036  @Override
037  public void visitClass(AsmClass asmClass) {
038    this.asmClass = asmClass;
039  }
040
041  @Override
042  public void visitMethod(AsmMethod asmMethod) {
043    if ( !asmMethod.isUsed() && asmMethod.isProtected() && !asmClass.isAbstract() && !SerializableContract.methodMatch(asmMethod)
044        && !asmMethod.isInherited()) {
045      CheckMessage message = new CheckMessage(this, "Protected method '" + asmMethod.getName() + "(...)' is never used.");
046      SourceMethod sourceMethod = getSourceMethod(asmMethod);
047      if (sourceMethod != null) {
048        message.setLine(sourceMethod.getStartAtLine());
049      }
050      SourceFile file = getSourceFile(asmClass);
051      file.log(message);
052    }
053  }
054}