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
017import java.io.IOException;
018import java.util.Set;
019
020/**
021 * Used to scan a portion of the classpath for files that match a particular pattern, defined by a {@link ClasspathMatcher}.
022 *
023 * @since 5.4
024 */
025public interface ClasspathScanner
026{
027    /**
028     * Perform a scan of the indicated package path and any nested packages.
029     *
030     * @param packagePath
031     *         defines the root of the search as a path, e.g., "org/apache/tapestry5/" not "org.apache.tapestry5"
032     * @param matcher
033     *         passed each potential match to determine which are included in the final result
034     * @return matching paths based on the search and the matcher
035     * @throws IOException if some error occurrs.
036     */
037    Set<String> scan(String packagePath, ClasspathMatcher matcher) throws IOException;
038}