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     */
020    package org.sonar.api.batch;
021    
022    import org.sonar.api.BatchExtension;
023    import org.sonar.api.resources.Resource;
024    
025    /**
026     * Filter resources to save. For example, ignore a resource if its path matches an exclusion pattern (defined on the project).
027     * Filters are applied to files, directories and packages only.
028     *
029     * If the method start(), without parameters, exists, then it is executed at startup.
030     *
031     * @since 1.12
032     */
033    public interface ResourceFilter extends BatchExtension {
034    
035      /**
036       * Return true if the resource must be ignored, else it's saved into database.
037       */
038      boolean isIgnored(Resource resource);
039      
040    }