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.scan.filesystem;
021
022import org.sonar.api.batch.BatchSide;
023import org.sonar.api.ExtensionPoint;
024import org.sonar.api.batch.fs.InputFileFilter;
025
026import java.io.File;
027
028/**
029 * Extension point to exclude some files from project scan. Some use-cases :
030 * <ul>
031 * <li>exclude the files that are older than x days</li>
032 * <li>exclude the files which names start with Generated</li>
033 * </ul>
034 *
035 * @since 3.5
036 * @deprecated since 4.2 use {@link InputFileFilter}
037 */
038@Deprecated
039@BatchSide
040@ExtensionPoint
041public interface FileSystemFilter {
042
043  /**
044   * Plugins must not implement this interface. It is provided at runtime.
045   */
046  interface Context {
047    ModuleFileSystem fileSystem();
048
049    FileType type();
050
051    /**
052     * Changed in 5.1 as we don't keep track of relative path to source dir
053     * File path relative to module base directory. Never return null.
054     */
055    String relativePath();
056
057    /**
058     * Absolute file path. Directory separator is slash, even on windows. Never return null.
059     */
060    String canonicalPath();
061  }
062
063  boolean accept(File file, Context context);
064}