001/*
002 * SonarQube
003 * Copyright (C) 2009-2016 SonarSource SA
004 * mailto:contact AT sonarsource DOT com
005 *
006 * This program 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 * This program 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 License
017 * along with this program; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019 */
020package org.sonar.api.component;
021
022import javax.annotation.CheckForNull;
023import org.sonar.api.batch.fs.InputFile;
024import org.sonar.api.batch.fs.InputPath;
025import org.sonar.api.issue.Issuable;
026import org.sonar.api.resources.Resource;
027import org.sonar.api.source.Highlightable;
028import org.sonar.api.source.Symbolizable;
029import org.sonar.api.test.TestPlan;
030import org.sonar.api.test.Testable;
031
032/**
033 * Use this component to create perspective from resources or {@link InputPath}
034 * Only on batch-side.
035 * 
036 * <pre>
037 * public class MySensor implements Sensor {
038 *   private final ResourcePerspectives perspectives;
039 *
040 *   public MySensor(ResourcePerspectives perspectives) {
041 *     this.perspectives = perspectives;
042 *   }
043 *   
044 *   public void analyse(Project module, SensorContext context) {
045 *      // Get some Resource or InputFile/InputPath
046 *      Highlightable highlightable = perspectives.as(Highlightable.class, inputPath);
047 *      if (highlightable != null) {
048 *        ...
049 *      }
050 *   }
051 * }
052 * </pre>
053 * @see Issuable
054 * @see Highlightable
055 * @see Symbolizable
056 * @see Testable
057 * @see TestPlan
058 * @since 3.5
059 */
060public interface ResourcePerspectives {
061
062  @CheckForNull
063  <P extends Perspective> P as(Class<P> perspectiveClass, Resource resource);
064
065  /**
066   * Allow to create perspective from {@link InputPath}. In particular from {@link InputFile}.
067   * @since 4.5.2
068   */
069  @CheckForNull
070  <P extends Perspective> P as(Class<P> perspectiveClass, InputPath inputPath);
071}