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 */ 020package org.sonar.api.batch.fs; 021 022import javax.annotation.CheckForNull; 023 024import java.io.File; 025import java.nio.file.Path; 026 027/** 028 * This layer over {@link java.io.File} adds information for code analyzers. 029 * 030 * @since 4.2 031 */ 032public interface InputFile extends InputPath { 033 034 enum Type { 035 MAIN, TEST 036 } 037 038 /** 039 * Status regarding previous analysis 040 */ 041 enum Status { 042 SAME, CHANGED, ADDED 043 } 044 045 /** 046 * Path relative to module base directory. Path is unique and identifies file 047 * within given <code>{@link FileSystem}</code>. File separator is the forward 048 * slash ('/'), even on Microsoft Windows. 049 * <p/> 050 * Returns <code>src/main/java/com/Foo.java</code> if module base dir is 051 * <code>/path/to/module</code> and if file is 052 * <code>/path/to/module/src/main/java/com/Foo.java</code>. 053 * <p/> 054 * Relative path is not null and is normalized ('foo/../foo' is replaced by 'foo'). 055 */ 056 @Override 057 String relativePath(); 058 059 /** 060 * Normalized absolute path. File separator is forward slash ('/'), even on Microsoft Windows. 061 * <p/> 062 * This is not canonical path. Symbolic links are not resolved. For example if /project/src links 063 * to /tmp/src and basedir is /project, then this method returns /project/src/index.php. Use 064 * {@code file().getCanonicalPath()} to resolve symbolic link. 065 */ 066 @Override 067 String absolutePath(); 068 069 /** 070 * The underlying absolute {@link java.io.File} 071 */ 072 @Override 073 File file(); 074 075 /** 076 * The underlying absolute {@link Path} 077 */ 078 @Override 079 Path path(); 080 081 /** 082 * Language, for example "java" or "php". Can be null if indexation of all files is enabled and no language claims to support the file. 083 */ 084 @CheckForNull 085 String language(); 086 087 /** 088 * Does it contain main or test code ? 089 */ 090 Type type(); 091 092 /** 093 * Status regarding previous analysis 094 */ 095 Status status(); 096 097 /** 098 * Number of physical lines. This method supports all end-of-line characters. Returns 099 * zero if the file is empty. 100 */ 101 int lines(); 102 103}