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.batch.fs; 021 022 import java.io.File; 023 024 /** 025 * Layer over {@link java.io.File} for directories. 026 * 027 * @since 4.5 028 */ 029 public interface InputDir extends InputPath { 030 031 /** 032 * Path relative to module base directory. Path is unique and identifies directory 033 * within given <code>{@link FileSystem}</code>. File separator is the forward 034 * slash ('/'), even on Microsoft Windows. 035 * <p/> 036 * Returns <code>src/main/java/com</code> if module base dir is 037 * <code>/path/to/module</code> and if directory is 038 * <code>/path/to/module/src/main/java/com</code>. 039 * <p/> 040 * Relative path is not null and is normalized ('foo/../foo' is replaced by 'foo'). 041 */ 042 @Override 043 String relativePath(); 044 045 /** 046 * Normalized absolute path. File separator is forward slash ('/'), even on Microsoft Windows. 047 * <p/> 048 * This is not canonical path. Symbolic links are not resolved. For example if /project/src links 049 * to /tmp/src and basedir is /project, then this method returns /project/src. Use 050 * {@code file().getCanonicalPath()} to resolve symbolic link. 051 */ 052 @Override 053 String absolutePath(); 054 055 /** 056 * The underlying absolute {@link java.io.File} 057 */ 058 @Override 059 File file(); 060 061 }