org.jboss.errai.reflections.scanners.AbstractScanner Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of reflections
Reflections - a Java runtime metadata analysis
The newest version!
/*
 * Copyright (C) 2015 Red Hat, Inc. and/or its affiliates.
 *
 * 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 org.jboss.errai.reflections.scanners;

import java.io.IOException;
import java.io.InputStream;
import java.util.Collections;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;

import javassist.bytecode.ClassFile;

import org.jboss.errai.reflections.Configuration;
import org.jboss.errai.reflections.ReflectionsException;
import org.jboss.errai.reflections.adapters.MetadataAdapter;
import org.jboss.errai.reflections.scanners.reg.ScannerRegistry;
import org.jboss.errai.reflections.util.Utils;
import org.jboss.errai.reflections.vfs.Vfs;

import com.google.common.base.Predicate;
import com.google.common.base.Predicates;
import com.google.common.collect.Multimap;

public abstract class AbstractScanner implements Scanner {
    private static final Set classesNotInJar = Collections.newSetFromMap(new ConcurrentHashMap());
  
    private Configuration configuration;
	private Multimap store;
	private Predicate resultFilter = Predicates.alwaysTrue(); //accept all by default
	

	
	public AbstractScanner() {
	  /*
	   * Used to register all scanner sub-types names.
	   */
	  ScannerRegistry.getRegistry().setName(this.getClass(), getName());
	}

  /**
   * Get the name of this scanner. This is normally the class name of the
   * scanner. Subclasses designed to override the behaviour of built-in scanners
   * should return the name of the scanner they wish to override.
   */
    public String getName() {
        return getClass().getName();
    }

    public boolean acceptsInput(final String file) {
        return file.endsWith(".class"); //is a class file
    }

    public void scan(final Vfs.File file) {
        InputStream inputStream = null;
        try {
            inputStream = file.openInputStream();
            final Object cls = configuration.getMetadataAdapter().createClassObject(inputStream);
            String fp = file.getFullPath();
            if (fp != null && !fp.contains(".jar")) {
                String className = ((ClassFile) cls).getName();
                if (!classesNotInJar.contains(className)) {
                  classesNotInJar.add(className);
                }
            }
            scan(cls);
        } catch (IOException e) {
            throw new ReflectionsException("could not create class file from " + file.getName(), e);
        } finally {
            Utils.close(inputStream);
        }
    }

    public abstract void scan(Object cls);

    //
    public Configuration getConfiguration() {
        return configuration;
    }

    public void setConfiguration(final Configuration configuration) {
        this.configuration = configuration;
    }

    public Multimap getStore() {
        return store;
    }

    public void setStore(final Multimap store) {
        this.store = store;
    }

    public Predicate getResultFilter() {
        return resultFilter;
    }

    public void setResultFilter(final Predicate resultFilter) {
        this.resultFilter = resultFilter;
    }

    public Scanner filterResultsBy(final Predicate filter) {
        this.setResultFilter(filter); return this;
    }

    protected boolean acceptResult(final String fqn) {
		return fqn != null && getResultFilter().apply(fqn);
	}

	protected MetadataAdapter getMetadataAdapter() {
		return configuration.getMetadataAdapter();
	}
	
	public static boolean isInJar(String className) {
	  return !(classesNotInJar.contains(className));
	}
}