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    package org.sonar.plugins.squid.bridges;
021    
022    import org.sonar.api.measures.CoreMetrics;
023    import org.sonar.api.resources.Resource;
024    import org.sonar.java.api.JavaClass;
025    import org.sonar.java.api.JavaMethod;
026    import org.sonar.squid.api.SourceClass;
027    import org.sonar.squid.api.SourceCode;
028    import org.sonar.squid.api.SourceFile;
029    import org.sonar.squid.api.SourceMethod;
030    import org.sonar.squid.measures.Metric;
031    
032    public final class PublicUndocumentedApiBridge extends Bridge {
033    
034      protected PublicUndocumentedApiBridge() {
035        super(false);
036      }
037    
038      @Override
039      public void onFile(SourceFile squidFile, Resource sonarFile) {
040        copyValue(squidFile, sonarFile);
041      }
042    
043      @Override
044      public void onClass(SourceClass squidClass, JavaClass sonarClass) {
045        copyValue(squidClass, sonarClass);
046      }
047    
048      @Override
049      public void onMethod(SourceMethod squidMethod, JavaMethod sonarMethod) {
050        copyValue(squidMethod, sonarMethod);
051      }
052    
053      private void copyValue(SourceCode squidResource, Resource sonarResource) {
054        double undocumentedApi = squidResource.getDouble(Metric.PUBLIC_API) - squidResource.getInt(Metric.PUBLIC_DOC_API);
055        context.saveMeasure(sonarResource, CoreMetrics.PUBLIC_UNDOCUMENTED_API, undocumentedApi);
056      }
057    }