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 java.io.File;
023import java.io.Serializable;
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 Serializable {
034
035  /**
036   * @see InputFile#relativePath()
037   * @see InputDir#relativePath()
038   */
039  String relativePath();
040
041  /**
042   * @see InputFile#absolutePath()
043   * @see InputDir#absolutePath()
044   */
045  String absolutePath();
046
047  /**
048   * @see InputFile#file()
049   * @see InputDir#file()
050   */
051  File file();
052
053  /**
054   * @see InputFile#path()
055   * @see InputDir#path()
056   * @since 5.1
057   */
058  Path path();
059
060}