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     */
020    
021    package org.sonar.java.squid.check;
022    
023    import org.sonar.check.Priority;
024    import org.sonar.check.Rule;
025    import org.sonar.check.RuleProperty;
026    import org.sonar.squid.api.CheckMessage;
027    import org.sonar.squid.api.SourceClass;
028    import org.sonar.squid.api.SourceFile;
029    import org.sonar.squid.measures.Metric;
030    
031    @Rule(key = "MaximumInheritanceDepth", priority = Priority.MAJOR)
032    public class DITCheck extends SquidCheck {
033    
034      public static final int DEFAULT_MAX = 5;
035    
036      @RuleProperty(defaultValue = "" + DEFAULT_MAX)
037      private Integer max = DEFAULT_MAX;
038    
039      @Override
040      public void visitClass(SourceClass sourceClass) {
041        int dit = sourceClass.getInt(Metric.DIT);
042        if (dit > max) {
043          CheckMessage message = new CheckMessage(this, "This class has " + dit + " parents which is greater than " + max + " authorized.");
044          message.setLine(sourceClass.getStartAtLine());
045          message.setCost(dit - max);
046          sourceClass.getParent(SourceFile.class).log(message);
047        }
048      }
049    
050      public void setMax(int max) {
051        this.max = max;
052      }
053    }