001/*
002 * SonarQube, open source software quality management tool.
003 * Copyright (C) 2008-2013 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.BatchExtension;
023
024import java.io.File;
025
026/**
027 * Extension point to exclude some files from project scan. Some use-cases :
028 * <ul>
029 * <li>exclude the files that are older than x days</li>
030 * <li>exclude the files which names start with Generated</li>
031 * </ul>
032 *
033 * @since 3.5
034 */
035public interface FileSystemFilter extends BatchExtension {
036
037  /**
038   * Plugins must not implement this interface. It is provided at runtime.
039   */
040  public interface Context {
041    ModuleFileSystem fileSystem();
042
043    FileType type();
044
045    File relativeDir();
046
047    /**
048     * File path relative to source directory. Never return null.
049     */
050    String relativePath();
051
052    /**
053     * Absolute file path. Directory separator is slash, even on windows. Never return null.
054     */
055    String canonicalPath();
056  }
057
058  boolean accept(File file, Context context);
059}