org.sonar.api.component.ResourcePerspectives Maven / Gradle / Ivy

/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * SonarQube is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.api.component;

import org.sonar.api.batch.fs.InputFile;
import org.sonar.api.batch.fs.InputPath;
import org.sonar.api.issue.Issuable;
import org.sonar.api.resources.Resource;
import org.sonar.api.source.Highlightable;
import org.sonar.api.source.Symbolizable;
import org.sonar.api.test.TestPlan;
import org.sonar.api.test.Testable;

import javax.annotation.CheckForNull;

/**
 * Use this component to create perspective from resources or {@link InputPath}
 * Only on batch-side.
 * 
 *  * public class MySensor implements Sensor {
 *   private final ResourcePerspectives perspectives;
 *
 *   public MySensor(ResourcePerspectives perspectives) {
 *     this.perspectives = perspectives;
 *   }
 *   
 *   public void analyse(Project module, SensorContext context) {
 *      // Get some Resource or InputFile/InputPath
 *      Highlightable highlightable = perspectives.as(Highlightable.class, inputPath);
 *      if (highlightable != null) {
 *        ...
 *      }
 *   }
 * }
 * 
 * @see Issuable
 * @see Highlightable
 * @see Symbolizable
 * @see Testable
 * @see TestPlan
 * @since 3.5
 */
public interface ResourcePerspectives extends Perspectives {

  @CheckForNull
   P as(Class
 perspectiveClass, Resource resource);

  /**
   * Allow to create perspective from {@link InputPath}. In particular from {@link InputFile}.
   * @since 4.5.2
   */
  @CheckForNull
  
 P as(Class perspectiveClass, InputPath inputPath);
}