javarequirementstracer.UntraceableScanner Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2008-2009 the original author or authors.
 *
 * 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 javarequirementstracer;

import java.lang.reflect.Modifier;
import java.util.HashSet;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;

import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.core.type.filter.AnnotationTypeFilter;
import org.springframework.core.type.filter.AssignableTypeFilter;
import org.springframework.util.ClassUtils;

/**
 * Implementation of {@link JavaRequirementsTracer#scanUntraceable()}.
 * 
 * @author Ronald Koster
 */
final class UntraceableScanner extends AbstractScanner {
	
	UntraceableScanner(TraceProperties properties) {
		super(properties);
	}
	
	SortedSet run() {
		final SortedSet typeNames = new TreeSet();
		for (Class cl : getTypes(getProperties().getIncludePackageNames())) {
			if (exclude(cl)) {
				continue;
			}
			int modifiers = cl.getModifiers();
			if (Modifier.isPublic(modifiers) || Modifier.isProtected(modifiers)) {
				String typeName = getProperties().getShortTypeName(cl.getName());
				typeNames.add(typeName);
			}
		}
		return typeNames;
	}
	
	private Set> getTypes(final Set packageNames) {
		final Set> list = new HashSet>();
		
		// Scan for all classess in the classpath with the Requirements annotation.
		final ClassPathScanner scanner = new ClassPathScanner(false);
		setResourceLoader(scanner);
		scanner.addIncludeFilter(new AssignableTypeFilter(Object.class));
		scanner.addExcludeFilter(new AnnotationTypeFilter(Requirements.class));
		scanner.addExcludeFilter(new AnnotationTypeFilter(SuppressTraceabilityWarnings.class));

		// Search the given packages.
		for (String basePackageName : packageNames) {
			final Set components = scanner.findCandidateComponents(basePackageName);
			for (BeanDefinition component : components) {
				String className = component.getBeanClassName();
				Class cl = ClassUtils.resolveClassName(className, getClassLoader());
				list.add(cl);
			}
		}
		return list;
	}
}