001// Copyright 2007, 2008, 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.util.Collection;
018
019/**
020 * Scans the classpath for top-level classes within particular packages.
021 *
022 * @see org.apache.tapestry5.ioc.services.ClasspathURLConverter
023 * @see ClasspathScanner
024 */
025public interface ClassNameLocator
026{
027    /**
028     * Searches for all classes under the given package name. This consists of all top-level classes in the indicated
029     * package (or any sub-package), but excludes inner classes. No other filtering (beyond inner classes) occurs, so
030     * there's no guarantee that the class names returned are public (for example).
031     *
032     * @param packageName the name of the package to be inspected.
033     * @return fully qualified class names
034     */
035    Collection<String> locateClassNames(String packageName);
036}