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