001    /*
002     * Licensed under the Apache License, Version 2.0 (the "License");
003     * you may not use this file except in compliance with the License.
004     * You may obtain a copy of the License at
005     *
006     *      http://www.apache.org/licenses/LICENSE-2.0
007     *
008     * Unless required by applicable law or agreed to in writing, software
009     * distributed under the License is distributed on an "AS IS" BASIS,
010     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
011     * See the License for the specific language governing permissions and
012     * limitations under the License.
013     */
014    package org.apache.commons.classscan.spi;
015    
016    import java.util.ServiceLoader;
017    
018    import org.apache.commons.classscan.MetaRegistry;
019    import org.apache.commons.classscan.spi.model.SpiClassDigester;
020    
021    /**
022     * Provider to create a SpiClassDigester. Provider instances should be
023     * registered using the {@link ServiceLoader} facility. The provider class
024     * should have a public default constructor. The first instance of a provider
025     * class which is successfully instantiated will be used. The order in the
026     * classpath will determine which SpiClassDigester will be used.
027     */
028    public interface ClassDigesterFactory {
029            /**
030             * Create a SpiClassDigester.  The factory may throw an exception or error if unsuccessful in loading dependent jars.
031             * 
032             * @param metaRegistry The registry
033             * @return A SpiClassDigester
034             */
035            SpiClassDigester createDigester(MetaRegistry metaRegistry);
036    }