com.builtamont.cassandra.migration.internal.util.scanner.classpath.ResourceAndClassScanner Maven / Gradle / Ivy
/**
* File : ResourceAndClassScanner.java
* License :
* Original - Copyright (c) 2010 - 2016 Boxfuse GmbH
* Derivative - Copyright (c) 2016 - 2017 Citadel Technology Solutions Pte Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.builtamont.cassandra.migration.internal.util.scanner.classpath;
import com.builtamont.cassandra.migration.internal.util.Location;
import com.builtamont.cassandra.migration.internal.util.scanner.Resource;
/**
* Scanner for both resources and classes.
*/
public interface ResourceAndClassScanner {
/**
* Scans the classpath for resources under the specified location, starting with the specified prefix and ending with
* the specified suffix.
*
* @param location The location in the classpath to start searching. Subdirectories are also searched.
* @param prefix The prefix of the resource names to match.
* @param suffix The suffix of the resource names to match.
* @return The resources that were found.
* @throws Exception when the location could not be scanned.
*/
Resource[] scanForResources(Location location, String prefix, String suffix) throws Exception;
/**
* Scans the classpath for concrete classes under the specified package implementing this interface.
* Non-instantiable abstract classes are filtered out.
*
* @param location The location (package) in the classpath to start scanning.
* Subpackages are also scanned.
* @param implementedInterface The interface the matching classes should implement.
* @return The non-abstract classes that were found.
* @throws Exception when the location could not be scanned.
*/
Class[] scanForClasses(Location location, Class implementedInterface) throws Exception;
}