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