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.net.URI;
024import java.nio.file.Path;
025
026/**
027 * Layer over {@link java.io.File} for files or directories.
028 *
029 * @since 4.5
030 * @see InputFile
031 * @see InputDir
032 */
033public interface InputPath extends InputComponent {
034
035  /**
036   * @see InputFile#relativePath()
037   * @see InputDir#relativePath()
038   * @deprecated since 6.5 use {@link #uri()}
039   */
040  @Deprecated
041  String relativePath();
042
043  /**
044   * @see InputFile#absolutePath()
045   * @see InputDir#absolutePath()
046   * @deprecated since 6.5 use {@link #uri()}
047   */
048  @Deprecated
049  String absolutePath();
050
051  /**
052   * @see InputFile#file()
053   * @see InputDir#file()
054   * @deprecated since 6.5 use {@link #uri()}
055   */
056  @Deprecated
057  File file();
058
059  /**
060   * @see InputFile#path()
061   * @see InputDir#path()
062   * @since 5.1
063   * @deprecated since 6.5 use {@link #uri()}
064   */
065  @Deprecated
066  Path path();
067
068  /**
069   * Identifier of the component. The only guarantee is that it is unique in the project.
070   * You should not assume it is a file:// URI.
071   * @since 6.5
072   */
073  URI uri();
074
075}