org.eclipse.sisu.inject/src/org/eclipse/sisu/space/IndexedClassFinder.java

/*******************************************************************************
 * Copyright (c) 2010, 2015 Sonatype, Inc.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Stuart McCulloch (Sonatype, Inc.) - initial API and implementation
 *******************************************************************************/
package org.eclipse.sisu.space;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.URL;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.NoSuchElementException;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.eclipse.sisu.inject.Logs;

/**
 * {@link ClassFinder} that finds {@link Class} resources listed in the named index.
 */
public final class IndexedClassFinder
    implements ClassFinder
{
    // ----------------------------------------------------------------------
    // Constants
    // ----------------------------------------------------------------------

    private static final Pattern LINE_PATTERN = Pattern.compile( "\\s*([^#\\s]+).*" );

    // ----------------------------------------------------------------------
    // Implementation fields
    // ----------------------------------------------------------------------

    private final String localPath;

    private final String indexName;

    // ----------------------------------------------------------------------
    // Constructors
    // ----------------------------------------------------------------------

    public IndexedClassFinder( final String name, final boolean global )
    {
        if ( global )
        {
            localPath = null;
            indexName = name;
        }
        else
        {
            final int i = name.lastIndexOf( '/' ) + 1;
            localPath = name.substring( 0, i );
            indexName = name.substring( i );
        }
    }

    // ----------------------------------------------------------------------
    // Public methods
    // ----------------------------------------------------------------------

    public Iterable<String> indexedNames( final ClassSpace space )
    {
        final Enumeration<URL> indices;

        if ( null == localPath )
        {
            indices = space.getResources( indexName );
        }
        else
        {
            indices = space.findEntries( localPath, indexName, false );
        }

        final Set<String> names = new LinkedHashSet<String>();
        while ( indices.hasMoreElements() )
        {
            final URL url = indices.nextElement();
            try
            {
                final BufferedReader reader =
                    new BufferedReader( new InputStreamReader( Streams.open( url ), "UTF-8" ) );
                try
                {
                    // each index contains a list of class names, one per line with optional comment
                    for ( String line = reader.readLine(); line != null; line = reader.readLine() )
                    {
                        final Matcher m = LINE_PATTERN.matcher( line );
                        if ( m.matches() )
                        {
                            names.add( m.group( 1 ) );
                        }
                    }
                }
                finally
                {
                    reader.close();
                }
            }
            catch ( final IOException e )
            {
                Logs.warn( "Problem reading: {}", url, e );
            }
        }
        return names;
    }

    public Enumeration<URL> findClasses( final ClassSpace space )
    {
        final Iterator<String> itr = indexedNames( space ).iterator();

        return new Enumeration<URL>()
        {
            private URL nextURL;

            public boolean hasMoreElements()
            {
                while ( null == nextURL && itr.hasNext() )
                {
                    nextURL = space.getResource( itr.next().replace( '.', '/' ) + ".class" );
                }
                return null != nextURL;
            }

            public URL nextElement()
            {
                if ( hasMoreElements() )
                {
                    final URL tempURL = nextURL;
                    nextURL = null;
                    return tempURL;
                }
                throw new NoSuchElementException();
            }
        };
    }
}