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.batch.SensorContext;
023    import org.sonar.api.checks.CheckFactory;
024    import org.sonar.api.resources.Project;
025    import org.sonar.api.resources.Resource;
026    import org.sonar.java.api.JavaClass;
027    import org.sonar.java.api.JavaMethod;
028    import org.sonar.squid.Squid;
029    import org.sonar.squid.api.*;
030    
031    /**
032     * Pattern visitor : project -> packages -> files -> classes
033     */
034    public abstract class Bridge {
035    
036      boolean needsBytecode = false;
037      Squid squid;
038      ResourceIndex resourceIndex;
039      SensorContext context;
040      CheckFactory checkFactory;
041    
042      protected Bridge(boolean needsBytecode) {
043        this.needsBytecode = needsBytecode;
044      }
045    
046      public final boolean needsBytecode() {
047        return needsBytecode;
048      }
049    
050      protected final void setSquid(Squid squid) {
051        this.squid = squid;
052      }
053    
054      protected final void setCheckFactory(CheckFactory checkFactory) {
055        this.checkFactory = checkFactory;
056      }
057    
058      protected final void setResourceIndex(ResourceIndex resourceIndex) {
059        this.resourceIndex = resourceIndex;
060      }
061    
062      protected final void setContext(SensorContext context) {
063        this.context = context;
064      }
065    
066      public void onProject(SourceProject squidProject, Project sonarProject) {
067    
068      }
069    
070      public void onPackage(SourcePackage squidPackage, Resource sonarPackage) {
071    
072      }
073    
074      public void onFile(SourceFile squidFile, Resource sonarFile) {
075    
076      }
077    
078      public void onClass(SourceClass squidClass, JavaClass sonarClass) {
079    
080      }
081    
082      public void onMethod(SourceMethod squidMethod, JavaMethod sonarMethod) {
083    
084      }
085    }