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    import java.io.Serializable;
024    
025    /**
026     * Layer over {@link java.io.File} for files or directories.
027     *
028     * @since 4.5
029     * @see InputFile
030     * @see InputDir
031     */
032    public interface InputPath extends Serializable {
033    
034      /**
035       * @see InputFile#relativePath()
036       * @see InputDir#relativePath()
037       */
038      String relativePath();
039    
040      /**
041       * @see InputFile#absolutePath()
042       * @see InputDir#absolutePath()
043       */
044      String absolutePath();
045    
046      /**
047       * @see InputFile#file()
048       * @see InputDir#file()
049       */
050      File file();
051    
052    }