001 /* 002 * Sonar, open source software quality management tool. 003 * Copyright (C) 2008-2011 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.api.resources; 021 022 import java.io.File; 023 024 /** 025 * @since 2.6 026 */ 027 public interface InputFile { 028 029 /** 030 * The source base directory, different than the project basedir. For example in maven projects, the basedir of a source file stored in 031 * src/main/java/org/foo/ is the directory src/main/java. 032 */ 033 File getFileBaseDir(); 034 035 File getFile(); 036 037 /** 038 * Path relative to basedir. Directory separator is slash '/', whatever the platform. 039 * 040 * Example on windows: if file basedir is c:\project\src\ and file is c:\project\src\org\foo\Bar.java, then relative path 041 * is org/foo/Bar.java 042 * 043 * Example on unix: if file basedir is /project/src and file is /project/src/org/foo/Bar.java, then relative path 044 * is org/foo/Bar.java as well. 045 */ 046 String getRelativePath(); 047 }