    001// Copyright 2012 The Apache Software Foundation
    002//
    003// Licensed under the Apache License, Version 2.0 (the "License");
    004// you may not use this file except in compliance with the License.
    005// You may obtain a copy of the License at
    006//
    007//     http://www.apache.org/licenses/LICENSE-2.0
    008//
    009// Unless required by applicable law or agreed to in writing, software
    010// distributed under the License is distributed on an "AS IS" BASIS,
    011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    012// See the License for the specific language governing permissions and
    013// limitations under the License.
    014
    015package org.apache.tapestry5.ioc.services;
    016
    017/**
    018 * Used to determine which files will be included in the set of matches paths within a particular
    019 * package.
    020 *
    021 * @see ClasspathScanner
    022 * @since 5.4
    023 */
    024public interface ClasspathMatcher
    025{
    026    /**
    027     * Invoked for each located file, to determine if it belongs. May be passed file names
    028     * that are actually nested folders. Typically, an implementation determined what matches
    029     * based on a file extension of naming pattern.
    030     *
    031     * @param packagePath
    032     *         package path containing the file, ending with '/'
    033     * @param fileName
    034     *         name of file within the package
    035     * @return true to include, false to exclude
    036     */
    037    boolean matches(String packagePath, String fileName);
    038}