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